Media Delivery Reports API v1

Monitor and identify Akamai Media Delivery trends. Replaces much of the Media Reports API’s functionality.

Learn more:


Overview

Media Delivery Reports help you monitor and identify key trends of your Akamai Media Delivery solutions. Its one-stop, easy reporting interface within Luna Control Center gives you access to valuable insights to enhance your business by optimizing your streaming content, software downloads, and object delivery.

The Media Delivery Reports API v1 provides an easy interface to manage how Akamai processes data for various media delivery products.

This API replaces much of the media delivery functionality of the Media Reports API, but renamed and restarting at v1. Other functions of the older API will be re-deployed as a third API, separately from this one.

Error messages for failure to process requests, or validation failures are embedded in the JSON response.

Getting started

Before using the Media Delivery Reports API for the first time:

  • Contact your Akamai representative to enable it for your account.

  • The HTTP authorization header MUST be included in the request message:

    Authorization: EG1-HMAC-SHA256 client_token=[value];access_token=[value];timestamp=[value];nonce=  [value];signature=[value]
    

    This is standard RFC 2616, with proprietary specifics. Here is an example of an HTTP authorization header with line breaks added for readability:

    Authorization: EG1-HMAC-SHA256 client_token=akaa-275ca6de04b11b91-cf46074bf3b52950;
    access_token=akaa-d6cfbdb2d0594ae4-ad000cf3a5473a08;timestamp=20130817T02:49:13+0000;
    nonce=dd9957e2-4fe5-48ca-8d32-16a772ac6d8f;signature=Q3uWyssCz9qsNxekOX+PXP0WrtGT+J5qd6ssN1UmUmw=
    
  • Remember that all request parameter values must be UTF–8 encoded.

Rate limiting

The Media Reports API imposes a rate limiting constraint of five requests per minute. When calling successive operations as part of a loop, you need to consider that exceeding the limit results in a 429 error response. The API responds with the following HTTP headers to provide context over how close it is getting to the limit:

  • X-RateLimit-Limit: Five requests per minute.

  • X-RateLimit-Remaining: Number of remaining requests allowed during the period.

  • X-RateLimit-Reset: Timestamp indicating reset of request limit back to the higher limit.

Sample Usage: Steps to retrieve data

To query a report, you will first need to obtain data store metadata with information on the metrics and dimensions grouped together. You can then choose the required comnbinations to create customized reports tailored to your specifications.

Step 1: Get data stores

A data store is a collection of dimensions and metrics stored in a database that you can use to create a sub-set and configure reports suited to your requirements. Data store details help you determine the combination of dimensions and metrics to query.

  • Run the API operation below to retrieve available collection of data stores:

Below is a sample request and response (See List Adaptive Media Delivery Data Stores):

GET: /media-reports/v2/adaptive-media-delivery/data-stores

