Billing API v1

Access your monthly usage over the Akamai network.

Learn more:


Overview

The Billing API provides data about your monthly usage over the Akamai network. The daily and monthly usage data is available for products, contracts, reporting groups, and CP codes.

This API offers a programmatic alternative to the Usage by Product, Usage by Contract, and Usage by Reporting Group reports available in the Billing interface.

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. You can also use the API to compare usage data with your billing invoice.

Get 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, and set the access level to READ.

  • Some API operations require a contractId identifier. It’s available programmatically from the Contracts API. The Billing API allows access to any contract for which you have permission to view billing data.

  • Some API operations require a reportingGroupId identifier. It’s available programmatically from the Contracts API. You can also find it in Control Center’s CP Codes and Reporting Groups view.

  • 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.

Interaction with other Akamai APIs

This section clarifies the range of this API’s functionality, and how to gather data from other Akamai APIs for use in generating billing reports.

  • CP code data. This API doesn’t make reporting group and contract data available for use in generating billing reports. Use the CP Codes and Reporting Groups API to gather that information. To list CP codes for reporting groups or contracts, List details of a reporting group.

  • Reporting groups or Contract data. The Billing API doesn’t list billable sources such as reporting groups or contracts, and doesn’t list products related to reporting groups. Use the Contracts API to get that data. If you use the Billing API to report on non-billable items, it responds with a 204 status code.

Rate limiting

This API imposes a rate limiting constraint of 500 requests per minute per account. Exceeding this limit results in a 429 error response. Consider this when calling successive operations as part of a loop.

All responses specify these rate limit headers:

  • X-RateLimit-Limit. The maximum number of requests allowed each minute.

  • X-RateLimit-Remaining. The number of allowed requests remaining. Except for any subsequent requests that reduce the number, this gradually increments until it reaches the X-RateLimit-Limit.

Resources

This section provides details on the API’s various operations.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Usage by contract and product  
List usage products per contract GET /billing/v1/contracts/{contractId}/products{?start,end}
List cumulative daily usage per contract and product GET /billing/v1/contracts/{contractId}/products/{productId}/usage/daily{?month}
List monthly summary usage per contract and product GET /billing/v1/contracts/{contractId}/products/{productId}/usage/monthly-summary{?start,end}
List monthly summary usage per CP code GET /billing/v1/contracts/{contractId}/products/{productId}/usage/by-cp-code/monthly-summary{?start,end}
Usage by reporting group  
List cumulative daily usage per reporting group GET /billing/v1/reporting-groups/{reportingGroupId}/products/{productId}/usage/daily{?month}
List monthly summary usage per reporting group GET /billing/v1/reporting-groups/{reportingGroupId}/products/{productId}/usage/monthly-summary{?start,end}
Subcustomer geobilling usage  
Download subcustomer geobilling files GET /billing/v1/contracts/{contractId}/products/{productId}/geo-billing-files{?day,month,year}

List usage products per contract

Returns IDs and names of the billable usage products for the specified contract and the selected time frame. If you have products that are billed geographically, you can see monthly usage statistics by region.

GET /billing/v1/contracts/{contractId}/products{?start,end}

Sample: /billing/v1/contracts/1-ABCDEF/products?start=2020-07&end=2020-09

Parameter Type Sample Description
URL path parameters
contractId String 1-ABCDEF Identifies the contract that you want to see aggregated data from.
Required query parameters
end String 2020-09 The end (exclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).
start String 2020-07 The start (inclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).

Status 200 application/json

Object type: Product

Download schema: products-list-schema.json

Response body:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "usagePeriods": [
        {
            "month": "2020-07",
            "usageProducts": [
                {
                    "productId": "M-LC-118405",
                    "productName": "Web Application Accelerator"
                },
                {
                    "productId": "M-LC-11233",
                    "productName": "DSA"
                }
            ]
        },
        {
            "month": "2020-08",
            "usageProducts": [
                {
                    "productId": "M-LC-118405",
                    "productName": "Web Application Accelerator"
                }
            ]
        }
    ]
}

Status 204

  1. Determine the appropriate contractId as described in Get started.

  2. Determine the start and end date range for which you want data.

  3. Make a GET request to /billing/v1/contracts/{contractId}/products{?start,end}.

The operation responds with a Product object.

List cumulative daily usage per contract and product

Returns cumulative daily usage details of the specified contract and product for the selected month. If you have products that are billed geographically, you can see monthly usage statistics by region.

