Get your account’s billing usage data in JSON format.

Learn more:

• Billing Center

• Invoicing API

• Download this API’s RAML and JSON schema descriptors.

Overview

The Billing Center API allows you to access your website’s monthly usage over the Akamai network.

This guide details the most recent version 2 of the Billing Center API, which provides data in JSON format. For the deprecated version 1, which provides CSV data, see Billing Center API, v1.

Who should use this API

Use this API if you administer an Akamai-accelerated website, and want to develop your own tools to visualize and track how your site is being used. A range of data is available, including number of hits, megabytes served, and transmission speed. You can also use the API to compare usage data with your billing invoice.

Getting started

To configure this API for the first time:

• Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

• To enable this API, choose the API service named Billing Center, and set the access level to READ-WRITE.

• If you want to use this API to compare your usage data with your final bill, you need a separate token to provision the Invoicing API.

• Some API operations require contractId and productId identifiers. They are both available programmatically from the Contracts API. The Billing Center API allows access to any contract for which you have permission to view billing data.

• Some API operations require reporting group identifiers. If you don’t already have them, they are available in the Luna Control Center’s Contract Usage CP Code Groups view. Use the Group ID to specify a valid reportingGroupId.

• If you need help with the API, provide feedback with the Akamai developer community, or else contact your Akamai representative for help understanding your data.

Migrating from Billing API v1

The anticipated EOL of Billing Center API v1 is June 2019. Please review these key changes and update your implementations accordingly.

• No CSV data. CSV output is no longer supported. Data is returned in JSON format.

• No CP Code data. CP code data is now available in CP Codes and Reporting Groups API rather than Billing Center API.

  • To retrieve lists of CP codes for reporting groups or contracts, List details of a reporting group.

• No Reporting Groups or Contract data. Lists of billable sources (reporting groups and contracts) or lists of products related to a given reporting group are not available in Billing Center API v2 but are available in Contracts API v1. Note that the original Billing v1 operation returned only billable contracts and reporting groups. The new Contracts API returns all contracts and reporting groups, and queries to Billing Center API v2 with non-billable items will return a 403 response.

  • To retrieve a list of products for reporting groups, run the List products per reporting group operation.

  • To retrieve a list of products for contracts, run the List products per contract operation.

  • To retrieve a list of billable contracts or reporting groups, run the List contracts or List CP code reporting groups operation.

• Cross-account data. Use the Find matching usage operation Billing Center API v2 to retrieve usage statistics, then use the CP Codes and Reporting Groups API to retrieve CP code or reporting group associations for that usage. Note that the CP Codes and Reporting Group API does not support cross-account data, so you will need to switch accounts as necessary. You can also switch accounts in Billing Center API v2 as needed to retrieve targeted data. Alternatively, you can run List usage per contract or List usage per reporting group for each account.

• Daily or monthly data retrieval. Billing Center API v1 had separate operations for daily or monthly data. Billing API v2 uses a single operation (List usage for contracts or List usage for reporting groups) with the billingDayOnly parameter. Setting billingDayOnly=true returns one statistic for each day, the billing day total.

To retrieve a contract usage report for a list of contracts or reporting groups using Billing API v2:

1. Run List CP codes in the CP Codes and Reporting Groups API to retrieve lists of CP codes for reporting groups or contracts.

2. Run the Find matching usage operation to retrieve usage statistics.

To retrieve a monthly or daily contract usage report for a single contract using Billing API v2:

• Run the List usage per contract operation. Setting billingDayOnly=true returns one statistic for each day, the billing day total.

To retrieve a monthly or daily contract usage report for a single reporting group using Billing API v2:

• Run the List usage per reporting group operation. Setting billingDayOnly=true returns one statistic for each day, the billing day total.

To retrieve the available statistics types for a given period of time for a single contract using Billing API v2:

• Run the List statistics per contract operation.

To retrieve the available statistics types for a given period of time for a single reporting group using Billing API v2:

• Run the List statistics per reporting group operation.

Resources

The Billing Center API allows you to access your website’s monthly usage over the Akamai network. Usage data is available for entire contracts, or for reporting groups, which may include CP codes from more than one contract.

See Getting started for information on how to obtain valid contractId, productId, and reportingGroupId values.

API summary

Download the RAML descriptors for this API.

List usage per contract

This operation lists a period of usage for an entire contract. See List usage per reporting group to report on related subsets of usage. Usage is aggregated daily, with one value per statistic. Unless final is true, data may still update to reflect latent edge server traffic. This operation may yield an error if you request too much data.

[
    {
        "date": "2015-01-01",
        "value": 1.25,
        "final": true,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-02",
        "value": 1.3,
        "final": true,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-03",
        "value": 1.33,
        "final": true,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-04",
        "value": 1.37,
        "final": false,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-05",
        "value": 1.43,
        "final": false,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    }
]

List statistics per contract

Optionally run this operation if there’s only one type of information you want to include in your usage report, rather than the complete set. This lists each type of reportable statistic. Availability may depend on the term of the contract, hence the need to specify them for a range of time.

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

List usage per reporting group

This operation lists a period of usage for a reporting group. Reporting groups collect sets of CP codes under a contract, allowing you to track billing for related types of traffic rather than for the entire contract. Usage is aggregated daily, with one value per statistic. Unless final is true, data may still update to reflect latent edge server traffic. This operation may yield an error if you request too much data.

[
    {
        "date": "2015-01-01",
        "value": 1.25,
        "final": true,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-02",
        "value": 1.3,
        "final": true,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-03",
        "value": 1.33,
        "final": true,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-04",
        "value": 1.37,
        "final": false,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    },
    {
        "date": "2015-01-05",
        "value": 1.43,
        "final": false,
        "statistic": {
            "name": "Total MB",
            "unit": "MB"
        }
    }
]

List statistics per reporting group

Optionally run this operation if there’s only one type of information you want to include in a reporting group’s usage report, rather than the complete set. Availability of reportable statistics may depend on the term of the contract, hence the need to specify them for a range of time.

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

Find matching usage

List usage data matching any criteria specified by a Query object. The query needs to specify at least one contractId or reportingGroupId value. This operation may yield an error if you request too much data.

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

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

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:

Statistic

Contains metadata that characterizes usage data.

Download schema: statistic-schema.json

Sample GET response:

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

Statistic members

Usage

Specifies daily aggregated usage data.

Download schema: measure-schema.json, specific-measure-schema.json

Sample GET response:

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

Usage members

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

Errors

This section tells you what you need to know about the Billing Center API’s error response format, and details the range of HTTP status codes the API produces.

Error responses

The API produces JSON errors as in the following sample. See the sections below for details on each data member.

{
  "details": [
    {
      "field": "year",
      "code": "year.date.year.missing",
      "message": "Month parameter cannot be provided without year parameter.",
      "data": {
        "field": "year",
        "value": "null"
      }
    }
  ],
  "code": "validation.failure",
  "title": "Validation failure",
  "incidentId": "361cd072-e213-4c4e-984d-631be108a1fe",
  "resolution": null,
  "helpUrl": null
}

Error members

Error.details

HTTP status codes

The API produces the following set of HTTP status codes for both success and failure scenarios:

Last modified: 1/10/2019