[
    {
        "id":3,
        "name":"Usage AMD",
        "type":"standard",
        "description":"ma_usage_adaptive_-_D_time",
        "dimensions":[
            {
                "id":1,
                "name":"Time",
                "description":"Indicates the time at which content was consumed.This dimension is set automatically.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            },
            {
                "id":2,
                "name":"CPCode",
                "description":"Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            }
        ],
        "metrics":[
            {
                "id":1,
                "name":"Play Duration",
                "unit":"seconds",
                "type":"time",
                "description":"Total time duration for which your media was played.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            },
            {
                "id":2,
                "name":"Edge + Midgress",
                "unit":"GB",
                "type":"volume",
                "description":"Sum of Edge And Midgress Volume",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds":86400,
        "purgeIntervalInDays":90,
        "maxQueryDurationInMinutes":44640
    },
    {
        "id":303,
        "name":"trafficsummary_-_F_time",
        "type":"standard",
        "description":"trafficsummary_-_F_time",
        "dimensions":[
            {
                "id":600,
                "name":"Time",
                "description":"Indicates the time at which content was consumed.This dimension is set automatically.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            },
            {
                "id":601,
                "name":"CP Code",
                "description":"Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            }
        ],
        "metrics":[
            {
                "id":608,
                "name":"Midgress Hits",
                "unit":"Count",
                "type":"count",
                "description":"Midgress traffic includes hits from edge servers to other edge servers.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            },
            {
                "id":609,
                "name":"Midgress Hits/sec",
                "unit":"Hits/sec",
                "type":"count",
                "description":"The total number of hits from Edge Servers to other Edge Servers, for the CP code(s) and time period selected.",
                "group":[
                    {
                        "id":-1,
                        "name":"OTHERS",
                        "description":"OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds":300,
        "purgeIntervalInDays":1,
        "maxQueryDurationInMinutes":1440
    }
]

Step 2: Retrieve data

This sample request and response shows how to fetch Edge Volume by Time for a specific CP code for the period 12/01/2015:00:00 to 12/01/2015:05:00with dimension ID 1 representing Time and metric ID 107 representing the metric Edge Volume for CP code 12345(See Get Adaptive Media Delivery Data):

GET: /media-reports/v2/adaptive-media-delivery/data?startDate=12/01/2015:00:00&endDate=12/01/2015:05:00&cpcodes=12345&ipVersion=ipv4&limit=1000&offset=0&deliveryOption=http&deliveryFormat=hls&deliveryType=live&dimensions=1&metrics=107

[
    {
        "columns": [
            {
                "type": "dimension",
                "name": "Time",
                "description": "time",
                "index": 0
            },
            {
                "type": "metric",
                "name": "Edge Volume",
                "description": "Edge Volume",
                "index": 1,
                "aggregate": "191.79",
                "peak": "101.09",
                "unit": "GB"
            }
        ],
        "rows": [
            [ "1448931300", "101.09" ],
            [ "1448937600", "10.06" ],
            [ "1448943000", "80.64" ]
        ],
        "metaData": {
            "aggregation": 300,
            "limit": 1000,
            "startTimeInEpoch": 1448928000,
            "hasMoreData": false,
            "timeZone": "GMT",
            "offset": 0,
            "reportPack": "Test report pack",
            "endTimeInEpoch": 1448946000
        }
    }
]

Resources

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

Below is a road map of all the conceptual objects you deal with when interacting with the Media Delivery Reports API:

  • Adaptive Media Delivery Reports: Provide an analysis of the delivery of HTTP adaptive streaming formats such as HLS, HDS, Smooth and MPEG-DASH, from 3rd party origins and Akamai Media Services alike.

  • Download Delivery Reports: Provide an analysis of large object delivery (that includes media downloads, and progressively downloaded content).

  • Wholesale Delivery Reports: Provide an analysis of the delivery of cloud hosted content.

  • Object Delivery Reports: Provide an analysis of delivery content such as images, CSS, JS and other files (under 100 MB in size, excluding objects of content type: text/html).

  • RTMP Media Delivery Reports: Provide monitoring and analysis of traffic, performance and availability for RTMP based media delivery streams.

  • Data Stores: A data store is a collection of dimensions and metrics stored in a data base that can be used to create reports.

  • Realtime Data: This near accurate data is derived from sample data sets, and is available at a latency of under 15 minutes.

  • Historical Data: Most data for Media Delivery Reports is historic data, extracted over a 24-hour time period. It is available for traffic, performance, availability, URLs, and unique viewers.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Download Delivery  
List Download Delivery data stores GET /media-delivery-reports/v1/download-delivery/data-stores
Get Download Delivery data store GET /media-delivery-reports/v1/download-delivery/data-stores/{dataStoreId}
Get Download Delivery data GET /media-delivery-reports/v1/download-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryOption,mediaAcceleration,ipVersion,enableCPCodeName}
Get Download Delivery real-time data GET /media-delivery-reports/v1/download-delivery/realtime-data{?dimensions,metrics,startDate,endDate,limit,offset,reduce,aggregation}
Object Delivery  
List Object Delivery data stores GET /media-delivery-reports/v1/object-delivery/data-stores
Get an Object Delivery data store GET /media-delivery-reports/v1/object-delivery/data-stores/{dataStoreId}
Get Object Delivery data GET /media-delivery-reports/v1/object-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,filterParams,sortParams,mediaAcceleration,enableCPCodeName}
Adaptive Media Delivery  
List Adaptive Media Delivery data stores GET /media-delivery-reports/v1/adaptive-media-delivery/data-stores
Get an Adaptive Media Delivery data store GET /media-delivery-reports/v1/adaptive-media-delivery/data-stores/{dataStoreId}
Get Adaptive Media Delivery data GET /media-delivery-reports/v1/adaptive-media-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryOption,deliveryType,deliveryFormat,mediaAcceleration,mediaEncryption,ipVersion,enableCPCodeName}
Get Adaptive Media Delivery real-time data GET /media-delivery-reports/v1/adaptive-media-delivery/realtime-data{?dimensions,metrics,startDate,endDate,limit,offset,reduce,aggregation}
RTMP Media Delivery  
List RTMP Media Delivery data stores GET /media-delivery-reports/v1/rtmp-media-delivery/data-stores
Get an RTMP Media Delivery data store GET /media-delivery-reports/v1/rtmp-media-delivery/data-stores/{dataStoreId}
Get RTMP Media Delivery data GET /media-delivery-reports/v1/rtmp-media-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryType,enableCPCodeName}
Wholesale Delivery  
List Wholesale Delivery data stores GET /media-delivery-reports/v1/wholesale-delivery/data-stores
Get a Wholesale Delivery data store GET /media-delivery-reports/v1/wholesale-delivery/data-stores/{dataStoreId}
Get Wholesale Delivery data GET /media-delivery-reports/v1/wholesale-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryOption,enableCPCodeName}

List Download Delivery data stores

A data store is a collection of dimensions, and metrics stored in a database that you can use to create a sub-set and configure reports suited to your requirements. Data store details help you determine the combination of dimensions and metrics to query. Each report pack comes with its standard data stores. You cannot combine dimensions, and metrics across data stores.

GET /media-delivery-reports/v1/download-delivery/data-stores

Status 200 application/json

Response Body:

[
    {
        "id": 15,
        "name": "Statistics",
        "type": "standard",
        "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), Offload and Edge Responses are available by Time and CP Code dimensions. Data is available at a minimum granularity of 5 minutes.",
        "dimensions": [
            {
                "id": 1,
                "name": "Time",
                "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 2,
                "name": "CPCode",
                "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 2,
                "name": "Edge + Midgress",
                "unit": "GB",
                "type": "volume",
                "description": "Sum of Edge And Midgress Volume",
                "dataType": "VOLUME",
                "helpText": "Sum of Edge And Midgress Volume",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 3,
                "name": "Peer Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "peer_bytes",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 4,
                "name": "Edge Hits",
                "type": "count",
                "description": "All hits to the edge servers from the end-users.",
                "dataType": "COUNT",
                "helpText": "All hits to the edge servers from the end-users.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 5,
                "name": "Edge Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Size of the actual content (Object body) transferred to the client.",
                "dataType": "VOLUME",
                "helpText": "Size of the actual content (Object body) transferred to the client.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 6,
                "name": "Edge Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the Edge-server to the end-user",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the Edge-server to the end-user",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 7,
                "name": "Edge Cached Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
                "dataType": "VOLUME",
                "helpText": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 8,
                "name": "Edge Secure Volume",
                "unit": "bytes",
                "type": "volume",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 9,
                "name": "Midgress Hits",
                "type": "count",
                "description": "Midgress traffic includes hits from edge servers to other edge servers.",
                "dataType": "COUNT",
                "helpText": "Midgress traffic includes hits from edge servers to other edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10,
                "name": "Midgress Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total object bytes transferred from one Edge server to another Edge server.",
                "dataType": "VOLUME",
                "helpText": "Total object bytes transferred from one Edge server to another Edge server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 11,
                "name": "Midgress Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 12,
                "name": "Origin Hits",
                "type": "count",
                "description": "All hits on the origin servers from Edge-servers.",
                "dataType": "COUNT",
                "helpText": "All hits on the origin servers from Edge-servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 13,
                "name": "Origin Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total object bytes transferred from the customer origin server to the Edge servers.",
                "dataType": "VOLUME",
                "helpText": "Total object bytes transferred from the customer origin server to the Edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 14,
                "name": "Origin Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the origin server to the Edge server.",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the origin server to the Edge server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 16,
                "name": "Download Completed",
                "type": "count",
                "description": "Number of downloads served successfully; Entire download was served (HTTP status 200) or the byte range (HTTP status 206) contained the last byte of the download.",
                "dataType": "COUNT",
                "helpText": "Number of downloads served successfully; Entire download was served (HTTP status 200) or the byte range (HTTP status 206) contained the last byte of the download.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 18,
                "name": "0XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes- 0xx (Client Abort)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes- 0xx (Client Abort)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 19,
                "name": "200 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 200 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 200 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 20,
                "name": "206 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 206 (Partial Content)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 206 (Partial Content)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 21,
                "name": "2XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 22,
                "name": "302 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 23,
                "name": "304 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 24,
                "name": "3XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 25,
                "name": "404 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned the response code - 400 (File not Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned the response code - 400 (File not Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 26,
                "name": "415 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 415 (Unsupported Media Type)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 415 (Unsupported Media Type)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 27,
                "name": "403 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 403 (Forbidden)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 403 (Forbidden)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 28,
                "name": "4XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 29,
                "name": "5XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 30,
                "name": "Other Hits",
                "type": "count",
                "description": "When a response code received doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
                "dataType": "COUNT",
                "helpText": "When a response code received doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 32,
                "name": "404 Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Size of the content (Object body) transferred to the client in case of 404 responses.",
                "dataType": "VOLUME",
                "helpText": "Size of the content (Object body) transferred to the client in case of 404 responses.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 33,
                "name": "404 Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "err_404_overbytes",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 34,
                "name": "Netstorage Hits",
                "type": "count",
                "description": "All hits from the edge servers to the Netstorage domain.",
                "dataType": "COUNT",
                "helpText": "All hits from the edge servers to the Netstorage domain.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 35,
                "name": "Netstorage Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "The total bytes transferred from the netstorage domain to the edge servers.",
                "dataType": "VOLUME",
                "helpText": "The total bytes transferred from the netstorage domain to the edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 165,
                "name": "Download Starts",
                "type": "count",
                "description": "Number of times the download was successfully initiated during a specific time interval.",
                "dataType": "COUNT",
                "helpText": "Number of times the download was successfully initiated during a specific time interval.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 166,
                "name": "Origin Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 167,
                "name": "Ingress Hits",
                "type": "count",
                "description": "All the hits from the edge server to origin, this includes customer origin and netstorage.",
                "dataType": "COUNT",
                "helpText": "All the hits from the edge server to origin, this includes customer origin and netstorage.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 168,
                "name": "Ingress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes netstorage and customer origin.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes netstorage and customer origin.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 41,
                "name": "Client Assisted Unicast Error Hits",
                "type": "count",
                "description": "cad_error_hits",
                "dataType": "COUNT",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 169,
                "name": "Offload (Hits)",
                "unit": "%",
                "type": "percent",
                "description": "Percentage of hits from the edge servers as compared to the hits from the origin server, including netstorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
                "dataType": "PERCENT",
                "helpText": "Percentage of hits from the edge servers as compared to the hits from the origin server, including netstorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 170,
                "name": "Offload (Volume)",
                "unit": "%",
                "type": "percent",
                "description": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including netstorage and customer origin.\nThis metric displays accurate values only for CP Codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP Codes that use 'Media Services Live' or 'Media Services On Demand'.",
                "dataType": "PERCENT",
                "helpText": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including netstorage and customer origin.\nThis metric displays accurate values only for CP Codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP Codes that use 'Media Services Live' or 'Media Services On Demand'.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 47,
                "name": "Prefetch Midgress Count",
                "type": "count",
                "description": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
                "dataType": "COUNT",
                "helpText": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 48,
                "name": "Prefetch Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
                "dataType": "VOLUME",
                "helpText": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 186,
                "name": "Ingress Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Ingress Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Ingress Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 453,
                "name": "Midgress Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Midgress Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Midgress Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 454,
                "name": "Edge Hits/sec",
                "type": "count",
                "description": "Edge Hits/sec",
                "dataType": "COUNT",
                "helpText": "Edge Hits/sec",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 455,
                "name": "Midgress Hits/sec",
                "type": "count",
                "description": "Midgress Hits/sec",
                "dataType": "COUNT",
                "helpText": "Midgress Hits/sec",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 456,
                "name": "Ingress Hits/sec",
                "type": "count",
                "description": "Ingress Hits/sec",
                "dataType": "COUNT",
                "helpText": "Ingress Hits/sec",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 219,
                "name": "Edge Error Rate",
                "unit": "%",
                "type": "percent",
                "description": "Edge Error Rate",
                "dataType": "PERCENT",
                "helpText": "Edge Error Rate",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 221,
                "name": "Edge Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Edge Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Edge Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 102,
                "name": "Edge Errors",
                "type": "count",
                "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "dataType": "COUNT",
                "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 103,
                "name": "Edge Throughput",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
                "dataType": "BANDWIDTH",
                "helpText": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 107,
                "name": "Edge Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 113,
                "name": "Download Requests",
                "type": "count",
                "description": "Number of download requests received from end-user, during a specific time interval.",
                "dataType": "COUNT",
                "helpText": "Number of download requests received from end-user, during a specific time interval.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 116,
                "name": "Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "midgress_bytes",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 118,
                "name": "Avg Download Time",
                "unit": "seconds",
                "type": "time",
                "description": "download time for OCP",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 300,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get Download Delivery data store

This fetches details of dimensions, metrics, the aggregation interval, purge interval, maximum allowed query interval, and other data store details.

GET /media-delivery-reports/v1/download-delivery/data-stores/{dataStoreId}

Sample: /media-delivery-reports/v1/download-delivery/data-stores/307

Parameter Type Sample Description
URL parameters
dataStoreId Number 307 The ID of the data store. Uniquely identifies it.

Status 200 application/json

Response Body:

{
    "id": 15,
    "name": "Statistics",
    "type": "standard",
    "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), Offload, and Edge Responses are available by Time and CP Code dimensions. Data is available at a minimum granularity of 5 minutes.",
    "dimensions": [
        {
            "id": 1,
            "name": "Time",
            "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 2,
            "name": "CPCode",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing, and monitoring traffic served.",
            "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and, monitoring traffic served.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 2,
            "name": "Edge + Midgress",
            "unit": "GB",
            "type": "volume",
            "description": "Sum of Edge And Midgress Volume",
            "dataType": "VOLUME",
            "helpText": "Sum of Edge And Midgress Volume",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 3,
            "name": "Peer Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "peer_bytes",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 4,
            "name": "Edge Hits",
            "type": "count",
            "description": "All hits to the edge servers from the end-users.",
            "dataType": "COUNT",
            "helpText": "All hits to the edge servers from the end-users.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 5,
            "name": "Edge Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Size of the actual content (Object body) transferred to the client.",
            "dataType": "VOLUME",
            "helpText": "Size of the actual content (Object body) transferred to the client.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 6,
            "name": "Edge Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the Edge-server to the end-user",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the Edge-server to the end-user",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 7,
            "name": "Edge Cached Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
            "dataType": "VOLUME",
            "helpText": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 8,
            "name": "Edge Secure Volume",
            "unit": "bytes",
            "type": "volume",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 9,
            "name": "Midgress Hits",
            "type": "count",
            "description": "Midgress traffic includes hits from edge servers to other Edge servers.",
            "dataType": "COUNT",
            "helpText": "Midgress traffic includes hits from edge servers to other Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10,
            "name": "Midgress Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total object bytes transferred from one Edge server to another Edge server.",
            "dataType": "VOLUME",
            "helpText": "Total object bytes transferred from one Edge server to another Edge server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 11,
            "name": "Midgress Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes, and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes, and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 12,
            "name": "Origin Hits",
            "type": "count",
            "description": "All hits on the origin servers from Edge-servers.",
            "dataType": "COUNT",
            "helpText": "All hits on the origin servers from Edge-servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 13,
            "name": "Origin Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total object bytes transferred from the customer origin server to the Edge servers.",
            "dataType": "VOLUME",
            "helpText": "Total object bytes transferred from the customer origin server to the Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 14,
            "name": "Origin Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the origin server to the Edge server.",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the origin server to the Edge server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 16,
            "name": "Download Completed",
            "type": "count",
            "description": "Number of downloads served successfully; entire download was served (HTTP status 200) or the byte range (HTTP status 206) contained the last byte of the download.",
            "dataType": "COUNT",
            "helpText": "Number of downloads served successfully; entire download was served (HTTP status 200) or the byte range (HTTP status 206) contained the last byte of the download.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 18,
            "name": "0XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code- 0xx (Client Abort)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code- 0xx (Client Abort)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 19,
            "name": "200 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 200 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 200 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 20,
            "name": "206 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 206 (Partial Content)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 206 (Partial Content)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 21,
            "name": "2XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 22,
            "name": "302 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 23,
            "name": "304 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 24,
            "name": "3XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 25,
            "name": "404 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned the response code - 400 (File not Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned the response code - 400 (File not Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 26,
            "name": "415 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 415 (Unsupported Media Type)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 415 (Unsupported Media Type)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 27,
            "name": "403 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 403 (Forbidden)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 403 (Forbidden)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 28,
            "name": "4XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 29,
            "name": "5XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 30,
            "name": "Other Hits",
            "type": "count",
            "description": "When a response code doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
            "dataType": "COUNT",
            "helpText": "When a response code doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 32,
            "name": "404 Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Size of the content (Object body) transferred to the client in case of 404 responses.",
            "dataType": "VOLUME",
            "helpText": "Size of the content (Object body) transferred to the client in case of 404 responses.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 33,
            "name": "404 Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "err_404_overbytes",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 34,
            "name": "Netstorage Hits",
            "type": "count",
            "description": "All hits from the edge servers to the Netstorage domain.",
            "dataType": "COUNT",
            "helpText": "All hits from the edge servers to the Netstorage domain.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 35,
            "name": "Netstorage Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "The total bytes transferred from the NetStorage domain to the edge servers.",
            "dataType": "VOLUME",
            "helpText": "The total bytes transferred from the NetStorage domain to the edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 165,
            "name": "Download Starts",
            "type": "count",
            "description": "Number of times the download was successfully initiated during a specific time interval.",
            "dataType": "COUNT",
            "helpText": "Number of times the download was successfully initiated during a specific time interval.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 166,
            "name": "Origin Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred from the origin to the Edge server. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred from the origin to the Edge server. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 167,
            "name": "Ingress Hits",
            "type": "count",
            "description": "All the hits from the edge server to origin, this includes customer origin and NetStorage.",
            "dataType": "COUNT",
            "helpText": "All the hits from the edge server to origin, this includes customer origin and NetStorage.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 168,
            "name": "Ingress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes NetStorage and customer origin.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes NetStorage and customer origin.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 41,
            "name": "Client Assisted Unicast Error Hits",
            "type": "count",
            "description": "cad_error_hits",
            "dataType": "COUNT",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 169,
            "name": "Offload (Hits)",
            "unit": "%",
            "type": "percent",
            "description": "Percentage of hits from the edge servers as compared to the hits from the origin server, including NetStorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
            "dataType": "PERCENT",
            "helpText": "Percentage of hits from the edge servers as compared to the hits from the origin server, including NetStorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 170,
            "name": "Offload (Volume)",
            "unit": "%",
            "type": "percent",
            "description": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including NetStorage and customer origin.\nThis metric displays accurate values only for CP codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP codes that use 'Media Services Live' or 'Media Services On Demand'.",
            "dataType": "PERCENT",
            "helpText": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including netstorage and customer origin.\nThis metric displays accurate values only for CP codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP codes that use 'Media Services Live' or 'Media Services On Demand'.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 47,
            "name": "Prefetch Midgress Count",
            "type": "count",
            "description": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
            "dataType": "COUNT",
            "helpText": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 48,
            "name": "Prefetch Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
            "dataType": "VOLUME",
            "helpText": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 186,
            "name": "Ingress Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Ingress Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Ingress Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 453,
            "name": "Midgress Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Midgress Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Midgress Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 454,
            "name": "Edge Hits/sec",
            "type": "count",
            "description": "Edge Hits/sec",
            "dataType": "COUNT",
            "helpText": "Edge Hits/sec",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 455,
            "name": "Midgress Hits/sec",
            "type": "count",
            "description": "Midgress Hits/sec",
            "dataType": "COUNT",
            "helpText": "Midgress Hits/sec",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 456,
            "name": "Ingress Hits/sec",
            "type": "count",
            "description": "Ingress Hits/sec",
            "dataType": "COUNT",
            "helpText": "Ingress Hits/sec",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 219,
            "name": "Edge Error Rate",
            "unit": "%",
            "type": "percent",
            "description": "Edge Error Rate",
            "dataType": "PERCENT",
            "helpText": "Edge Error Rate",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 221,
            "name": "Edge Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Edge Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Edge Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 102,
            "name": "Edge Errors",
            "type": "count",
            "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "dataType": "COUNT",
            "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 103,
            "name": "Edge Throughput",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
            "dataType": "BANDWIDTH",
            "helpText": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 107,
            "name": "Edge Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 113,
            "name": "Download Requests",
            "type": "count",
            "description": "Number of download requests received from end user, during a specific time interval.",
            "dataType": "COUNT",
            "helpText": "Number of download requests received from end user, during a specific time interval.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 116,
            "name": "Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "midgress_bytes",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 118,
            "name": "Avg Download Time",
            "unit": "seconds",
            "type": "time",
            "description": "download time for OCP",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 300,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

Get Download Delivery data

Gets Download Delivery data for the given parameters.

GET /media-delivery-reports/v1/download-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryOption,mediaAcceleration,ipVersion,enableCPCodeName}

Sample: /media-delivery-reports/v1/download-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&cpcodes=12345%2C67890&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%22values%22%3A%5B%22GB%22%5D%2C%22id%22%3A4%2C%22condition%22%3A%22in%22%7D%2C%7B%22type%22%3A%22metric%22%2C%22values%22%3A%5B16%5D%2C%22id%22%3A155%2C%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%22order%22%3A%22asc%22%2C%22id%22%3A40%7D%5D&deliveryOption=non-secure&mediaAcceleration=all&ipVersion=all&enableCPCodeName=true

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation String month The time period for which to group each data record, either expressed as number of seconds or as keyword values day, week, month, or year. By default, reports for data ranging less than a day aggregate in five minute intervals. For up to 12 days, data aggregates hourly. For up to 30 days, data aggregates daily.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryOption Enumeration non-secure Limits data to the type of traffic, non-secure for non-secure traffic, secure-shared for secure shared-certificate traffic, secure-standard for standard secure customer-certificate traffic, secure-premium for premimum secure customer-certificate traffic, or the default all. The paramater continues to support the older options, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it is best to use the newer options.
enableCPCodeName Boolean true If set to true, it returns the CP code along with its name.
filterParams String [{"type":"dimension","values":["GB"],"id":4,"condition":"in"},{"type":"metric","values":[16],"id":155,"condition":"gt"}] A UTF–8 URL-encoded JSON object representing filter parameters that limit reported data. See the FilterParams object for details on its structure.
ipVersion Enumeration all Limit reported data per IP version, ipv4, ipv6, or the default all for either version.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
mediaAcceleration Enumeration all Limit reported data to media that is accelerated or nonaccelerated, or specify the default all for unlimited data.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{"type":"metric","order":"asc","id":40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure. When no sortParams are specified, the response is sorted chronologically for time based queries, or otherwise on the first metric.

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Visitors"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Download Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

Get Download Delivery real-time data

This gets real-time data available at a latency of under 15 minutes.

GET /media-delivery-reports/v1/download-delivery/realtime-data{?dimensions,metrics,startDate,endDate,limit,offset,reduce,aggregation}

Sample: /media-delivery-reports/v1/download-delivery/realtime-data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&limit=300&offset=0&reduce=false&aggregation=3600

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation Number 3600 The time period for which to group each data record, expressed as number of seconds. Note that acceptable values for this endpoint are 300, 3600, and 86400.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
reduce Boolean false If set to true, it returns aggregated data

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Visitors"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Download Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

List Object Delivery data stores

A data store is a collection of dimensions and metrics stored in a database that you can use to create a sub-set and configure reports suited to your requirements. Data store details help you determine the combination of dimensions and metrics to query. Each report pack comes with its standard data stores. You cannot combine dimensions and metrics across data stores.

GET /media-delivery-reports/v1/object-delivery/data-stores

Status 200 application/json

Response Body:

[
    {
        "id": 32,
        "name": "Usage",
        "type": "standard",
        "description": "As part of this data store, Metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), and Edge Responses are available by dimensions like Time, CP Code, Content Type, File Extension, and File Size Bucket. Data is available at a minimum granualrity of 1 day.",
        "dimensions": [
            {
                "id": 1,
                "name": "Time",
                "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 2,
                "name": "CPCode",
                "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 18,
                "name": "Content Type",
                "description": "The value of the HTTP content type header served to the client.",
                "helpText": "The value of the HTTP content type header served to the client.",
                "dataType": "ENCODED",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 19,
                "name": "File Extension",
                "description": "File extension of the object requested. This is extracted from the URL of the requested object.",
                "helpText": "File extension of the object requested. This is extracted from the URL of the requested object.",
                "dataType": "ENCODED",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 6,
                "name": "File Size Bucket",
                "description": "The number of bytes and the size of objects requested categorized in buckets of various sizes.",
                "helpText": "The number of bytes and the size of objects requested categorized in buckets of various sizes.",
                "dataType": "STRING",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 4,
                "name": "Edge Hits",
                "type": "count",
                "description": "All hits to the edge servers from the end-users.",
                "dataType": "COUNT",
                "helpText": "All hits to the edge servers from the end-users.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 457,
                "name": "Midgress Bandwidth",
                "type": "Mbps",
                "description": "Midgress Bandwidth",
                "dataType": "NUMBER",
                "helpText": "Midgress Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 9,
                "name": "Midgress Hits",
                "type": "count",
                "description": "Midgress traffic includes hits from edge servers to other edge servers.",
                "dataType": "COUNT",
                "helpText": "Midgress traffic includes hits from edge servers to other edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 458,
                "name": "Origin Bandwidth",
                "type": "Mbps",
                "description": "Origin Bandwidth",
                "dataType": "NUMBER",
                "helpText": "Origin Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 12,
                "name": "Customer Origin Hits",
                "type": "count",
                "description": "All hits on the origin servers from Edge-servers.",
                "dataType": "COUNT",
                "helpText": "All hits on the origin servers from Edge-servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 21,
                "name": "2XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 24,
                "name": "3XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 25,
                "name": "404 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned the response code - 400 (File not Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned the response code - 400 (File not Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 219,
                "name": "Edge Error Rate",
                "unit": "%",
                "type": "percent",
                "description": "Edge Error Rate",
                "dataType": "PERCENT",
                "helpText": "Edge Error Rate",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 28,
                "name": "4XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 29,
                "name": "5XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 222,
                "name": "Edge Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Edge Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Edge Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 34,
                "name": "Netstorage Hits",
                "type": "count",
                "description": "All hits from the edge servers to the Netstorage domain.",
                "dataType": "COUNT",
                "helpText": "All hits from the edge servers to the Netstorage domain.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 35,
                "name": "Netstorage Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "The total bytes transferred from the netstorage domain to the edge servers.",
                "dataType": "VOLUME",
                "helpText": "The total bytes transferred from the netstorage domain to the edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 102,
                "name": "Edge Errors",
                "type": "count",
                "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "dataType": "COUNT",
                "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 167,
                "name": "Origin Hits",
                "type": "count",
                "description": "All the hits from the edge server to origin, this includes customer origin and netstorage.",
                "dataType": "COUNT",
                "helpText": "All the hits from the edge server to origin, this includes customer origin and netstorage.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 171,
                "name": "Customer Origin Volume",
                "unit": "GB",
                "type": "count",
                "description": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
                "dataType": "COUNT",
                "helpText": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 43,
                "name": "Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total object bytes transferred from one edge server to another edge server.",
                "dataType": "VOLUME",
                "helpText": "Total object bytes transferred from one edge server to another edge server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 44,
                "name": "Edge Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred between the edge to the end user. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred between the edge to the end user. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 172,
                "name": "Origin Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes, including overhead bytes, transferred from the origin to the edge server. This includes netstorage and customer origin.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes, including overhead bytes, transferred from the origin to the edge server. This includes netstorage and customer origin.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get an Object Delivery data store

This fetches the list of dimensions, metrics, the aggregation interval, purge interval, maximum allowed query interval, and other data store details.

GET /media-delivery-reports/v1/object-delivery/data-stores/{dataStoreId}

Sample: /media-delivery-reports/v1/object-delivery/data-stores/307

Parameter Type Sample Description
URL parameters
dataStoreId Integer 307 Data store ID. Uniquely identifies each data store.

Status 200 application/json

Response Body:

{
    "id": 32,
    "name": "Usage",
    "type": "standard",
    "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), and Edge Responses are available by dimensions like Time, CP Code, Content Type, File Extension, and File Size Bucket. Data is available at a minimum granularity of 1 day.",
    "dimensions": [
        {
            "id": 1,
            "name": "Time",
            "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 2,
            "name": "CPCode",
            "description": "Content Provider code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "helpText": "Content Provider code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 18,
            "name": "Content Type",
            "description": "The value of the HTTP content type header served to the client.",
            "helpText": "The value of the HTTP content type header served to the client.",
            "dataType": "ENCODED",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 19,
            "name": "File Extension",
            "description": "File extension of the object requested. This is extracted from the URL of the requested object.",
            "helpText": "File extension of the object requested. This is extracted from the URL of the requested object.",
            "dataType": "ENCODED",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 6,
            "name": "File Size Bucket",
            "description": "The number of bytes and the size of objects requested, categorized in buckets of various sizes.",
            "helpText": "The number of bytes and the size of objects requested, categorized in buckets of various sizes.",
            "dataType": "STRING",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 4,
            "name": "Edge Hits",
            "type": "count",
            "description": "All hits to the Edge servers from the end users.",
            "dataType": "COUNT",
            "helpText": "All hits to the Edge servers from the end users.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 457,
            "name": "Midgress Bandwidth",
            "type": "Mbps",
            "description": "Midgress Bandwidth",
            "dataType": "NUMBER",
            "helpText": "Midgress Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 9,
            "name": "Midgress Hits",
            "type": "count",
            "description": "Midgress traffic includes hits from Edge servers to other Edge servers.",
            "dataType": "COUNT",
            "helpText": "Midgress traffic includes hits from Edge servers to other Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 458,
            "name": "Origin Bandwidth",
            "type": "Mbps",
            "description": "Origin Bandwidth",
            "dataType": "NUMBER",
            "helpText": "Origin Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 12,
            "name": "Customer Origin Hits",
            "type": "count",
            "description": "All hits on the origin servers from Edges ervers.",
            "dataType": "COUNT",
            "helpText": "All hits on the origin servers from Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 21,
            "name": "2XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 24,
            "name": "3XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 25,
            "name": "404 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned the response code - 400 (File not Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned the response code - 400 (File not Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 219,
            "name": "Edge Error Rate",
            "unit": "%",
            "type": "percent",
            "description": "Edge Error Rate",
            "dataType": "PERCENT",
            "helpText": "Edge Error Rate",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 28,
            "name": "4XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 29,
            "name": "5XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 222,
            "name": "Edge Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Edge Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Edge Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 34,
            "name": "Netstorage Hits",
            "type": "count",
            "description": "All hits from the edge servers to the Netstorage domain.",
            "dataType": "COUNT",
            "helpText": "All hits from the edge servers to the Netstorage domain.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 35,
            "name": "Netstorage Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "The total bytes transferred from the NetStorage domain to the Edge servers.",
            "dataType": "VOLUME",
            "helpText": "The total bytes transferred from the NetStorage domain to the Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 102,
            "name": "Edge Errors",
            "type": "count",
            "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "dataType": "COUNT",
            "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 167,
            "name": "Origin Hits",
            "type": "count",
            "description": "All the hits from the edge server to origin, this includes customer origin and NetStorage.",
            "dataType": "COUNT",
            "helpText": "All the hits from the edge server to origin, this includes customer origin and NetStorage.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 171,
            "name": "Customer Origin Volume",
            "unit": "GB",
            "type": "count",
            "description": "Total number of megabytes transferred from the origin to the Edge server. Overhead bytes are included.",
            "dataType": "COUNT",
            "helpText": "Total number of megabytes transferred from the origin to the Edge server. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 43,
            "name": "Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total object bytes transferred from one Edge server to another Edge server.",
            "dataType": "VOLUME",
            "helpText": "Total object bytes transferred from one Edge server to another Edge server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 44,
            "name": "Edge Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 172,
            "name": "Origin Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes, including overhead bytes, transferred from the origin to the edge server. This includes NetStorage and customer origin.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes, including overhead bytes, transferred from the origin to the edge server. This includes NetStorage and customer origin.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 86400,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

Get Object Delivery data

Retrieves Object Delivery data for the given parameters.

GET /media-delivery-reports/v1/object-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,filterParams,sortParams,mediaAcceleration,enableCPCodeName}

Sample: /media-delivery-reports/v1/object-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&cpcodes=12345%2C67890&limit=300&offset=0&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%22values%22%3A%5B%22GB%22%5D%2C%22id%22%3A4%2C%22condition%22%3A%22in%22%7D%2C%7B%22type%22%3A%22metric%22%2C%22values%22%3A%5B16%5D%2C%22id%22%3A155%2C%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%22order%22%3A%22asc%22%2C%22id%22%3A40%7D%5D&mediaAcceleration=all&enableCPCodeName=true

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
enableCPCodeName Boolean true If set to true, it returns the CP code along with its name.
filterParams String [{"type":"dimension","values":["GB"],"id":4,"condition":"in"},{"type":"metric","values":[16],"id":155,"condition":"gt"}] A UTF–8 URL-encoded JSON object representing filter parameters that limit reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
mediaAcceleration Enumeration all Limit reported data to media that is accelerated or nonaccelerated, or specify the default all for unlimited data.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{"type":"metric","order":"asc","id":40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure. When no sortParams are specified, the response is sorted chronologically for time based queries, or otherwise on the first metric.

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Visitors"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Download Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

List Adaptive Media Delivery data stores

A data store is a collection of dimensions and metrics stored in a database that you can use to create a sub-set and configure reports suited to your requirements. Data store details help you determine the combination of dimensions and metrics to query. Each report pack comes with its standard data stores. You cannot combine dimensions and metrics across data stores.

GET /media-delivery-reports/v1/adaptive-media-delivery/data-stores

Status 200 application/json

Response Body:

[
    {
        "id": 14,
        "name": "Statistics",
        "type": "standard",
        "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), Offload, and Edge Responses are available by Time and CP Code dimensions. Data is available at a minimum granularity of 5 minutes.",
        "dimensions": [
            {
                "id": 1,
                "name": "Time",
                "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 2,
                "name": "CPCode",
                "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 2,
                "name": "Edge + Midgress",
                "unit": "GB",
                "type": "volume",
                "description": "Sum of Edge And Midgress Volume",
                "dataType": "VOLUME",
                "helpText": "Sum of Edge And Midgress Volume",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 4,
                "name": "Edge Hits",
                "type": "count",
                "description": "All hits to the edge servers from the end-users.",
                "dataType": "COUNT",
                "helpText": "All hits to the edge servers from the end-users.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 5,
                "name": "Edge Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Size of the actual content (Object body) transferred to the client.",
                "dataType": "VOLUME",
                "helpText": "Size of the actual content (Object body) transferred to the client.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 6,
                "name": "Edge Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the Edge-server to the end-user",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the Edge-server to the end-user",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 7,
                "name": "Edge Cached Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
                "dataType": "VOLUME",
                "helpText": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 8,
                "name": "Edge Secure Volume",
                "unit": "bytes",
                "type": "volume",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 9,
                "name": "Midgress Hits",
                "type": "count",
                "description": "Midgress traffic includes hits from edge servers to other edge servers.",
                "dataType": "COUNT",
                "helpText": "Midgress traffic includes hits from edge servers to other edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10,
                "name": "Midgress Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total object bytes transferred from one Edge server to another Edge server.",
                "dataType": "VOLUME",
                "helpText": "Total object bytes transferred from one Edge server to another Edge server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 11,
                "name": "Midgress Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 12,
                "name": "Customer Origin Hits",
                "type": "count",
                "description": "All hits on the origin servers from Edge-servers.",
                "dataType": "COUNT",
                "helpText": "All hits on the origin servers from Edge-servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 13,
                "name": "Customer Origin Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total object bytes transferred from the customer origin server to the Edge servers.",
                "dataType": "VOLUME",
                "helpText": "Total object bytes transferred from the customer origin server to the Edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 14,
                "name": "Customer Origin Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the origin server to the Edge server.",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the origin server to the Edge server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 18,
                "name": "0XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes- 0xx (Client Abort)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes- 0xx (Client Abort)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 19,
                "name": "200 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 200 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 200 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 20,
                "name": "206 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 206 (Partial Content)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 206 (Partial Content)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 21,
                "name": "2XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 22,
                "name": "302 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 23,
                "name": "304 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 24,
                "name": "3XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 25,
                "name": "404 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned the response code - 400 (File not Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned the response code - 400 (File not Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 26,
                "name": "415 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 415 (Unsupported Media Type)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 415 (Unsupported Media Type)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 27,
                "name": "403 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 403 (Forbidden)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 403 (Forbidden)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 28,
                "name": "4XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 29,
                "name": "5XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 30,
                "name": "Other Hits",
                "type": "count",
                "description": "When a response code received doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
                "dataType": "COUNT",
                "helpText": "When a response code received doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 32,
                "name": "404 Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Size of the content (Object body) transferred to the client in case of 404 responses.",
                "dataType": "VOLUME",
                "helpText": "Size of the content (Object body) transferred to the client in case of 404 responses.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 33,
                "name": "404 Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "err_404_overbytes",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 34,
                "name": "Netstorage Hits",
                "type": "count",
                "description": "All hits from the edge servers to the Netstorage domain.",
                "dataType": "COUNT",
                "helpText": "All hits from the edge servers to the Netstorage domain.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 35,
                "name": "Netstorage Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "The total bytes transferred from the netstorage domain to the edge servers.",
                "dataType": "VOLUME",
                "helpText": "The total bytes transferred from the netstorage domain to the edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 164,
                "name": "Edge Plays",
                "type": "count",
                "description": "Number of times the media was successfully played during a specific time interval.This information is based on successful manifest requests.",
                "dataType": "COUNT",
                "helpText": "Number of times the media was successfully played during a specific time interval.This information is based on successful manifest requests.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 166,
                "name": "Customer Origin Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 167,
                "name": "Origin Hits",
                "type": "count",
                "description": "All the hits from the edge server to origin, this includes customer origin and netstorage.",
                "dataType": "COUNT",
                "helpText": "All the hits from the edge server to origin, this includes customer origin and netstorage.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 168,
                "name": "Origin Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes netstorage and customer origin.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes netstorage and customer origin.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 169,
                "name": "Offload (Hits)",
                "unit": "%",
                "type": "percent",
                "description": "Percentage of hits from the edge servers as compared to the hits from the origin server, including netstorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
                "dataType": "PERCENT",
                "helpText": "Percentage of hits from the edge servers as compared to the hits from the origin server, including netstorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 170,
                "name": "Offload (Volume)",
                "unit": "%",
                "type": "percent",
                "description": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including netstorage and customer origin.\nThis metric displays accurate values only for CP Codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP Codes that use 'Media Services Live' or 'Media Services On Demand'.",
                "dataType": "PERCENT",
                "helpText": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including netstorage and customer origin.\nThis metric displays accurate values only for CP Codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP Codes that use 'Media Services Live' or 'Media Services On Demand'.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 47,
                "name": "Prefetch Midgress Count",
                "type": "count",
                "description": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
                "dataType": "COUNT",
                "helpText": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 48,
                "name": "Prefetch Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
                "dataType": "VOLUME",
                "helpText": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 49,
                "name": "Edge Streaming Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes of inter-media format fragments transferred from Parent Server to an Edge server. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes of inter-media format fragments transferred from Parent Server to an Edge server. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 186,
                "name": "Origin Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Ingress Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Ingress Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 453,
                "name": "Midgress Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Midgress Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Midgress Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 454,
                "name": "Edge Hits/sec",
                "type": "count",
                "description": "Edge Hits/sec",
                "dataType": "COUNT",
                "helpText": "Edge Hits/sec",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 455,
                "name": "Midgress Hits/sec",
                "type": "count",
                "description": "Midgress Hits/sec",
                "dataType": "COUNT",
                "helpText": "Midgress Hits/sec",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 456,
                "name": "Ingress Hits/sec",
                "type": "count",
                "description": "Ingress Hits/sec",
                "dataType": "COUNT",
                "helpText": "Ingress Hits/sec",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 219,
                "name": "Edge Error Rate",
                "unit": "%",
                "type": "percent",
                "description": "Edge Error Rate",
                "dataType": "PERCENT",
                "helpText": "Edge Error Rate",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 221,
                "name": "Edge Bandwidth",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Edge Bandwidth",
                "dataType": "BANDWIDTH",
                "helpText": "Edge Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 102,
                "name": "Edge Errors",
                "type": "count",
                "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "dataType": "COUNT",
                "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 103,
                "name": "Edge Throughput",
                "unit": "Mbps",
                "type": "bandwidth",
                "description": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
                "dataType": "BANDWIDTH",
                "helpText": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 105,
                "name": "Edge Attempts",
                "type": "count",
                "description": "Number of times end-user attempted to play the media, during a specific time interval.This information is based on the total manifest requests received.",
                "dataType": "COUNT",
                "helpText": "Number of times end-user attempted to play the media, during a specific time interval.This information is based on the total manifest requests received.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 107,
                "name": "Edge Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 116,
                "name": "Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "midgress_bytes",
                "dataType": "VOLUME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 118,
                "name": "Avg Download Time",
                "unit": "seconds",
                "type": "time",
                "description": "download time for OCP",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 300,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get an Adaptive Media Delivery data store

This gets the list of dimensions, metrics, the aggregation interval, purge interval, maximum allowed query interval and other data store details.

GET /media-delivery-reports/v1/adaptive-media-delivery/data-stores/{dataStoreId}

Sample: /media-delivery-reports/v1/adaptive-media-delivery/data-stores/307

Parameter Type Sample Description
URL parameters
dataStoreId Integer 307 The ID of the data store. Uniquely identifies it.

Status 200 application/json

Response Body:

{
    "id": 14,
    "name": "Statistics",
    "type": "standard",
    "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), Offload, and Edge Responses are available by Time and CP Code dimensions. Data is available at a minimum granularity of 5 minutes.",
    "dimensions": [
        {
            "id": 1,
            "name": "Time",
            "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 2,
            "name": "CPCode",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 2,
            "name": "Edge + Midgress",
            "unit": "GB",
            "type": "volume",
            "description": "Sum of Edge And Midgress Volume",
            "dataType": "VOLUME",
            "helpText": "Sum of Edge And Midgress Volume",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 4,
            "name": "Edge Hits",
            "type": "count",
            "description": "All hits to the edge servers from the end-users.",
            "dataType": "COUNT",
            "helpText": "All hits to the edge servers from the end-users.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 5,
            "name": "Edge Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Size of the actual content (Object body) transferred to the client.",
            "dataType": "VOLUME",
            "helpText": "Size of the actual content (Object body) transferred to the client.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 6,
            "name": "Edge Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the Edge-server to the end-user",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the Edge-server to the end-user",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 7,
            "name": "Edge Cached Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
            "dataType": "VOLUME",
            "helpText": "Total bytes delivered from the Edge servers in which content was not served from the parent ghost or origin server..",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 8,
            "name": "Edge Secure Volume",
            "unit": "bytes",
            "type": "volume",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 9,
            "name": "Midgress Hits",
            "type": "count",
            "description": "Midgress traffic includes hits from Edge servers to other Edge servers.",
            "dataType": "COUNT",
            "helpText": "Midgress traffic includes hits from Edge servers to other Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10,
            "name": "Midgress Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total object bytes transferred from one Edge server to another Edge server.",
            "dataType": "VOLUME",
            "helpText": "Total object bytes transferred from one Edge server to another Edge server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 11,
            "name": "Midgress Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes, and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include Request bytes, TCP/IP overhead bytes, Ethernet bytes, and UDP/IP overhead bytes served from the one Edge-server to another Edge-server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 12,
            "name": "Customer Origin Hits",
            "type": "count",
            "description": "All hits on the origin servers from Edge servers.",
            "dataType": "COUNT",
            "helpText": "All hits on the origin servers from Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 13,
            "name": "Customer Origin Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total object bytes transferred from the customer origin server to the Edge servers.",
            "dataType": "VOLUME",
            "helpText": "Total object bytes transferred from the customer origin server to the Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 14,
            "name": "Customer Origin Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the origin server to the Edge server.",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the origin server to the Edge server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 18,
            "name": "0XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code- 0xx (Client Abort)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code- 0xx (Client Abort)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 19,
            "name": "200 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 200 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 200 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 20,
            "name": "206 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 206 (Partial Content)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 206 (Partial Content)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 21,
            "name": "2XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 22,
            "name": "302 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 23,
            "name": "304 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 304 (Redirection Status Code - Not Modified)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 304 (Redirection Status Code - Not Modified)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 24,
            "name": "3XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 300 to 399 (Redirection)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 300 to 399 (Redirection)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 25,
            "name": "404 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned the response code - 400 (File not Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned the response code - 400 (File not Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 26,
            "name": "415 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 415 (Unsupported Media Type)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 415 (Unsupported Media Type)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 27,
            "name": "403 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 403 (Forbidden)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 403 (Forbidden)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 28,
            "name": "4XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 29,
            "name": "5XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 30,
            "name": "Other Hits",
            "type": "count",
            "description": "When a response code doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
            "dataType": "COUNT",
            "helpText": "When a response code doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 32,
            "name": "404 Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Size of the content (Object body) transferred to the client in case of 404 responses.",
            "dataType": "VOLUME",
            "helpText": "Size of the content (Object body) transferred to the client in case of 404 responses.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 33,
            "name": "404 Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "err_404_overbytes",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 34,
            "name": "Netstorage Hits",
            "type": "count",
            "description": "All hits from the edge servers to the NetStorage domain.",
            "dataType": "COUNT",
            "helpText": "All hits from the edge servers to the NetStorage domain.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 35,
            "name": "Netstorage Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "The total bytes transferred from the NetStorage domain to the Edge servers.",
            "dataType": "VOLUME",
            "helpText": "The total bytes transferred from the NetStorage domain to the Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 164,
            "name": "Edge Plays",
            "type": "count",
            "description": "Number of times the media was successfully played during a specific time interval. This information is based on successful manifest requests.",
            "dataType": "COUNT",
            "helpText": "Number of times the media was successfully played during a specific time interval. This information is based on successful manifest requests.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 166,
            "name": "Customer Origin Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred from the origin to the Edge-server. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 167,
            "name": "Origin Hits",
            "type": "count",
            "description": "All the hits from the Edge server to origin, this includes customer origin and NetStorage.",
            "dataType": "COUNT",
            "helpText": "All the hits from the Edge server to origin, this includes customer origin and NetStorage.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 168,
            "name": "Origin Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes NetStorage and customer origin.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes, including overhead bytes, transferred from the origin to the Edge-server. This includes NetStorage and customer origin.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 169,
            "name": "Offload (Hits)",
            "unit": "%",
            "type": "percent",
            "description": "Percentage of hits from the Edge servers as compared to the hits from the origin server, including NetStorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
            "dataType": "PERCENT",
            "helpText": "Percentage of hits from the edge servers as compared to the hits from the origin server, including NetStorage and customer origin. (Edge Hits - Ingress Hits) / Edge Hits * 100",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 170,
            "name": "Offload (Volume)",
            "unit": "%",
            "type": "percent",
            "description": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including NetStorage and customer origin. \nThis metric displays accurate values only for CP codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP codes that use 'Media Services Live' or 'Media Services On Demand'.",
            "dataType": "PERCENT",
            "helpText": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from origin server, including NetStorage and customer origin.\nThis metric displays accurate values only for CP codes that use Adaptive Media Delivery configuration. The metric displays incorrect values for CP codes that use 'Media Services Live' or 'Media Services On Demand'.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 47,
            "name": "Prefetch Midgress Count",
            "type": "count",
            "description": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
            "dataType": "COUNT",
            "helpText": "Total number of hits from an Edge Server to a parent Edge server (not origin) to prefetch content.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 48,
            "name": "Prefetch Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
            "dataType": "VOLUME",
            "helpText": "Total Bytes transferred from Parent server to an Edge server when content is prefetched.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 49,
            "name": "Edge Streaming Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes of inter-media format fragments transferred from Parent Server to an Edge server. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes of inter-media format fragments transferred from Parent Server to an Edge server. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 186,
            "name": "Origin Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Ingress Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Ingress Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 453,
            "name": "Midgress Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Midgress Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Midgress Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 454,
            "name": "Edge Hits/sec",
            "type": "count",
            "description": "Edge Hits/sec",
            "dataType": "COUNT",
            "helpText": "Edge Hits/sec",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 455,
            "name": "Midgress Hits/sec",
            "type": "count",
            "description": "Midgress Hits/sec",
            "dataType": "COUNT",
            "helpText": "Midgress Hits/sec",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 456,
            "name": "Ingress Hits/sec",
            "type": "count",
            "description": "Ingress Hits/sec",
            "dataType": "COUNT",
            "helpText": "Ingress Hits/sec",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 219,
            "name": "Edge Error Rate",
            "unit": "%",
            "type": "percent",
            "description": "Edge Error Rate",
            "dataType": "PERCENT",
            "helpText": "Edge Error Rate",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 221,
            "name": "Edge Bandwidth",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Edge Bandwidth",
            "dataType": "BANDWIDTH",
            "helpText": "Edge Bandwidth",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 102,
            "name": "Edge Errors",
            "type": "count",
            "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "dataType": "COUNT",
            "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 103,
            "name": "Edge Throughput",
            "unit": "Mbps",
            "type": "bandwidth",
            "description": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
            "dataType": "BANDWIDTH",
            "helpText": "Rate of successful delivery of media from the Edge server. It is calculated as the total bytes delivered divided by the total time taken by ghost to serve the request.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 105,
            "name": "Edge Attempts",
            "type": "count",
            "description": "Number of times end-user attempted to play the media, during a specific time interval. This information is based on the total manifest requests received.",
            "dataType": "COUNT",
            "helpText": "Number of times end-user attempted to play the media, during a specific time interval. This information is based on the total manifest requests received.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 107,
            "name": "Edge Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 116,
            "name": "Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "midgress_bytes",
            "dataType": "VOLUME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 118,
            "name": "Avg Download Time",
            "unit": "seconds",
            "type": "time",
            "description": "download time for OCP",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 300,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

Get Adaptive Media Delivery data

This gets Adaptive Media Delivery data for the parameters given below:

GET /media-delivery-reports/v1/adaptive-media-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryOption,deliveryType,deliveryFormat,mediaAcceleration,mediaEncryption,ipVersion,enableCPCodeName}

Sample: /media-delivery-reports/v1/adaptive-media-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&cpcodes=12345%2C67890&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%22values%22%3A%5B%22GB%22%5D%2C%22id%22%3A4%2C%22condition%22%3A%22in%22%7D%2C%7B%22type%22%3A%22metric%22%2C%22values%22%3A%5B16%5D%2C%22id%22%3A155%2C%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%22order%22%3A%22asc%22%2C%22id%22%3A40%7D%5D&deliveryOption=non-secure&deliveryType=all&deliveryFormat=all&mediaAcceleration=all&mediaEncryption=all&ipVersion=all&enableCPCodeName=true

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation String month The time period for which to group each data record, either expressed as number of seconds or as keyword values day, week, month, or year. By default, reports for data ranging less than a day aggregate in five minute intervals. For up to 12 days, data aggregates hourly. For up to 30 days, data aggregates daily.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryFormat Enumeration all Report on sp_hds for stream packaging HDS, sp_hls for stream packaging HLS, pt_hls for HLS, pt_hds for HDS, pt_dash for DASH, smooth for Microsoft Smooth Streaming, others, or the default all.
deliveryOption Enumeration non-secure Limits data to the type of traffic, non-secure for non-secure traffic, secure-shared for secure shared-certificate traffic, secure-standard for standard secure customer-certificate traffic, secure-premium for premimum secure customer-certificate traffic, or the default all. The paramater continues to support the older options, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it is best to use the newer options.
deliveryType Enumeration all Limit data to the context of media delivery, live, vod (video on demand), or the default all.
enableCPCodeName Boolean true If set to true, it returns the CP code along with its name.
filterParams String [{"type":"dimension","values":["GB"],"id":4,"condition":"in"},{"type":"metric","values":[16],"id":155,"condition":"gt"}] A UTF–8 URL-encoded JSON object representing filter parameters that limit reported data. See the FilterParams object for details on its structure.
ipVersion Enumeration all Limit reported data per IP version, ipv4, ipv6, or the default all for either version.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
mediaAcceleration Enumeration all Limit reported data to media that is accelerated or nonaccelerated, or specify the default all for unlimited data.
mediaEncryption Enumeration all Limit reported data to encrypted or unencrypted media, or specify the default all for unlimited data.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{"type":"metric","order":"asc","id":40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure. When no sortParams are specified, the response is sorted chronologically for time based queries, or otherwise on the first metric.

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Visitors"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Download Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

Get Adaptive Media Delivery real-time data

This gets real-time data that is available at a latency of under 15 minutes.

GET /media-delivery-reports/v1/adaptive-media-delivery/realtime-data{?dimensions,metrics,startDate,endDate,limit,offset,reduce,aggregation}

Sample: /media-delivery-reports/v1/adaptive-media-delivery/realtime-data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&limit=300&offset=0&reduce=false&aggregation=3600

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation Number 3600 The time period for which to group each data record, expressed as number of seconds. Note that acceptable values for this endpoint are 300, 3600, and 86400.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
reduce Boolean false If set to true, it returns aggregated data

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Visitors"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Download Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

List RTMP Media Delivery data stores

A data store is a collection of dimensions and metrics stored in a database that you can use to create a sub-set and configure reports suited to your requirements. Data store details help you determine the combination of dimensions and metrics to query. Each report pack comes with its standard data stores. You cannot combine dimensions, and metrics across data stores.

GET /media-delivery-reports/v1/rtmp-media-delivery/data-stores

Status 200 application/json

Response Body:

[
    {
        "id": 11,
        "name": "URL",
        "type": "standard",
        "description": "As part of this data store, metrics related to Hits(Edge), Volume(Edge), Viewing Time, Clip Play Time and Edge Responses are available by dimensions like Device, OS, and Player Id. Data is available at a minimum granularity of 1 day.",
        "dimensions": [
            {
                "id": 1,
                "name": "Time",
                "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 2,
                "name": "CPCode",
                "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing, and monitoring traffic served.",
                "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing, and monitoring traffic served.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 6,
                "name": "File Size Bucket",
                "description": "The number of bytes and the size of objects requested categorized in buckets of various sizes.",
                "helpText": "The number of bytes and the size of objects requested categorized in buckets of various sizes.",
                "dataType": "STRING",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 7,
                "name": "Device",
                "description": "Indicates the browser, applications or device used to consume the content. This information is derived from the user-agent information in the request.",
                "helpText": "Indicates the browser, applications or device used to consume the content. This information is derived from the user-agent information in the request.",
                "dataType": "ENCODED",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 8,
                "name": "OS",
                "description": "The operating system using which the viewer accesses your media.",
                "helpText": "The operating system using which the viewer accesses your media.",
                "dataType": "ENCODED",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 9,
                "name": "Network Type",
                "description": "The network connection type used by end-users to consume the content.",
                "helpText": "The network connection type used by end-users to consume the content.",
                "dataType": "STRING",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 21,
                "name": "URL",
                "description": "url",
                "dataType": "ENCODED",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 22,
                "name": "Player ID",
                "description": "player_id",
                "dataType": "STRING",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 65,
                "name": "Clip Playtime",
                "type": "time",
                "description": "Clip Playtime",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 66,
                "name": "Viewing Start Time",
                "type": "time",
                "description": "start_viewing_time",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 67,
                "name": "End Viewing Time",
                "type": "time",
                "description": "end_viewing_time",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 68,
                "name": "Active Count",
                "type": "count",
                "description": "active_count",
                "dataType": "COUNT",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 4,
                "name": "Edge Hits",
                "type": "count",
                "description": "All hits to the edge servers from the end-users.",
                "dataType": "COUNT",
                "helpText": "All hits to the edge servers from the end-users.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 5,
                "name": "Edge Object Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Size of the actual content (Object body) transferred to the client.",
                "dataType": "VOLUME",
                "helpText": "Size of the actual content (Object body) transferred to the client.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 6,
                "name": "Edge Overhead Volume",
                "unit": "bytes",
                "type": "volume",
                "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the Edge-server to the end-user",
                "dataType": "VOLUME",
                "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes, and UDP/IP overhead bytes served from the Edge-server to the end-user",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 72,
                "name": "401 Edge Hits",
                "type": "count",
                "description": "hits_401",
                "dataType": "COUNT",
                "helpText": "Server Response Code: 401 - Unauthorized",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 73,
                "name": "408 Edge Hits",
                "type": "count",
                "description": "hits_408",
                "dataType": "COUNT",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 74,
                "name": "6XX Edge Hits",
                "type": "count",
                "description": "hits_6xx",
                "dataType": "COUNT",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 18,
                "name": "0XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code- 0xx (Client Abort)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code- 0xx (Client Abort)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 19,
                "name": "200 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 200 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 200 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 20,
                "name": "206 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 206 (Partial Content)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 206 (Partial Content)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 21,
                "name": "2XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 22,
                "name": "302 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 23,
                "name": "304 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 304 (Redirection Status Code - Not Modified)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 304 (Redirection Status Code - Not Modified)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 24,
                "name": "3XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 25,
                "name": "404 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned the response code - 400 (File not Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned the response code - 400 (File not Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 28,
                "name": "4XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 29,
                "name": "5XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 225,
                "name": "Total Volume",
                "type": "count",
                "description": "Total Volume",
                "dataType": "COUNT",
                "helpText": "Total Volume",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 102,
                "name": "Edge Errors",
                "type": "count",
                "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "dataType": "COUNT",
                "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 107,
                "name": "Edge Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 3600,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get an RTMP Media Delivery data store

This fetches a list of dimensions, metrics, the aggregation interval, purge interval, maximum allowed query interval, and other data store details.

GET /media-delivery-reports/v1/rtmp-media-delivery/data-stores/{dataStoreId}

Sample: /media-delivery-reports/v1/rtmp-media-delivery/data-stores/307

Parameter Type Sample Description
URL parameters
dataStoreId Integer 307 Data store ID. Uniquely identifies the data source

Status 200 application/json

Response Body:

{
    "id": 11,
    "name": "URL",
    "type": "standard",
    "description": "As part of this data store, metrics related to Hits (Edge), Volume (Edge), Viewing Time, Clip Play Time and Edge Responses are available by dimensions like Device, OS, Player Id. Data is available at a minimum granularity of 1 day.",
    "dimensions": [
        {
            "id": 1,
            "name": "Time",
            "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 2,
            "name": "CPCode",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 6,
            "name": "File Size Bucket",
            "description": "The number of bytes and the size of objects requested categorized in buckets of various sizes.",
            "helpText": "The number of bytes and the size of objects requested categorized in buckets of various sizes.",
            "dataType": "STRING",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 7,
            "name": "Device",
            "description": "Indicates the browser, applications or device used to consume the content. This information is derived from the user-agent information in the request.",
            "helpText": "Indicates the browser, applications or device used to consume the content. This information is derived from the user-agent information in the request.",
            "dataType": "ENCODED",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 8,
            "name": "OS",
            "description": "The operating system using which the viewer accesses your media.",
            "helpText": "The operating system using which the viewer accesses your media.",
            "dataType": "ENCODED",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 9,
            "name": "Network Type",
            "description": "The network connection type used by end users to consume the content.",
            "helpText": "The network connection type used by end users to consume the content.",
            "dataType": "STRING",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 21,
            "name": "URL",
            "description": "url",
            "dataType": "ENCODED",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 22,
            "name": "Player ID",
            "description": "player_id",
            "dataType": "STRING",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 65,
            "name": "Clip Playtime",
            "type": "time",
            "description": "Clip Playtime",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 66,
            "name": "Viewing Start Time",
            "type": "time",
            "description": "start_viewing_time",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 67,
            "name": "End Viewing Time",
            "type": "time",
            "description": "end_viewing_time",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 68,
            "name": "Active Count",
            "type": "count",
            "description": "active_count",
            "dataType": "COUNT",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 4,
            "name": "Edge Hits",
            "type": "count",
            "description": "All hits to the edge servers from the end-users.",
            "dataType": "COUNT",
            "helpText": "All hits to the edge servers from the end-users.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 5,
            "name": "Edge Object Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Size of the actual content (Object body) transferred to the client.",
            "dataType": "VOLUME",
            "helpText": "Size of the actual content (Object body) transferred to the client.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 6,
            "name": "Edge Overhead Volume",
            "unit": "bytes",
            "type": "volume",
            "description": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the Edge server to the end user",
            "dataType": "VOLUME",
            "helpText": "Total number of protocol component bytes that include request bytes, TCP/IP overhead bytes, ethernet bytes and UDP/IP overhead bytes served from the Edge server to the end user",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 72,
            "name": "401 Edge Hits",
            "type": "count",
            "description": "hits_401",
            "dataType": "COUNT",
            "helpText": "Server Response Code: 401 - Unauthorized",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 73,
            "name": "408 Edge Hits",
            "type": "count",
            "description": "hits_408",
            "dataType": "COUNT",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 74,
            "name": "6XX Edge Hits",
            "type": "count",
            "description": "hits_6xx",
            "dataType": "COUNT",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 18,
            "name": "0XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes- 0xx (Client Abort)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes- 0xx (Client Abort)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 19,
            "name": "200 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 200 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 200 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 20,
            "name": "206 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 206 (Partial Content)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 206 (Partial Content)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 21,
            "name": "2XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 22,
            "name": "302 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 23,
            "name": "304 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 24,
            "name": "3XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 25,
            "name": "404 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned the response code - 400 (File not Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned the response code - 400 (File not Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 28,
            "name": "4XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 29,
            "name": "5XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 225,
            "name": "Total Volume",
            "type": "count",
            "description": "Total Volume",
            "dataType": "COUNT",
            "helpText": "Total Volume",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 102,
            "name": "Edge Errors",
            "type": "count",
            "description": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "dataType": "COUNT",
            "helpText": "Number of hits that resulted in error responses for your objects. It is the sum of all 4xx and 5xx hits.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 107,
            "name": "Edge Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred between the Edge to the end user. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 3600,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

Get RTMP Media Delivery data

Retrieves RTMP Media Delivery data for the given parameters.

GET /media-delivery-reports/v1/rtmp-media-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryType,enableCPCodeName}

Sample: /media-delivery-reports/v1/rtmp-media-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&cpcodes=12345%2C67890&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%22values%22%3A%5B%22GB%22%5D%2C%22id%22%3A4%2C%22condition%22%3A%22in%22%7D%2C%7B%22type%22%3A%22metric%22%2C%22values%22%3A%5B16%5D%2C%22id%22%3A155%2C%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%22order%22%3A%22asc%22%2C%22id%22%3A40%7D%5D&deliveryType=all&enableCPCodeName=true

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation String month The time period for which to group each data record, either expressed as number of seconds or as keyword values day, week, month, or year. By default, reports for data ranging less than a day aggregate in five minute intervals. For up to 12 days, data aggregates hourly. For up to 30 days, data aggregates daily.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryType Enumeration all Limit data to the context of media delivery, live, vod (video on demand), or the default all.
enableCPCodeName Boolean true If set to true, it returns the CP code along with its name.
filterParams String [{"type":"dimension","values":["GB"],"id":4,"condition":"in"},{"type":"metric","values":[16],"id":155,"condition":"gt"}] A UTF–8 URL-encoded JSON object representing filter parameters that limit reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{"type":"metric","order":"asc","id":40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure. When no sortParams are specified, the response is sorted chronologically for time based queries, or otherwise on the first metric.

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Visitors"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Download Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

List Wholesale Delivery data stores

A data store is a collection of dimensions and metrics stored in a database that you can use to create a sub-set and configure reports suited to your requirements. Data store details help you determine the combination of dimensions and metrics to query. Each report pack comes with its standard data stores. You cannot combine dimensions and metrics across data stores.

GET /media-delivery-reports/v1/wholesale-delivery/data-stores

Status 200 application/json

Response Body:

[
    {
        "id": 37,
        "name": "Sub Customer Info",
        "type": "standard",
        "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), Offload, and Edge Responses are available by Sub Customer ID. Data is available at a minimum granularity of 1 hour.",
        "dimensions": [
            {
                "id": 1,
                "name": "Time",
                "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 2,
                "name": "CPCode",
                "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing, and monitoring of traffic served.",
                "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing, and monitoring of traffic served.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 25,
                "name": "Sub Customer ID",
                "description": "The sub-customer ID. A sub-customer is a customer of Akamai's media delivery services cloud partner, and is not contracted with Akamai directly.",
                "helpText": "The sub-customer ID. A sub-customer is a customer of Akamai's media delivery services cloud partner, and is not contracted with Akamai directly.",
                "dataType": "STRING",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 4,
                "name": "Edge Hits",
                "type": "count",
                "description": "All hits to the edge servers from the end-users.",
                "dataType": "COUNT",
                "helpText": "All hits to the edge servers from the end-users.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 9,
                "name": "Midgress Hits",
                "type": "count",
                "description": "Midgress traffic includes hits from edge servers to other edge servers.",
                "dataType": "COUNT",
                "helpText": "Midgress traffic includes hits from edge servers to other edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 18,
                "name": "0XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes- 0xx (Client Abort)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes- 0xx (Client Abort)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 19,
                "name": "200 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 200 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 200 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 20,
                "name": "206 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 206 (Partial Content)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 206 (Partial Content)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 21,
                "name": "2XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 22,
                "name": "302 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 23,
                "name": "304 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 24,
                "name": "3XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 25,
                "name": "404 Edge Hits",
                "type": "count",
                "description": "Number of hits that returned the response code - 400 (File not found)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned the response code - 400 (File not found)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 28,
                "name": "4XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 29,
                "name": "5XX Edge Hits",
                "type": "count",
                "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "dataType": "COUNT",
                "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 30,
                "name": "Other Hits",
                "type": "count",
                "description": "When a response code doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
                "dataType": "COUNT",
                "helpText": "When a response code doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 43,
                "name": "Midgress Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total object bytes transferred from one edge server to another edge server.",
                "dataType": "VOLUME",
                "helpText": "Total object bytes transferred from one edge server to another edge server.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 44,
                "name": "Edge Volume",
                "unit": "GB",
                "type": "volume",
                "description": "Total number of megabytes transferred between the edge and the end user. Overhead bytes are included.",
                "dataType": "VOLUME",
                "helpText": "Total number of megabytes transferred between the edge and the end user. Overhead bytes are included.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 119,
                "name": "Ingress Hits",
                "type": "count",
                "description": "Total ingress hits. Origin or Ingress hits are for traffic from your origin to Akamai edge servers.",
                "dataType": "COUNT",
                "helpText": "Total ingress hits. Origin or Ingress hits are for traffic from your origin to Akamai edge servers.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 120,
                "name": "Ingress Bytes",
                "unit": "bytes",
                "type": "volume",
                "description": "Total ingress response bytes delivered from server to browser. It includes ingress (or origin) traffic.",
                "dataType": "VOLUME",
                "helpText": "Total ingress response bytes delivered from server to browser. It includes ingress (or origin) traffic.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 121,
                "name": "Ingress Req Bytes",
                "unit": "bytes",
                "type": "volume",
                "description": "Total ingress response bytes delivered from server to browser. It includes ingress (or origin) traffic.",
                "dataType": "VOLUME",
                "helpText": "Total ingress response bytes delivered from server to browser. It includes ingress (or origin) traffic.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 122,
                "name": "Origin Offload",
                "unit": "%",
                "type": "percent",
                "description": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from your origin.",
                "dataType": "PERCENT",
                "helpText": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from your origin.",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 3600,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get a Wholesale Delivery data store

This fetches a list of dimensions, metrics, the aggregation interval, purge interval, maximum allowed query interval and other data store details.

GET /media-delivery-reports/v1/wholesale-delivery/data-stores/{dataStoreId}

Sample: /media-delivery-reports/v1/wholesale-delivery/data-stores/307

Parameter Type Sample Description
URL parameters
dataStoreId Number 307 The ID of the data store. Uniquely identifies it.

Status 200 application/json

Response Body:

{
    "id": 37,
    "name": "Sub Customer Info",
    "type": "standard",
    "description": "As part of this data store, metrics related to Hits (Edge/Midgress/Origin), Volume (Edge/Midgress/Origin), Offload and Edge Responses are available by Sub Customer ID. Data is available at a minimum granularity of 1 hour.",
    "dimensions": [
        {
            "id": 1,
            "name": "Time",
            "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "helpText": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 2,
            "name": "CPCode",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "helpText": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 25,
            "name": "Sub Customer ID",
            "description": "The sub-customer ID. A sub-customer is a customer of Akamai's media delivery services cloud partner, and is not contracted with Akamai directly.",
            "helpText": "The sub-customer ID. A sub-customer is a customer of Akamai's media delivery services cloud partner, and is not contracted with Akamai directly.",
            "dataType": "STRING",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 4,
            "name": "Edge Hits",
            "type": "count",
            "description": "All hits to the Edge servers from the end users.",
            "dataType": "COUNT",
            "helpText": "All hits to the Edge servers from the end users.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 9,
            "name": "Midgress Hits",
            "type": "count",
            "description": "Midgress traffic includes hits from Edge servers to other Edge servers.",
            "dataType": "COUNT",
            "helpText": "Midgress traffic includes hits from Edge servers to other Edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 18,
            "name": "0XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes- 0xx (Client Abort)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes- 0xx (Client Abort)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 19,
            "name": "200 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 200 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 200 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 20,
            "name": "206 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 206 (Partial Content)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 206 (Partial Content)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 21,
            "name": "2XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 200 to 299 (Successful)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 22,
            "name": "302 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response code - 302 (Redirection Status Code - Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 23,
            "name": "304 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 304 (Redirection Status Code - Not Modified)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 24,
            "name": "3XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 300 to 399 (Redirection)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 25,
            "name": "404 Edge Hits",
            "type": "count",
            "description": "Number of hits that returned the response code - 400 (File not Found)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned the response code - 400 (File not Found)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 28,
            "name": "4XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 400 to 499 (Client Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 29,
            "name": "5XX Edge Hits",
            "type": "count",
            "description": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "dataType": "COUNT",
            "helpText": "Number of hits that returned response codes - 500 to 599 (Server Error)",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 30,
            "name": "Other Hits",
            "type": "count",
            "description": "When a response code received doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
            "dataType": "COUNT",
            "helpText": "When a response code received doesn't fall within the codes 2xx to 5xx, it is an Other hit.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 43,
            "name": "Midgress Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total object bytes transferred from one edge server to another edge server.",
            "dataType": "VOLUME",
            "helpText": "Total object bytes transferred from one edge server to another edge server.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 44,
            "name": "Edge Volume",
            "unit": "GB",
            "type": "volume",
            "description": "Total number of megabytes transferred between the edge to the end user. Overhead bytes are included.",
            "dataType": "VOLUME",
            "helpText": "Total number of megabytes transferred between the edge to the end user. Overhead bytes are included.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 119,
            "name": "Ingress Hits",
            "type": "count",
            "description": "Total ingress hits. Origin or Ingress hits are for traffic from your origin to Akamai edge servers.",
            "dataType": "COUNT",
            "helpText": "Total ingress hits. Origin or Ingress hits are for traffic from your origin to Akamai edge servers.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 120,
            "name": "Ingress Bytes",
            "unit": "bytes",
            "type": "volume",
            "description": "Total ingress response bytes that is delivered from server to browser. It includes ingress (or origin) traffic.",
            "dataType": "VOLUME",
            "helpText": "Total ingress response bytes that is delivered from server to browser. It includes ingress (or origin) traffic.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 121,
            "name": "Ingress Req Bytes",
            "unit": "bytes",
            "type": "volume",
            "description": "Total ingress response bytes that is delivered from server to browser. It includes ingress (or origin) traffic.",
            "dataType": "VOLUME",
            "helpText": "Total ingress response bytes that is delivered from server to browser. It includes ingress (or origin) traffic.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 122,
            "name": "Origin Offload",
            "unit": "%",
            "type": "percent",
            "description": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from your origin.",
            "dataType": "PERCENT",
            "helpText": "Percentage of bytes delivered from the Edge Servers as compared to the bytes delivered from your origin.",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 3600,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

Get Wholesale Delivery data

Retrieves Wholesale Delivery data for the given parameters.

GET /media-delivery-reports/v1/wholesale-delivery/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,deliveryOption,enableCPCodeName}

Sample: /media-delivery-reports/v1/wholesale-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z%20or%202014-03-22T15%3A30%2B05%3A30&endDate=2014-03-23T15%3A30Z%20or%202014-03-23T15%3A30%2B05%3A30&cpcodes=12345%2C67890&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%22values%22%3A%5B%22GB%22%5D%2C%22id%22%3A4%2C%22condition%22%3A%22in%22%7D%2C%7B%22type%22%3A%22metric%22%2C%22values%22%3A%5B16%5D%2C%22id%22%3A155%2C%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%22order%22%3A%22asc%22%2C%22id%22%3A40%7D%5D&deliveryOption=non-secure&enableCPCodeName=true

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014-03-23T15:30Z or 2014-03-23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014-03-22T15:30Z or 2014-03-22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation String month The time period for which to group each data record, either expressed as number of seconds or as keyword values day, week, month, or year. By default, reports for data ranging less than a day aggregate in five minute intervals. For up to 12 days, data aggregates hourly. For up to 30 days, data aggregates daily.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryOption Enumeration non-secure Limits data to the type of traffic, non-secure for non-secure traffic, secure-shared for secure shared-certificate traffic, secure-standard for standard secure customer-certificate traffic, secure-premium for premimum secure customer-certificate traffic, or the default all. The paramater continues to support the older options, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it is best to use the newer options.
enableCPCodeName Boolean true If set to true, it returns the CP code along with its name.
filterParams String [{"type":"dimension","values":["GB"],"id":4,"condition":"in"},{"type":"metric","values":[16],"id":155,"condition":"gt"}] A UTF–8 URL-encoded JSON object representing filter parameters that limit reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return from 1 to 10000. 300 is the default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{"type":"metric","order":"asc","id":40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure. When no sortParams are specified, the response is sorted chronologically for time based queries, or otherwise on the first metric.

Status 200 application/json

Response Body:

{
    "columns": [
        {
            "aggregate": "-",
            "index": 0,
            "name": "Time"
        },
        {
            "aggregate": "119",
            "index": 1,
            "name": "Sub Customer ID"
        }
    ],
    "metaData": {
        "aggregationInSeconds": "3600",
        "endTimeInEpoch": 1392616800,
        "hasMoreData": false,
        "limit": 10,
        "offset": 0,
        "reportPack": "Wholesale Delivery Report Pack",
        "startTimeInEpoch": 1392595200,
        "timeZone": "EST"
    },
    "rows": [
        [
            "1392595200",
            "10"
        ],
        [
            "1392598800",
            "19"
        ],
        [
            "1392602400",
            "10"
        ],
        [
            "1392606000",
            "20"
        ],
        [
            "1392609600",
            "50"
        ],
        [
            "1392613200",
            "10"
        ]
    ]
}

Data

This section describes the Media Delivery Reports API’s various data structures.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Member must be specified in requests, or is always present in responses, regardless of whether its value is empty or null.
Member is optional, and may be omitted in some cases.

Report

Encapsulates a media services data report for various delivery types.

Download schema: mediaServicesData.json

Sample GET:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Hits",
            "description": "Hits",
            "index": 1,
            "aggregate": "46055"
        }
    ],
    "rows": [
        [
            "1471737600",
            "158"
        ],
        [
            "1471737720",
            "138"
        ],
        [
            "1471737840",
            "183"
        ],
        [
            "1471737960",
            "158"
        ],
        [
            "1471738080",
            "163"
        ],
        [
            "1471738200",
            "155"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1471737600,
        "offset": 0,
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": true,
        "aggregation": 120,
        "endTimeInEpoch": 1471860000
    }
}

Report members

Member Type Required Description
columns Report.columns[] Provides context for each element listed within corresponding rows.
metaData Report.metaData Reflects parameter values included in the request that determines this report’s results.
rows Array Encapsulates the report’s two-dimensional table data. Empty rows are displayed if there is no data to report.

Report.columns[]  

Provides context for each element listed within corresponding rows.

Member Type Required Description
aggregate String Provides the aggregate value for the dimension or metric, expressed in string format. For example, if type is metric and name is Hits, this would provide the number of hits for each row of data.
description String Provides information about the relevant dimension or metric.
index Number Positions each column within the table.
name String Depending on the type, provides the name of the relevant dimension or metric.
type Enumeration Type of data, either dimension or metric.

Report.metaData  

Reflects parameter values included in the request that determines this report’s results.

Member Type Required Description
aggregation Number The time span included in each record, expressed in seconds.
endTimeInEpoch Number The end of the requested time range, in epoch seconds.
hasMoreData Boolean Whether a constrained set of requested data does not represent the entire set.
limit Number The maximum number of requested data rows.
offset Number The offset of the row from which the data should start. Used with the overall limit, it reflects where a batch of data starts. For example, setting both offset and limit to 100 selects rows 101–200 from the overall results.
startTimeInEpoch Number The start of the requested time range, in epoch seconds.
timeZone String Identifies the time zone from which the request was made.

FilterParams

Encapsulates filtering parameters, which are wrapped in an array, URL-encoded, and passed in with GET requests using the filterParams query parameter.

Download schema: filter-params.json

Sample non-encoded parameter value, expanded:

[
    {
        "condition": "in",
        "id": 4,
        "type": "dimension",
        "values": [
            "GB"
        ]
    },
    {
        "condition": "gt",
        "id": 155,
        "type": "metric",
        "values": [
            16
        ]
    }
]

FilterParams members

Member Type Required Description
condition Enumeration The condition specifier. For dimensions: in, nin (in or not in), contains, ncontains (does or doesn’t contain), starts, nstarts (does or doesn’t start with), ends, nends (does or doesn’t end with). For metrics: eq, neq (equal or not), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal).
id Integer The ID of the filtering entity (dimension/metric).
type Enumeration Specifies whether the parameter ID provided is a dimension or a metric.
values Array List of values used to filter the result. Multiple values are treated as inclusions. For exclusions use another filter object with appropriate values. Use the two-character country code to filter Media Delivery Reports data by location. To get the list of country codes, go to the Luna Control Center. Download a CSV mapping from Support ⇒ User and Developer Guides ⇒ EdgeScape ⇒ Data Codes ⇒ Country Code.

SortParams

Encapsulates sorting parameters, which are wrapped in an array, URL-encoded, and passed in with GET requests using the sortParams query parameter.

Download schema: sort-params.json

Sample non-encoded parameter value, expanded:

[
    {
        "id": 40,
        "order": "asc",
        "type": "metric"
    }
]

SortParams members

Member Type Required Description
id Integer The ID of the sorting entity. It should also be part of the query parameter metrics or dimensions.
order Enumeration Either asc for ascending or desc for descending sort order.
type Enumeration Specifies whether the parameter ID provided is a dimension or a metric.

Errors

This section provides details on the format of error response objects the Media Delivery Reports API generates. It also lists the range of HTTP response codes for both error and success cases.

Error response codes

API endpoints routinely respond with failure codes to a wide range of problems with the integrity of the data you are trying to modify. The API returns HTTP response codes that correspond to the statuselement in the JSON response eliminating the need to query the header for the response code. The API responds with the following JSON objects for all non–2xx HTTPS status codes:

{
    "status": "400",
    "instance": "49046f42-f51f-403b-be60-6fb8179aa1d2",
    "detail": "Start date and End date are same",
    "title": "Bad Request"
}

HTTP status codes

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

Code Description
200 OK. Empty rows are returned in the response body when there is no available data.
400 Bad input parameter. Error message should indicate which one and why.
401 Authentication failure.
403 Authorization failure.
404 Resource not found.
405 Request method not expected (generally should be GET).
409 Conflict.
410 Requested resource is no longer available.
411 Content-length header not specified.
413 Request body exceeds maximum allowable size.
423 Requested resource is locked.
429 Too many requests.
500 Internal server error; unexpected condition.
501 Not supported.
503 Too many requests; service is temporarily unavailable.
507 Data size is over allowable limit.

Last modified: 6/14/2018