GET /billing/v1/contracts/{contractId}/products/{productId}/usage/daily{?month}

Sample: /billing/v1/contracts/1-ABCDEF/products/1-ABC012/usage/daily?month=2020-07

Parameter Type Sample Description
URL path parameters
contractId String 1-ABCDEF Identifies the contract that you want to see aggregated data from.
productId String 1-ABC012 Identifies the product you want to see aggregated data for.
Required query parameters
month String 2020-07 Selected billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).

Status 200 application/json

Object type: ProductDailyUsage

Download schema: daily-usage-per-contract-schema.json

Response body:

{
    "month": "2020-07",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "dataStatus": "DATA_FINALIZED",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2020-07-01",
            "end": "2020-07-31",
            "region": "GLOBAL",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Total Hits",
                    "unit": "Hits",
                    "isBillable": false,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Peak",
                    "unit": "Mbps",
                    "isBillable": false,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                }
            ]
        }
    ]
}

Status 204

  1. Determine the appropriate contractId as described in Get started.

  2. Run the List usage products per contract operation to list billable usage products of the entire contract. Store a productId value assigned to the product that you want data from.

  3. Determine the month you want data for.

  4. Make a GET request to /billing/v1/contracts/{contractId}/products/{productId}/usage/daily{?month}.

The operation responds with a ProductDailyUsage object.

List monthly summary usage per contract and product

Returns monthly summary usage details of the specified contract and product for the selected time frame. If you have products that are billed geographically, you can see monthly usage statistics by region.

GET /billing/v1/contracts/{contractId}/products/{productId}/usage/monthly-summary{?start,end}

Sample: /billing/v1/contracts/1-ABCDEF/products/1-ABC012/usage/monthly-summary?start=2020-07&end=2020-09

Parameter Type Sample Description
URL path parameters
contractId String 1-ABCDEF Identifies the contract that you want to see aggregated data from.
productId String 1-ABC012 Identifies the product you want to see aggregated data for.
Required query parameters
end String 2020-09 The end (exclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).
start String 2020-07 The start (inclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).

Status 200 application/json

Object type: ProductMonthlyUsage

Download schema: summary-usage-per-contract-schema.json

Response body:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2017-07-01",
            "end": "2017-07-31",
            "region": "GLOBAL",
            "dataStatus": "DATA_FINALIZED",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "value": 30.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "value": 1.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "isBillable": false,
                    "value": 22
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "isBillable": false,
                    "value": 1
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-01",
            "end": "2020-08-15",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "isBillable": false,
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "isBillable": false,
                    "value": 11
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-16",
            "end": "2020-08-31",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "isBillable": false,
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "isBillable": false,
                    "value": 11
                }
            ]
        }
    ]
}

Status 204

  1. Determine the appropriate contractId as described in Get started.

  2. Run the List usage products per contract operation to list billable usage products of the entire contract. Store a productId value assigned to the product that you want data from.

  3. Determine the start and end date range you want data for.

  4. Make a GET request to /billing/v1/contracts/{contractId}/products/{productId}/usage/monthly-summary{?start,end}.

The operation responds with a ProductMonthlyUsage object.

List monthly summary usage per CP code

Returns monthly summary usage details of the specified contract and product per CP code for the selected time frame. If you have products that are billed geographically, you can see monthly usage statistics by region.

GET /billing/v1/contracts/{contractId}/products/{productId}/usage/by-cp-code/monthly-summary{?start,end}

Sample: /billing/v1/contracts/1-ABCDEF/products/1-ABC012/usage/by-cp-code/monthly-summary?start=2020-07&end=2020-09

Parameter Type Sample Description
URL path parameters
contractId String 1-ABCDEF Identifies the contract that you want to see aggregated data from.
productId String 1-ABC012 Identifies the product you want to see aggregated data for.
Required query parameters
end String 2020-09 The end (exclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).
start String 2020-07 The start (inclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).

Status 200 application/json

Object type: CpcodeMonthlyUsage

Download schema: summary-usage-per-cp-code-schema.json

