Billing Center API Data

This section details the data structures the API exchanges. The data schema tables below list membership requirements as follows:

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

Schemas

Statistic

Contains metadata that characterizes usage data.

Sample GET:

[
    {
        "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.

Sample GET:

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

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 $ref The Statistic measured for the usage.
value Number Provides the raw measure of numeric usage data.

Query

A query object to filter usage data.

Sample GET:

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

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: 4/13/2017