Billing Center API Data

This section details the data structures the API exchanges.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether its value is empty or null.
Member is optional, and may be omitted in some cases.

Statistic

Contains metadata that characterizes usage data.

Download schema: statistic-schema.json

Sample GET response:

[
    {
        "name": "Total MB",
        "unit": "MB"
    }
]

Statistic Members

Member Type Required Description
name String Identifies the type of data included in a Usage report.
unit String Specifies the unit system for the Usage report’s value.

Usage

Specifies daily aggregated usage data.

Download schema: measure-schema.json

Sample GET response:

[
    {
        "date": "2017-03-01",
        "value": 6.696,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 6.822,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 6.778,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 6.857,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 6.876,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 6.876,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 5.024,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 734.174,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 396806,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 819520,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 1223097,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 1646177,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 2072466,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 2490212,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 3045007,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 86093.599,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 141229.362,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 171406.915,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 210410.594,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 249726.839,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 287518.192,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 342557.541,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "contractId": "1-3CV382",
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "95/5 Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 0,
        "statistic": {
            "unit": "Mbps",
            "name": "Peak Mbps"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 0,
        "statistic": {
            "unit": "Hits",
            "name": "Total Hits"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-01",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-02",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-03",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-04",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-05",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-06",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    },
    {
        "date": "2017-03-31",
        "value": 0,
        "statistic": {
            "unit": "MB",
            "name": "Total MB"
        },
        "productId": "B-3-4D5VW3",
        "reportingGroupId": 3466,
        "final": false
    }
]

Usage Members

Member Type Required Description
contractId String Identifies the contract enabling the usage.
date String ISO 8601 date for when the usage occurred.
final Boolean Whether all usage data has been received from edge servers, and is no longer subject to updates. The latency to calculate final data may vary, but usually takes several days.
productId String Identifies the product enabling the usage.
reportingGroupId Number Identifies the reporting group for the usage.
statistic Usage.statistic Contains metadata that characterizes usage data.
value Number Provides the raw measure of numeric usage data.

Usage.statistic  

Contains metadata that characterizes usage data.

Member Type Required Description
name String Identifies the type of data included in a Usage report.
unit String Specifies the unit system for the Usage report’s value.

Query

A query object to filter usage data.

Download schema: measures-find-schema.json

Sample GET response:

{
    "month": 3,
    "year": 2017,
    "contractIds": [
        "1-3CV382"
    ],
    "reportingGroupIds": [
        3466
    ],
    "productIds": [
        "B-3-4D5VW3"
    ],
    "statisticTypes": [
        "Total MB"
    ]
}

Query Members

Member Type Required Description
contractIds Array Filter data to the specified set of contract identifiers, at least one item if specified. Otherwise if omitted, you need to specify a set of reportingGroupIds.
month Integer The month (1–12) for which to aggregate data.
productIds Array Filter data to the specified set of product identifiers. An empty array produces unfiltered results, the same as omitting the member.
reportingGroupIds Array Filter data to the specified set of reporting group identifiers, at least one item if specified. Otherwise if omitted, you need to specify a set of contractIds.
statisticTypes Array Statistics for which you want to retrieve data, each corresponding to a Statistic’s name value. An empty array produces unfiltered results, the same as omitting the member.
year Integer The year for which to aggregate data.

Last modified: 1/25/2018