Response body:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "usagePeriods": [
        {
            "region": "GLOBAL",
            "month": "2020-07",
            "dataStatus": "COLLECTING_DATA",
            "start": "2020-07-01",
            "end": "2020-07-31",
            "cpCodeStats": [
                {
                    "cpCode": 12345,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 106.3
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 430
                        }
                    ]
                },
                {
                    "cpCode": 67890,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 221.3
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 400
                        }
                    ]
                }
            ]
        },
        {
            "region": "GLOBAL",
            "month": "2020-08",
            "dataStatus": "COLLECTING_DATA",
            "start": "2020-08-01",
            "end": "2020-08-31",
            "cpCodeStats": [
                {
                    "cpCode": 12345,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 115.22
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 500
                        }
                    ]
                },
                {
                    "cpCode": 67890,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 76.3
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 320
                        }
                    ]
                }
            ]
        }
    ]
}

Status 204

  1. Determine the appropriate contractId as described in Get started.

  2. Run the List usage products per contract operation to list billable usage products of the entire contract. Store a productId value assigned to the product that you want data from.

  3. Determine the start and end date range you want data for.

  4. Make a GET request to /billing/v1/contracts/{contractId}/products/{productId}/usage/by-cp-code/monthly-summary{?start,end}.

The operation responds with a CpcodeMonthlyUsage object.

List cumulative daily usage per reporting group

Returns cumulative daily usage details of the specified reporting group and product for the selected month. If you have products that are billed geographically, you can see monthly usage statistics by region.

GET /billing/v1/reporting-groups/{reportingGroupId}/products/{productId}/usage/daily{?month}

Sample: /billing/v1/reporting-groups/782312/products/M-LC–118405/usage/daily?month=2020-07

Parameter Type Sample Description
URL path parameters
reportingGroupId Integer 782312 Identifies the reporting group that you want to see aggregated data for.
productId String M-LC-118405 Identifies the product you want to see aggregated data for.
Required query parameters
month String 2020-07 Selected billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).

Status 200 application/json

Object type: ReportingGroupDailyUsage

Download schema: daily-usage-per-reporting-group-schema.json

Response body:

{
    "month": "2020-07",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "reportingGroupId": 782312,
    "reportingGroupName": "RG #782312",
    "cpCodes": [
        1234,
        124124,
        123435,
        64565
    ],
    "dataStatus": "DATA_FINALIZED",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2020-07-01",
            "end": "2020-07-31",
            "region": "GLOBAL",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Total Hits",
                    "unit": "Hits",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Peak",
                    "unit": "Mbps",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                }
            ]
        }
    ]
}

Status 204

  1. Determine the appropriate reportingGroupId as described in Get started.

  2. Run the List products per reporting group operation to list billable usage products of the entire contract. Store a productId value assigned to the product that you want data from.

  3. Determine the month you want data for.

  4. Make a GET request to /billing/v1/reporting-groups/{reportingGroupId}/products/{productId}/usage/daily{?month}.

  5. The operation responds with a ReportingGroupDailyUsage object.

List monthly summary usage per reporting group

Returns monthly summary usage details of the specified reporting group and product for the selected time frame. If you have products that are billed geographically, you can see monthly usage statistics by region.

GET /billing/v1/reporting-groups/{reportingGroupId}/products/{productId}/usage/monthly-summary{?start,end}

Sample: /billing/v1/reporting-groups/782312/products/M-LC–118405/usage/monthly-summary?start=2020-07&end=2020-09

Parameter Type Sample Description
URL path parameters
reportingGroupId Integer 782312 Identifies the reporting group that you want to see aggregated data for.
productId String M-LC-118405 Identifies the product you want to see aggregated data for.
Required query parameters
end String 2020-09 The end (exclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).
start String 2020-07 The start (inclusive) of the billable usage period, expressed as an ISO 8601 datestamp (YYYY-MM).

Status 200 application/json

Object type: ReportingGroupMonthlyUsage

Download schema: summary-usage-per-reporting-group-schema.json

Response body:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "reportingGroupId": 782312,
    "reportingGroupName": "RG #782312",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2017-07-01",
            "end": "2017-07-31",
            "region": "GLOBAL",
            "dataStatus": "DATA_FINALIZED",
            "cpCodes": [
                1234,
                124124,
                123435,
                64565
            ],
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "value": 30.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "value": 1.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "value": 22
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "value": 1
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-01",
            "end": "2020-08-15",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "value": 11
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-16",
            "end": "2020-08-31",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "value": 11
                }
            ]
        }
    ]
}

Status 204

  1. Determine the appropriate reportingGroupId as described in Get started.

  2. Run the List products per reporting group operation to list billable usage products of the entire contract. Store a productId value assigned to the product that you want data from.

  3. Determine the start and end date range you want data for.

  4. Make a GET request to /billing/v1/reporting-groups/{reportingGroupId}/products/{productId}/usage/monthly-summary{?start,end}.

  5. The operation responds with a ReportingGroupMonthlyUsage object.

Download subcustomer geobilling files

Provides details on subcustomer invoicing for each geographic zone within the Akamai network for Akamai Cloud Embed. The downloadable file is available in the response body, formatted as a gzip-compressed CSV. The Param-md5-uncompressed response header provides an MD5 checksum for the uncompressed file. See GEO_ID codes for details on each geographic code. For information on how to interpret SUB_CUST_ID values, see the Cloud Embed - Implementation Guide.

GET /billing/v1/contracts/{contractId}/products/{productId}/geo-billing-files{?day,month,year}

Sample: /billing/v1/contracts/1-5QRKWT/products/M-LC–118405/geo-billing-files?day=1&month=7&year=2015

Parameter Type Sample Description
URL path parameters
contractId String 1-5QRKWT Identifies the contract that you want to see aggregated data from.
productId String M-LC-118405 Identifies the product you want to see aggregated data for.
Required query parameters
day Integer 1 The day for which you want to see aggregated data. You need to specify corresponding month and year values.
month Integer 7 The month for which you want to see aggregated data. You need to specify corresponding year and day values.
year Integer 2015 The year for which you want to see aggregated data. You need to specify corresponding month and day values.

Status 200 application/gzip

Headers:

Param-md5-uncompressed: 52d160f07262f5928655096163d12b2e

Response body:

(Body specifies GZIP binary data.)

Status 204

GEO_ID codes

The CSV data you get from the Download subcustomer geobiliing files operation, uses these codes:

Code Location
0 Any location that can’t be mapped to any of the regions below
1 North America
2 South America
3 Europe, the Middle East, and Africa
4 Australia and New Zealand
5 Japan
6 India
7 China
8 Remaining Asia and Pacific region

Data

This section provides details for each type of data object the API exchanges.

Download the JSON schemas for this API.

This section’s data schema tables list membership requirements as follows:

Member is required in requests, or always present in responses, even if its value is empty or null.

Product

List of usage products.

Download schema: products-list-schema.json

Sample GET response:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "usagePeriods": [
        {
            "month": "2020-07",
            "usageProducts": [
                {
                    "productId": "M-LC-118405",
                    "productName": "Web Application Accelerator"
                },
                {
                    "productId": "M-LC-11233",
                    "productName": "DSA"
                }
            ]
        },
        {
            "month": "2020-08",
            "usageProducts": [
                {
                    "productId": "M-LC-118405",
                    "productName": "Web Application Accelerator"
                }
            ]
        }
    ]
}

Product members

Member Type Description
Product: List of usage products.
accountId String Identifies the account.
contractId String Identifies the contract the data reflects.
end String The end of the billable usage period, expressed as an ISO 8601 datestamp.
requestDate String Request date expressed as an ISO 8601 timestamp.
start String The start of the billable usage period, expressed as an ISO 8601 datestamp.
usagePeriods Product.usagePeriods[] Specifies usage periods.
Product.usagePeriods[]: Specifies usage periods.
month String The billable usage period, expressed as an ISO 8601 datestamp.
usageProducts Product.usagePeriods[].usageProducts[] Specifies usage products.
Product.usagePeriods[].usageProducts[]: Specifies usage products.
productId String Identifies the product whose usage the data reflects.
productName String The name of the product whose usage the data reflects.

ProductDailyUsage

Daily usage data per contract and product.

Download schema: daily-usage-per-contract-schema.json

Sample GET response:

{
    "month": "2020-07",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "dataStatus": "DATA_FINALIZED",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2020-07-01",
            "end": "2020-07-31",
            "region": "GLOBAL",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Total Hits",
                    "unit": "Hits",
                    "isBillable": false,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Peak",
                    "unit": "Mbps",
                    "isBillable": false,
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                }
            ]
        }
    ]
}

ProductDailyUsage members

Member Type Description
ProductDailyUsage: Daily usage data per contract and product.
accountId String Identifies the account.
contractId String Identifies the contract the data reflects.
dataStatus Enumeration The status of the bill data. These are the available values: COLLECTING_DATA for data that is being collected. Data is collected through the end of the month, and is used to prepare your invoice. DATA_COLLECTED for data that is complete. The invoice is being prepared, if you’re expecting one. If you had contract changes, data will be adjusted to reflect them. DATA_FINALIZED for final data that is on your invoice. Note. The DATA_COLLECTED value isn’t yet implemented. It will be available soon.
month String Selected billable usage period, expressed as an ISO 8601 datestamp.
productId String Identifies the product whose usage the data reflects.
productName String The name of the product whose usage the data reflects.
requestDate String Request date expressed as an ISO 8601 timestamp.
usagePeriods ProductDailyUsage.usagePeriods[] Specifies usage periods.
ProductDailyUsage.usagePeriods[]: Specifies usage periods.
end String The end of the billable usage period, expressed as an ISO 8601 date.
month String Selected billable usage period, expressed as an ISO 8601 datestamp.
region String The billing region the data reflects.
start String The start of the billable usage period, expressed as an ISO 8601 date.
stats ProductDailyUsage.usagePeriods[].stats[] Contains metadata that characterizes usage data.
ProductDailyUsage.usagePeriods[].stats[]: Contains metadata that characterizes usage data.
isBillable Boolean Whether the usage is billable.
statType String The type of statistic.
unit String Specifies the unit of measure.
values ProductDailyUsage.usagePeriods[].stats[].values[] Contains usage data.
ProductDailyUsage.usagePeriods[].stats[].values[]: Contains usage data.
date String The ISO 8601 date for when the usage occurred.
value Number Provides the raw measure of numeric usage data.

ProductMonthlyUsage

Monthly summary usage data per contract and product.

Download schema: summary-usage-per-contract-schema.json

Sample GET response:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2017-07-01",
            "end": "2017-07-31",
            "region": "GLOBAL",
            "dataStatus": "DATA_FINALIZED",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "value": 30.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "value": 1.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "isBillable": false,
                    "value": 22
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "isBillable": false,
                    "value": 1
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-01",
            "end": "2020-08-15",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "isBillable": false,
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "isBillable": false,
                    "value": 11
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-16",
            "end": "2020-08-31",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "isBillable": true,
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "isBillable": false,
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "isBillable": false,
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "isBillable": false,
                    "value": 11
                }
            ]
        }
    ]
}

ProductMonthlyUsage members

Member Type Description
ProductMonthlyUsage: Monthly summary usage data per contract and product.
accountId String Identifies the account.
contractId String Identifies the contract the data reflects.
end String The end of the billable usage period, expressed as an ISO 8601 datestamp.
productId String Identifies the product whose usage the data reflects.
productName String The product name of the product whose usage the data reflects.
requestDate String Request date expressed as an ISO 8601 timestamp.
start String The start of the billable usage period, expressed as an ISO 8601 datestamp.
usagePeriods ProductMonthlyUsage.usagePeriods[] Specifies usage periods.
ProductMonthlyUsage.usagePeriods[]: Specifies usage periods.
dataStatus Enumeration The status of the bill data. These are the available values: COLLECTING_DATA for data that is being collected. Data is collected through the end of the month, and is used to prepare your invoice. DATA_COLLECTED for data that is complete. The invoice is being prepared, if you’re expecting one. If you had contract changes, data will be adjusted to reflect them. DATA_FINALIZED for final data that is on your invoice. Note. The DATA_COLLECTED value isn’t yet implemented. It will be available soon.
end String The end of the billable usage period, expressed as an ISO 8601 date.
month String The billable usage period, expressed as an ISO 8601 datestamp.
region String The billing region the data reflects.
start String The start of the billable usage period, expressed as an ISO 8601 date.
stats ProductMonthlyUsage.usagePeriods[].stats[] Contains usage data and metadata that characterizes it.
ProductMonthlyUsage.usagePeriods[].stats[]: Contains usage data and metadata that characterizes it.
isBillable Boolean Whether the usage is billable.
statType String The type of statistic.
unit String Specifies the unit of measure.
value Number Provides the raw measure of numeric usage data.

CpcodeMonthlyUsage

Monthly summary usage data per CP code.

Download schema: summary-usage-per-cp-code-schema.json

Sample GET response:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "usagePeriods": [
        {
            "region": "GLOBAL",
            "month": "2020-07",
            "dataStatus": "COLLECTING_DATA",
            "start": "2020-07-01",
            "end": "2020-07-31",
            "cpCodeStats": [
                {
                    "cpCode": 12345,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 106.3
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 430
                        }
                    ]
                },
                {
                    "cpCode": 67890,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 221.3
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 400
                        }
                    ]
                }
            ]
        },
        {
            "region": "GLOBAL",
            "month": "2020-08",
            "dataStatus": "COLLECTING_DATA",
            "start": "2020-08-01",
            "end": "2020-08-31",
            "cpCodeStats": [
                {
                    "cpCode": 12345,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 115.22
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 500
                        }
                    ]
                },
                {
                    "cpCode": 67890,
                    "stats": [
                        {
                            "statType": "GB",
                            "unit": "GB",
                            "isBillable": true,
                            "value": 76.3
                        },
                        {
                            "statType": "Hits",
                            "unit": "Hits",
                            "isBillable": false,
                            "value": 320
                        }
                    ]
                }
            ]
        }
    ]
}

CpcodeMonthlyUsage members

Member Type Description
CpcodeMonthlyUsage: Monthly summary usage data per CP code.
accountId String Identifies the account.
contractId String Identifies the contract the data reflects.
end String The end of the billable usage period, expressed as an ISO 8601 datestamp.
productId String Identifies the product whose usage the data reflects.
productName String The product name of the product whose usage the data reflects.
requestDate String Request date expressed as an ISO 8601 timestamp.
start String The start of the billable usage period, expressed as an ISO 8601 datestamp.
usagePeriods CpcodeMonthlyUsage.usagePeriods[] Specifies usage periods.
CpcodeMonthlyUsage.usagePeriods[]: Specifies usage periods.
cpCodeStats CpcodeMonthlyUsage.usagePeriods[].cpCodeStats[] Contains usage data for CP codes within the context of the specified contract and product.
dataStatus Enumeration The status of the bill data. These are the available values: COLLECTING_DATA for data that is being collected. Data is collected through the end of the month, and is used to prepare your invoice. DATA_COLLECTED for data that is complete. The invoice is being prepared, if you’re expecting one. If you had contract changes, data will be adjusted to reflect them. DATA_FINALIZED for final data that is on your invoice. Note. The DATA_COLLECTED value isn’t yet implemented. It will be available soon.
end String The end of the billable usage period, expressed as an ISO 8601 date.
month String The billable usage period, expressed as an ISO 8601 datestamp.
region String The billing region the data reflects.
start String The start of the billable usage period, expressed as an ISO 8601 date.
CpcodeMonthlyUsage.usagePeriods[].cpCodeStats[]: Contains usage data for CP codes within the context of the specified contract and product.
cpCode Integer Content Provider code. The unique identifier for reporting, billing, and monitoring traffic.
stats CpcodeMonthlyUsage.usagePeriods[].cpCodeStats[].stats[] Contains usage data and metadata that characterizes it.
CpcodeMonthlyUsage.usagePeriods[].cpCodeStats[].stats[]: Contains usage data and metadata that characterizes it.
isBillable Boolean Whether the usage is billable.
statType String The type of statistic.
unit String Specifies the unit of measure.
value Number Provides the raw measure of numeric usage data.

ReportingGroupDailyUsage

Daily usage data per reporting group.

Download schema: daily-usage-per-reporting-group-schema.json

Sample GET response:

{
    "month": "2020-07",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "reportingGroupId": 782312,
    "reportingGroupName": "RG #782312",
    "cpCodes": [
        1234,
        124124,
        123435,
        64565
    ],
    "dataStatus": "DATA_FINALIZED",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2020-07-01",
            "end": "2020-07-31",
            "region": "GLOBAL",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Total Hits",
                    "unit": "Hits",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                },
                {
                    "statType": "Peak",
                    "unit": "Mbps",
                    "values": [
                        {
                            "date": "2020-07-01",
                            "value": 30.3
                        },
                        {
                            "date": "2020-07-02",
                            "value": 32.3
                        },
                        {
                            "date": "2020-07-03",
                            "value": 35.3
                        },
                        {
                            "date": "2020-07-04",
                            "value": 36.3
                        },
                        {
                            "date": "2020-07-05",
                            "value": 37.3
                        },
                        {
                            "date": "2020-07-06",
                            "value": 38.3
                        },
                        {
                            "date": "2020-07-07",
                            "value": 39.3
                        },
                        {
                            "date": "2020-07-08",
                            "value": 42.3
                        },
                        {
                            "date": "2020-07-09",
                            "value": 51.3
                        },
                        {
                            "date": "2020-07-10",
                            "value": 62.3
                        },
                        {
                            "date": "2020-07-11",
                            "value": 64.3
                        },
                        {
                            "date": "2020-07-12",
                            "value": 72.3
                        },
                        {
                            "date": "2020-07-13",
                            "value": 75.3
                        },
                        {
                            "date": "2020-07-14",
                            "value": 78.3
                        },
                        {
                            "date": "2020-07-15",
                            "value": 83.3
                        },
                        {
                            "date": "2020-07-16",
                            "value": 90.3
                        },
                        {
                            "date": "2020-07-17",
                            "value": 92.3
                        },
                        {
                            "date": "2020-07-18",
                            "value": 93.3
                        },
                        {
                            "date": "2020-07-19",
                            "value": 94.3
                        },
                        {
                            "date": "2020-07-20",
                            "value": 95.3
                        },
                        {
                            "date": "2020-07-21",
                            "value": 96.3
                        },
                        {
                            "date": "2020-07-22",
                            "value": 97.3
                        },
                        {
                            "date": "2020-07-23",
                            "value": 98.3
                        },
                        {
                            "date": "2020-07-24",
                            "value": 99.3
                        },
                        {
                            "date": "2020-07-25",
                            "value": 100.3
                        },
                        {
                            "date": "2020-07-26",
                            "value": 101.3
                        },
                        {
                            "date": "2020-07-27",
                            "value": 102.3
                        },
                        {
                            "date": "2020-07-28",
                            "value": 103.3
                        },
                        {
                            "date": "2020-07-29",
                            "value": 104.3
                        },
                        {
                            "date": "2020-07-30",
                            "value": 105.3
                        },
                        {
                            "date": "2020-07-31",
                            "value": 106.3
                        }
                    ]
                }
            ]
        }
    ]
}

ReportingGroupDailyUsage members

Member Type Description
ReportingGroupDailyUsage: Daily usage data per reporting group.
accountId String Identifies the account.
contractId String Identifies the contract the data reflects.
cpCodes Array CP codes of the specified reporting group.
dataStatus Enumeration The status of the bill data. These are the available values: COLLECTING_DATA for data that is being collected. Data is collected through the end of the month, and is used to prepare your invoice. DATA_COLLECTED for data that is complete. The invoice is being prepared, if you’re expecting one. If you had contract changes, data will be adjusted to reflect them. DATA_FINALIZED for final data that is on your invoice. Note. The DATA_COLLECTED value isn’t yet implemented. It will be available soon.
month String Selected billable usage period, expressed as an ISO 8601 datestamp.
productId String Identifies the product whose usage the data reflects.
productName String The name of the product whose usage the data reflects.
reportingGroupId Number Identifies the reporting group.
reportingGroupName String The name of the reporting group.
requestDate String Request date expressed as an ISO 8601 timestamp.
usagePeriods ReportingGroupDailyUsage.usagePeriods[] Specifies usage periods.
ReportingGroupDailyUsage.usagePeriods[]: Specifies usage periods.
end String The end of the billable usage period, expressed as an ISO 8601 date.
month String Selected billable usage period, expressed as an ISO 8601 datestamp.
region String The billing region the data reflects.
start String The start of the billable usage period, expressed as an ISO 8601 date.
stats ReportingGroupDailyUsage.usagePeriods[].stats[] Contains metadata that characterizes usage data.
ReportingGroupDailyUsage.usagePeriods[].stats[]: Contains metadata that characterizes usage data.
statType String The type of statistic.
unit String Specifies the unit of measure.
values ReportingGroupDailyUsage.usagePeriods[].stats[].values[] Contains usage data.
ReportingGroupDailyUsage.usagePeriods[].stats[].values[]: Contains usage data.
date String The ISO 8601 date for when the usage occurred.
value Number Provides the raw measure of numeric usage data.

ReportingGroupMonthlyUsage

Monthly summary usage data per reporting group.

Download schema: summary-usage-per-reporting-group-schema.json

Sample GET response:

{
    "start": "2020-07",
    "end": "2020-09",
    "requestDate": "2020-10-15T00:00:00Z",
    "accountId": "1-ABCD",
    "contractId": "1-ABCDEF",
    "productId": "M-LC-118405",
    "productName": "Web Application Accelerator",
    "reportingGroupId": 782312,
    "reportingGroupName": "RG #782312",
    "usagePeriods": [
        {
            "month": "2020-07",
            "start": "2017-07-01",
            "end": "2017-07-31",
            "region": "GLOBAL",
            "dataStatus": "DATA_FINALIZED",
            "cpCodes": [
                1234,
                124124,
                123435,
                64565
            ],
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "value": 30.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "value": 1.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "value": 22
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "value": 1
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-01",
            "end": "2020-08-15",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "value": 11
                }
            ]
        },
        {
            "month": "2020-08",
            "start": "2020-08-16",
            "end": "2020-08-31",
            "region": "GLOBAL",
            "dataStatus": "COLLECTING_DATA",
            "stats": [
                {
                    "statType": "Total MB",
                    "unit": "GB",
                    "value": 300.3
                },
                {
                    "statType": "95/5 Mbps",
                    "unit": "95/5 Mbps",
                    "value": 11.3
                },
                {
                    "statType": "Total Hits",
                    "unit": "Total Hits",
                    "value": 55
                },
                {
                    "statType": "Peak Mbps",
                    "unit": "Peak Mbps",
                    "value": 11
                }
            ]
        }
    ]
}

ReportingGroupMonthlyUsage members

Member Type Description
ReportingGroupMonthlyUsage: Monthly summary usage data per reporting group.
accountId String Identifies the account.
contractId String Identifies the contract the data reflects.
end String The end of the billable usage period, expressed as an ISO 8601 datestamp.
productId String Identifies the product whose usage the data reflects.
productName String The product name of the product whose usage the data reflects.
reportingGroupId Integer Identifies the reporting group.
reportingGroupName String The name of the reporting group.
requestDate String Request date expressed as an ISO 8601 timestamp.
start String The start of the billable usage period, expressed as an ISO 8601 datestamp.
usagePeriods ReportingGroupMonthlyUsage.usagePeriods[] Specifies usage periods.
ReportingGroupMonthlyUsage.usagePeriods[]: Specifies usage periods.
cpCodes Array CP codes of the specified reporting group.
dataStatus Enumeration The status of the bill data. These are the available values: COLLECTING_DATA for data that is being collected. Data is collected through the end of the month, and is used to prepare your invoice. DATA_COLLECTED for data that is complete. The invoice is being prepared, if you’re expecting one. If you had contract changes, data will be adjusted to reflect them. DATA_FINALIZED for final data that is on your invoice. Note. The DATA_COLLECTED value isn’t yet implemented. It will be available soon.
end String The end of the billable usage period, expressed as an ISO 8601 date.
month String The billable usage period, expressed as an ISO 8601 datestamp.
region String The billing region the data reflects.
start String The start of the billable usage period, expressed as an ISO 8601 date.
stats ReportingGroupMonthlyUsage.usagePeriods[].stats[] Contains usage data and metadata that characterizes it.
ReportingGroupMonthlyUsage.usagePeriods[].stats[]: Contains usage data and metadata that characterizes it.
statType String The type of statistic.
unit String Specifies the unit of measure.
value Number Provides the raw measure of numeric usage data.

Errors

This section provides details on the data object that reflects the API’s common response to error cases, and lists the API’s range of response status codes for both error and success cases.

Error responses

If any error occurs, this API responds with JSON objects that follow the HTTP Problem Details standard. This example shows an Access is denied error response object, where the title is a descriptive label for the overall problem, and the incidentId may be useful if you need to communicate the problem to your Akamai representative. It also includes the errors array that lists problems detected in the request.

{
    "type": "/billing/error-types/11",
    "title": "User in current context cannot access resource",
    "incidentId": "c7b6d7be-9268-4410-a031-cc0d013ce5c3",
    "errors": [
      {
        "type": "/billing/error-types/11",
        "title": "Access is denied"
      }
    ]
}

HTTP status codes

This section lists the full range of response codes the API may generate.

Code Description
200 The request succeeded and yielded data.
204 No Content. There is no data that matches your request.
400 Bad Request. This typically occurs due to a problem with the format of requested data, such as a non-parsing or invalid body of data, or an invalid set of query parameters or values.
401 API authentication failure. See Get started for guidance on how to correctly set up your API hostname token.
403 No permission to access this resource. This most likely reflects a limitation on the identity of the Control Panel user corresponding to the API client. See Get started to make sure you have permission to access all the functionality you need.
404 Resource not found. This typically occurs when a resource keyed by a URL path parameter no longer exists, or if the request URL is garbled in some other way.
429 Too many requests. See Rate limiting for more information.
500 Internal server error.