loading

Media Services Reports API v1

Monitor traffic for your Media Services Live, Media Services On Demand, and Progressive Media Delivery solutions.

Learn more:


Overview

These first-mile reports provide information on ingest quality, availability, and accelerated streams for your Media Services Live, Media Services On Demand, and Progressive Media Delivery solutions.

Important: These Media Delivery product operations are deprecated:

  • Adaptive Media Delivery Reports
  • Download Delivery Reports
  • Wholesale Delivery Reports
  • Object Delivery Reports
  • RTMP Media Delivery Reports

Use the Media Delivery Reports API to generate these reports.

Getting started

To configure this API for the first time:

  • Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.
  • To enable this API, choose the API service named Media Services Reports, and set the access level to READ-ONLY.

Rate limiting

The Media Services Reports API imposes a rate-limiting constraint of 20 requests per minute. Exceeding that limit results in a 429 error response. Consider this when calling successive operations as part of a loop. The following response headers provide rate limit information:

  • X-RateLimit-Limit: The total number of tokens allowed.

  • X-RateLimit-Remaining: The number of tokens remaining.

  • X-RateLimit-Next: The time when you can make one more request. For example: 2018-05-11T07:04:40.004Z.

Once X-RateLimit-Remaining becomes 0, you get a 429 error the next time you make an API call.

If you do not make any more API calls after you receive a 429 error, X-RateLimit-Remaining gradually increases and becomes equal to X-RateLimit-Limit.

API workflow

First, you need to obtain information on the available metrics and dimensions. You can use this information to select specific combinations and call the relevant URLs to create customized reports tailored to your specifications.

Step 1: Retrieve available dimensions

You can extract a dimension from a key-value pair, URI Components or strings in log data.

You can run the API operation below to retrieve available dimensions. Skip the step if you already know the dimension IDs.

The sample request and response below shows how to generate an Media Services Live 4 ingest report. (See List Media Services Live 4 dimensions):

GET: /media-reports/v1/media-services-live/http-ingest/dimensions

[
    {
        "id": 99,
        "name": "Source Type",
        "description": "Source type - IAT or Encoder."
    },
    {
        "id": 100,
        "name": "Time",
        "description": "Indicates the consumption time of the content. Akamai sets this dimension automatically."
    },
    {
        "id": 101,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 102,
        "name": "Stream ID",
        "description": "Unique identifier associated with a stream generated by the Akamai provisioning workflow."
    },
    {
        "id": 103,
        "name": "Unique End Point",
        "description": "The URL path after the Stream ID in the ingest URL. For manifest files, the file name is part of the Unique End Point. For segment requests, the file name (last path element) is left out. This also indicates the bit rate of the stream."
    },
    {
        "id": 104,
        "name": "File Type",
        "description": "The ingested object's file type."
    },
    {
        "id": 105,
        "name": "Encoder IP",
        "description": "IP address of encoder generating the stream."
    },
    {
        "id": 106,
        "name": "Entry Point",
        "description": "IP address for the entry point. Akamai ingested the stream from this entry point."
    },
    {
        "id": 107,
        "name": "Stream Type",
        "description": "The stream type, either `Primary` or `Backup`."
    },
    {
        "id": 108,
        "name": "Source IP",
        "description": "Source IP or Source IAT IP"
    },
    {
        "id": 109,
        "name": "File Type",
        "description": "File extension of the object requested. The system extracts this from the URL of the requested object."
    },
    {
        "id": 111,
        "name": "File Extension",
        "description": "File extension of the ingested object. The system extracts this from the URL of the ingested object."
    }
]

Step 2: Retrieve available metrics

Akamai measures dimensions using metrics.

You can run the API operation below to retrieve available metrics. Skip the step if you already know the metric IDs.

The sample request and response below shows how to generate a Media Services Live 4 ingest report. (See List Media Services Live 4 metrics):

GET: /media-reports/v1/media-services-live/http-ingest/metrics

[
    {
        "id": 200,
        "name": "Avg Bit rate",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average amount of data transferred in a unit of time, calculated in bits per second. Expressed in kbps, Mbps, Gbps etc."
    },
    {
        "id": 201,
        "name": "Error Rate",
        "unit": "%",
        "type": "percent",
        "description": "Rate of errors occurring in a unit of time. Expressed as a percentage."
    },
    {
        "id": 202,
        "name": "Ingest Hits",
        "type": "count",
        "description": "Total number of requests made to the entry point posting objects."
    },
    {
        "id": 203,
        "name": "2xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 200 to 299 (Successful)"
    },
    {
        "id": 204,
        "name": "3xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 300 to 399 (Redirection)"
    },
    {
        "id": 205,
        "name": "4xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 400 to 499 (Client Error)"
    },
    {
        "id": 206,
        "name": "5xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 500 to 599 (Server Error)"
    },
    {
        "id": 207,
        "name": "Avg Latency",
        "unit": "ms",
        "type": "time",
        "description": "Indicates the delay between encoder and entry point when sending a unit of media payload."
    },
    {
        "id": 208,
        "name": "Avg Packet Loss",
        "unit": "%",
        "type": "percent",
        "description": "Measures the quality of connection between encoder and entry Point. Provides connection level ratio of data packets(bytes) lost to the data packets(bytes) sent by the encoder."
    },
    {
        "id": 209,
        "name": "Ingest Hits",
        "type": "count",
        "description": "Total number of requests made to the entry point posting objects."
    },
    {
        "id": 210,
        "name": "Success Ingest Hits",
        "type": "count",
        "description": "Success Hits"
    },
    {
        "id": 212,
        "name": "Error Rate",
        "unit": "%",
        "type": "percent",
        "description": "Rate of errors occurring in a unit of time. Expressed as a percentage."
    },
    {
        "id": 213,
        "name": "Avg Path Time",
        "unit": "ms",
        "type": "time",
        "description": "Average time taken from source to destination."
    },
    {
        "id": 214,
        "name": "Avg Bit rate",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average amount of data transferred in a unit of time, calculated in bits per second. Expressed in kbps, Mbps, Gbps etc."
    },
    {
        "id": 215,
        "name": "2xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 200 to 299 (Successful)"
    },
    {
        "id": 216,
        "name": "3xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 300 to 399 (Redirection)"
    },
    {
        "id": 217,
        "name": "4xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 400 to 499 (Client Error)"
    },
    {
        "id": 218,
        "name": "5xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 500 to 599 (Server Error)"
    }
]

Step 3: Retrieve data

You can retrieve data for a given CP code using the API call shown below.

The sample request and response below shows how to generate a Media Services Live 4 ingest report. The first GET line represents the URL template syntax. The second GET line represents an actual sample URL. For more information, see (Get Media Services Live 4 data):

GET: /media-reports/v1/media-services-live/http-ingest/data(?startDate,endDate,aggregation,dimensions,metrics,cpcodes,ipVersion,limit,offset,filterParams,sortParams,deliveryOption,deliveryFormat,deliveryType)

Assume that the dimension ID 100 represents Time and the metric ID 200 represents the metric Avg Bit rate. The sample URL below reports on average bit rate by time for a period starting 12/01/2015:00:00 to 12/01/2015:05:00 for a CP code 12345:

GET: /media-reports/v1/media-services-live/http-ingest/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": "Indicates the consumption time of the content. Akamai sets this dimension automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Avg Bit rate",
            "id": 200,
            "description": "Average amount of data transferred in a unit of time, calculated in bits per second. Expressed in kbps, Mbps, Gbps etc.",
            "index": 1,
            "unit": "kbps"
        }
    ],
    "rows": [
        [
            "1529891640",
            "1605.884392"
        ],
        [
            "1529891760",
            "1618.015465"
        ],
        [
            "1529891880",
            "1596.447969"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1529891640,
        "offset": 0,
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "aggregation": 120,
        "endTimeInEpoch": 1529898840
    }
}

Concepts

Below is a list of the conceptual objects you deal with when interacting with the Media Services Reports API:

  • Media Services Live 4 reports: Reports on ingest quality and availability for Media Services Live 4 Streams. The reports also provide information on accelerated streams.

  • Media Services Live Origin Shield Monitoring reports: Reports on ingest quality and availability of content across many CDNs and accounts.

  • Media Services Live HLS/HDS/DASH Ingest reports: Reports on ingest quality and availability of HLS/HDS/DASH Ingest (HTTP-based) streams. The reports also provide information on accelerated streams.

  • Media Streaming Live Stream Packaging reports: Reports on ingest quality and availability of RTMP streams that this product converted to HLS or HDS.

  • Media Services Live HD Flash 1.0 reports: Reports on ingest quality and delivery details for HD Flash 1.0 streams.

  • RTMP Streaming reports: Reports on ingest quality and delivery details for both Media Services Live and Media Services On Demand RTMP streams.

  • Progressive Media Delivery reports: Reports on ingest quality and delivery details for Progressive Media Delivery streams.

  • Data stores: A collection of dimensions and metrics stored in a database that you can use to create reports.

  • Entry point switching: An Akamai ingest server that receives streams from a source. Entry point switching occurs when the ingest server experiences connectivity issues and Akamai routes the stream to another server.

Resources

This section provides details on the API’s operations.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Media Services Live 4  
List Media Services Live 4 dimensions GET /media-reports/v1/media-services-live/http-ingest/dimensions
List Media Services Live 4 metrics GET /media-reports/v1/media-services-live/http-ingest/metrics
Get Media Services Live 4 data POST /media-reports/v1/media-services-live/http-ingest/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,streams}
Get Media Services Live 4 entry point switch information GET /media-reports/v1/media-services-live/http-ingest/ep-switch/data{?startDate,endDate,cpcodes,limit,offset,streams}
List Media Services Live 4 Origin Shield dimensions GET /media-reports/v1/media-services-live/http-ingest/origin-shield/dimensions
List Media Services Live 4 Origin Shield metrics GET /media-reports/v1/media-services-live/http-ingest/origin-shield/metrics
Get Media Services Live 4 Origin Shield data POST /media-reports/v1/media-services-live/http-ingest/origin-shield/data{?dimensions,metrics,startDate,endDate,cpcodes,streams,aggregation,limit,offset,filterParams,sortParams}
Media Services Live Stream Packaging  
List Media Services Live Stream Packaging dimensions GET /media-reports/v1/media-services-live/rtmp-ingest/dimensions
List Media Services Live Stream Packaging metrics GET /media-reports/v1/media-services-live/rtmp-ingest/metrics
Get Media Services Live Stream Packaging data POST /media-reports/v1/media-services-live/rtmp-ingest/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,streams}
Get Media Services Live Stream Packaging entry point switching information GET /media-reports/v1/media-services-live/rtmp-ingest/ep-switch/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,filterParams,sortParams,streams}
Media Services Live HLS/HDS/DASH Ingest  
List Media Services Live HLS/HDS/DASH Ingest metrics GET /media-reports/v1/msl3/passthrough/metrics
List Media Services Live HLS/HDS/DASH Ingest dimensions GET /media-reports/v1/msl3/passthrough/dimensions
List Media Services Live HLS/HDS/DASH Ingest data GET /media-reports/v1/msl3/passthrough/data{?startDate,endDate,ignorePutPost,cpcodes,enableCpCodeName}
List Media Services Live HLS/HDS/DASH Ingest active streams delivery data GET /media-reports/v1/msl3/passthrough/active-streams/delivery/data{?cpcodes}
List Media Services Live HLS/HDS/DASH Ingest active streams ingest data GET /media-reports/v1/msl3/passthrough/active-streams/ingest/data{?cpcodes}
List Media Services Live HLS/HDS/DASH Ingest data stores GET /media-reports/v1/msl3/passthrough/data-stores
Get a Media Services Live HLS/HDS/DASH Ingest data store GET /media-reports/v1/msl3/passthrough/data-stores/{dataStoreId}
Media Services Live HD Flash 1.0  
List Media Services Live HD Flash 1.0 metrics GET /media-reports/v1/msl3/hdn1/metrics
List Media Services Live HD Flash 1.0 dimensions GET /media-reports/v1/msl3/hdn1/dimensions
List Media Services Live HD Flash 1.0 data GET /media-reports/v1/msl3/hdn1/data{?startDate,endDate,ignorePutPost,cpcodes,enableCpCodeName}
List Media Services Live HD Flash 1.0 active streams delivery data GET /media-reports/v1/msl3/hdn1/active-streams/delivery/data{?cpcodes}
List Media Services Live HD Flash 1.0 active streams ingest data GET /media-reports/v1/msl3/hdn1/active-streams/ingest/data{?cpcodes}
List Media Services Live HD Flash 1.0 data stores GET /media-reports/v1/msl3/hdn1/data-stores
Get a Media Services Live HD Flash 1.0 data store GET /media-reports/v1/msl3/hdn1/data-stores/{dataStoreId}
Media Services Live RTMP  
List Media Services Live RTMP metrics GET /media-reports/v1/msl3/rtmp/metrics
List Media Services Live RTMP dimensions GET /media-reports/v1/msl3/rtmp/dimensions
List Media Services Live RTMP active streams delivery data GET /media-reports/v1/msl3/rtmp/active-streams/delivery/data{?cpcodes}
List Media Services Live RTMP active streams ingest data GET /media-reports/v1/msl3/rtmp/active-streams/ingest/data{?cpcodes}
List Media Services Live RTMP data GET /media-reports/v1/msl3/rtmp/data{?startDate,endDate,ignoreEdgeFlash,cpcodes,enableCpCodeName}
List Media Services Live RTMP data stores GET /media-reports/v1/msl3/rtmp/data-stores
Get a Media Services Live RTMP data store GET /media-reports/v1/msl3/rtmp/data-stores/{dataStoreId}
Media Services On Demand RTMP  
List Media Services On Demand RTMP dimensions GET /media-reports/v1/msod/msod-rtmp/dimensions
List Media Services On Demand RTMP metrics GET /media-reports/v1/msod/msod-rtmp/metrics
List Media Service On Demand RTMP data GET /media-reports/v1/msod/msod-rtmp/data{?startDate,endDate,ignorePutPost,ignoreEdgeFlash,cpcodes}
Progressive Media Delivery  
List Progressive Media Delivery dimensions GET /media-reports/v1/msod/pmd/dimensions
List Progressive Media Delivery metrics GET /media-reports/v1/msod/pmd/metrics
List Progressive Media Delivery data GET /media-reports/v1/msod/pmd/data{?startDate,endDate,ignorePutPost,deliveryOption,cpcodes}
Adaptive Media Delivery (deprecated)  
List Adaptive Media Delivery dimensions GET /media-reports/v1/adaptive-media-delivery/dimensions
List Adaptive Media Delivery metrics GET /media-reports/v1/adaptive-media-delivery/metrics
Get Adaptive Media Delivery data GET /media-reports/v1/adaptive-media-delivery/data{?dimensions,metrics,cpcodes,startDate,endDate,limit,offset,aggregation,filterParams,sortParams,deliveryOption,deliveryType,deliveryFormat,mediaAcceleration,mediaEncryption,ipVersion}
Download Delivery (deprecated)  
List Download Delivery dimensions GET /media-reports/v1/download-delivery/dimensions
List Download Delivery metrics GET /media-reports/v1/download-delivery/metrics
Get Download Delivery data GET /media-reports/v1/download-delivery/data{?dimensions,metrics,cpcodes,startDate,endDate,limit,offset,aggregation,filterParams,sortParams,deliveryOption,mediaAcceleration,ipVersion}
Object Delivery (deprecated)  
List Object Delivery dimensions GET /media-reports/v1/object-delivery/dimensions
List Object Delivery metrics GET /media-reports/v1/object-delivery/metrics
Get Object Delivery data GET /media-reports/v1/object-delivery/data{?dimensions,metrics,cpcodes,startDate,endDate,limit,offset,filterParams,sortParams,mediaAcceleration}
RTMP Media Delivery (deprecated)  
List RTMP Media Delivery dimensions GET /media-reports/v1/rtmp-media-delivery/dimensions
List RTMP Media Delivery metrics GET /media-reports/v1/rtmp-media-delivery/metrics
Get RTMP Media Delivery data GET /media-reports/v1/rtmp-media-delivery/data{?dimensions,metrics,cpcodes,startDate,endDate,limit,offset,aggregation,filterParams,sortParams,deliveryType}
Wholesale Delivery (deprecated)  
List Wholesale Delivery dimensions GET /media-reports/v1/wholesale-delivery/dimensions
List Wholesale Delivery metrics GET /media-reports/v1/wholesale-delivery/metrics
Get Wholesale Delivery data GET /media-reports/v1/wholesale-delivery/data{?dimensions,metrics,cpcodes,startDate,endDate,limit,offset,aggregation,filterParams,sortParams,deliveryOption}

List Media Services Live 4 dimensions

Retrieves all of the dimensions available for HTTP Ingest (Media Services Live 4).

GET /media-reports/v1/media-services-live/http-ingest/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 99,
        "name": "Source Type",
        "description": "Source type - IAT or Encoder."
    },
    {
        "id": 100,
        "name": "Time",
        "description": "Indicates the consumption time of the content. This dimension is set automatically."
    },
    {
        "id": 101,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 102,
        "name": "Stream ID",
        "description": "Unique identifier associated with a stream generated by the Akamai provisioning workflow."
    },
    {
        "id": 103,
        "name": "Unique End Point",
        "description": "The URL path after the Stream ID in the ingest URL. For manifest Files, the file name is part of the unique end point. For segment requests, the file name (last path element) is omitted. Also indicates the bit rate of the stream."
    },
    {
        "id": 104,
        "name": "File Type",
        "description": "File type of the ingested object."
    },
    {
        "id": 105,
        "name": "Encoder IP",
        "description": "IP address of encoder generating the stream."
    },
    {
        "id": 106,
        "name": "Entry Point",
        "description": "IP address of the entry point at which stream is ingested."
    },
    {
        "id": 107,
        "name": "Stream Type",
        "description": "Type of stream - Primary or Backup."
    },
    {
        "id": 108,
        "name": "Source IP",
        "description": "Source IP or Source IAT IP"
    },
    {
        "id": 109,
        "name": "File Type",
        "description": "File type of the object requested. This is extracted from the URL of the requested object."
    },
    {
        "id": 111,
        "name": "File Extension",
        "description": "File Extension of the ingested object. This is extracted from the URL of the ingested object."
    }
]

List Media Services Live 4 metrics

Retrieves all of the metrics available for HTTP Ingest (Media Services Live 4).

GET /media-reports/v1/media-services-live/http-ingest/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 200,
        "name": "Avg Bit rate",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average amount of data transferred in a unit of time, calculated in terms of bits per second. Expressed in kbps, Mbps, Gbps etc."
    },
    {
        "id": 201,
        "name": "Error Rate",
        "unit": "%",
        "type": "percent",
        "description": "Rate of errors occurring in a unit of time. Expressed as a percentage."
    },
    {
        "id": 202,
        "name": "Ingest Hits",
        "type": "count",
        "description": "Total number of requests made to the entry point posting objects."
    },
    {
        "id": 203,
        "name": "2xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 200 to 299 (Successful)."
    },
    {
        "id": 204,
        "name": "3xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 300 to 399 (Redirection)."
    },
    {
        "id": 205,
        "name": "4xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 400 to 499 (Client Error)."
    },
    {
        "id": 206,
        "name": "5xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 500 to 599 (Server Error)."
    },
    {
        "id": 207,
        "name": "Avg Latency",
        "unit": "ms",
        "type": "time",
        "description": "Indicates the delay between encoder and entry point when sending a unit of media payload."
    },
    {
        "id": 208,
        "name": "Avg Packet Loss",
        "unit": "%",
        "type": "percent",
        "description": "Measures the quality of connection between encoder and entry point. Provides connection level ratio of data packets(bytes) lost to the data packets(bytes) sent by the encoder."
    },
    {
        "id": 209,
        "name": "Ingest Hits",
        "type": "count",
        "description": "Total number of requests made to the entry point posting objects."
    },
    {
        "id": 210,
        "name": "Success Ingest Hits",
        "type": "count",
        "description": "Total number of OK requests made to the entry point posting objects."
    },
    {
        "id": 212,
        "name": "Error Rate",
        "unit": "%",
        "type": "percent",
        "description": "Rate of errors occurring in a unit of time. Expressed as a percentage."
    },
    {
        "id": 213,
        "name": "Avg Path Time",
        "unit": "ms",
        "type": "time",
        "description": "Average time taken from source to destination."
    },
    {
        "id": 214,
        "name": "Avg Bit rate",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average amount of data transferred in a unit of time, calculated in terms of bits per second. Expressed in kbps, Mbps, Gbps etc."
    },
    {
        "id": 215,
        "name": "2xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 200 to 299 (Successful)"
    },
    {
        "id": 216,
        "name": "3xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 300 to 399 (Redirection)."
    },
    {
        "id": 217,
        "name": "4xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 400 to 499 (Client Error)."
    },
    {
        "id": 218,
        "name": "5xx Ingest Hits",
        "type": "count",
        "description": "Number of requests made to the entry point posting objects that returned response codes - 500 to 599 (Server Error)."
    }
]

Get Media Services Live 4 data

Retrieves Media Services Live 4 data for the given parameters.

POST /media-reports/v1/media-services-live/http-ingest/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,streams}

Sample: /media-reports/v1/media-services-live/http-ingest/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&cpcodes=12345%2C67890&limit=300&offset=0&aggregation=1440&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&streams=12345%2C67890

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation Number 1440 The time period in which to group each data record, expressed as number of seconds.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Identifies a set of reported streams as comma-separated ID values.

Status 200 application/json

Object type: Report

Download schema: mediaServicesData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Hits",
            "description": "Total number of requests made to the entry point posting objects.",
            "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
    }
}

Get Media Services Live 4 entry point switch information

Retrieves information about all of the entry point switches that occurred in a given period.

GET /media-reports/v1/media-services-live/http-ingest/ep-switch/data{?startDate,endDate,cpcodes,limit,offset,streams}

Sample: /media-reports/v1/media-services-live/http-ingest/ep-switch/data?startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&cpcodes=12345%2C67890&limit=300&offset=0&streams=12345%2C67890

Parameter Type Sample Description
Required query parameters
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
limit Number 300 The number of rows to return from 1 to 10000. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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.
streams String 12345,67890 Identifies a set of reported streams as comma-separated ID values.

Status 200 application/json

Download schema: entryPointSwitchData.json

Response Body:

{
    "columns": [
        {
            "index": 0,
            "name": "Current Time",
            "type": "dimension"
        },
        {
            "index": 1,
            "name": "Stream ID",
            "type": "dimension"
        },
        {
            "index": 2,
            "name": "Entry Point Switch Time",
            "type": "dimension"
        },
        {
            "index": 3,
            "name": "Old Entry Point",
            "type": "dimension"
        },
        {
            "index": 4,
            "name": "New Entry Point",
            "type": "dimension"
        },
        {
            "index": 5,
            "name": "Stream Type",
            "type": "dimension"
        }
    ],
    "metaData": {
        "aggregation": 120,
        "endTimeInEpoch": 1487833200,
        "hasMoreData": false,
        "limit": 300,
        "offset": 0,
        "startTimeInEpoch": 1487826000,
        "timeZone": "GMT"
    },
    "rows": [
        [
            "1487829360",
            "266583",
            "1487829240",
            "198.18.52.238",
            "198.18.52.240",
            "Primary"
        ],
        [
            "1487830080",
            "266583",
            "1487829960",
            "198.18.52.240",
            "198.18.52.238",
            "Primary"
        ],
        [
            "1487832120",
            "266583",
            "1487831520",
            "198.18.52.238",
            "198.18.52.240",
            "Primary"
        ]
    ]
}

List Media Services Live 4 Origin Shield dimensions

Retrieves all of the dimensions available for HTTP Ingest (Media Services Live 4).

GET /media-reports/v1/media-services-live/http-ingest/origin-shield/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 5511,
        "name": "ASN Name",
        "description": "Name of the Autonomous System Number (ASN)."
    },
    {
        "id": 5505,
        "name": "CDN",
        "description": "Name of the CDN provider."
    },
    {
        "id": 5501,
        "name": "CPCode",
        "description": "Content provider code (CP code) is an identifier assigned to a contract and used for reporting, billing, and monitoring traffic served."
    },
    {
        "id": 5507,
        "name": "Client ASN",
        "description": "Autonomous system number of an ISP."
    },
    {
        "id": 5506,
        "name": "Client Country",
        "description": "Origin country of CDN."
    },
    {
        "id": 5504,
        "name": "Format",
        "description": "Delivery format of the stream."
    },
    {
        "id": 5509,
        "name": "Origin Hostname",
        "description": "CDN Hostname."
    },
    {
        "id": 5508,
        "name": "Publishing Geo",
        "description": "GEO location of CDN host."
    },
    {
        "id": 5502,
        "name": "Stream Id",
        "description": "Unique identifier associated with a stream."
    },
    {
        "id": 5503,
        "name": "Stream Type",
        "description": "Type of stream - Primary or Backup."
    },
    {
        "id": 5500,
        "name": "Time",
        "description": "Indicates the time at which the content was ingested."
    }
]

List Media Services Live 4 Origin Shield metrics

Retrieves all of the metrics available for Media Services Live 4 (HLS/HDS/DASH).

GET /media-reports/v1/media-services-live/http-ingest/origin-shield/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 5525,
        "name": "2xx Hits",
        "type": "count",
        "description": "Number of hits that returned response codes - 200 to 299 (Successful)."
    },
    {
        "id": 5526,
        "name": "3xx Hits",
        "type": "count",
        "description": "Number of hits that returned response codes - 300 to 399 (Redirection)."
    },
    {
        "id": 5527,
        "name": "4xx Hits",
        "type": "count",
        "description": "Number of hits that returned response codes - 400 to 499 (Client Error)."
    },
    {
        "id": 5528,
        "name": "5xx Hits",
        "type": "count",
        "description": "Number of hits that returned response codes - 500 to 599 (Server Error)."
    },
    {
        "id": 5531,
        "name": "Avg Download Time",
        "unit": "seconds",
        "type": "time",
        "description": "The average time to download media based on bandwidth, file size, and connection speed."
    },
    {
        "id": 5533,
        "name": "Avg Throughput",
        "unit": "Mbps",
        "description": "The rate of successful delivery of media. The system calculates this as the total bytes delivered, divided by the total time taken to serve the request."
    },
    {
        "id": 5523,
        "name": "Bandwidth",
        "unit": "Mbps",
        "description": "Total bandwidth usage including all HTTP response codes."
    },
    {
        "id": 5522,
        "name": "Bytes",
        "description": "Total bytes transferred."
    },
    {
        "id": 5520,
        "name": "Hits",
        "type": "count",
        "description": "Total number of requests."
    },
    {
        "id": 5545,
        "name": "Hits [Download Time 0-2 Sec]",
        "type": "count",
        "description": "Total number of requests that took a download time of 0-2 seconds."
    },
    {
        "id": 5546,
        "name": "Hits [Download Time 2-4 Sec]",
        "type": "count",
        "description": "Total number of requests that took a download time of 2-4 seconds."
    },
    {
        "id": 5547,
        "name": "Hits [Download Time 4-6 Sec]",
        "type": "count",
        "description": "Total number of requests that took a download time of 4-6 seconds."
    },
    {
        "id": 5548,
        "name": "Hits [Download Time 6-8 Sec]",
        "type": "count",
        "description": "Total number of requests that took a download time of 6-8 seconds."
    },
    {
        "id": 5549,
        "name": "Hits [Download Time 8-10 Sec] ",
        "type": "count",
        "description": "Total number of requests that took a download time of 8-10 seconds."
    },
    {
        "id": 5550,
        "name": "Hits [Download Time > 10 Sec]",
        "type": "count",
        "description": "Total number of requests that took a download time of greater than 10 seconds."
    },
    {
        "id": 5537,
        "name": "Hits [Throughput 0-2 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 0-2 seconds."
    },
    {
        "id": 5540,
        "name": "Hits [Throughput 10-12 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 10-12 Mbps."
    },
    {
        "id": 5541,
        "name": "Hits [Throughput 12-15 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 12-15 Mbps."
    },
    {
        "id": 5542,
        "name": "Hits [Throughput 15-17 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 15-17 Mbps."
    },
    {
        "id": 5543,
        "name": "Hits [Throughput 17-20 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 17-20 Mbps."
    },
    {
        "id": 5538,
        "name": "Hits [Throughput 2-5 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 2-5 Mbps."
    },
    {
        "id": 5539,
        "name": "Hits [Throughput 5-10 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of 5-10 Mbps."
    },
    {
        "id": 5544,
        "name": "Hits [Throughput > 20 Mbps]",
        "type": "count",
        "description": "Total number of requests that had a throughput of over 20 Mbps."
    },
    {
        "id": 5521,
        "name": "Hits/sec",
        "type": "count",
        "description": "Number of hits per second."
    },
    {
        "id": 5534,
        "name": "Line Count",
        "type": "count",
        "description": "Line Count"
    },
    {
        "id": 5529,
        "name": "Other Hits",
        "type": "count",
        "description": "Number of requests that return responses that do not belong to the categories: 2xx, 3xx, 4xx, or 5xx. "
    },
    {
        "id": 5535,
        "name": "Success Bytes",
        "unit": "bytes",
        "type": "volume",
        "description": "Volume of total bytes transferred in successful hits."
    },
    {
        "id": 5532,
        "name": "Throughput",
        "description": "The rate of successful delivery of content. The system calculates this as the total bytes delivered, divided by the total time taken to serve the request."
    },
    {
        "id": 5524,
        "name": "Volume",
        "unit": "MB",
        "description": "Total number of megabytes transferred at the entry point."
    },
    {
        "id": 5536,
        "name": "Weighted Average Throughput",
        "unit": "Mbps",
        "description": "Rate of successful delivery of content weighted by daily bytes delivered."
    }
]

Get Media Services Live 4 Origin Shield data

Retrieves HTTP Ingest Origin Shield data for the given parameters. This API allows you to query data collected at a one-minute aggregation with 10 percent sampling frequency and a purge window of seven days. It also allows you to query for a maximum duration of two minutes.

POST /media-reports/v1/media-services-live/http-ingest/origin-shield/data{?dimensions,metrics,startDate,endDate,cpcodes,streams,aggregation,limit,offset,filterParams,sortParams}

Sample: /media-reports/v1/media-services-live/http-ingest/origin-shield/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&cpcodes=12345%2C67890&streams=12345%2C67890&aggregation=1440&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation Number 1440 The time period in which to group each data record, expressed as number of seconds.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Identifies a set of reported streams as comma-separated ID values.

Status 200 application/json

Download schema: origin-shieldData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "CPCode",
            "description": "Identifier assigned to a contract and used for reporting, billing, and monitoring traffic served.",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream Id",
            "description": "Unique identifier associated with a stream generated by the Akamai provisioning workflow.",
            "index": 1
        },
        {
            "type": "metric",
            "name": "Hits",
            "description": "Total number of requests made to the entry point posting objects.",
            "index": 2,
            "aggregate": "88"
        },
        {
            "type": "metric",
            "name": "Hits/sec",
            "description": "Number of hits per second to entry point servers.",
            "index": 3,
            "aggregate": "1.47"
        },
        {
            "type": "metric",
            "name": "Bandwidth",
            "description": "Total bandwidth usage at the entry point, including all HTTP response codes.",
            "index": 3,
            "aggregate": "8.67",
            "unit": "Mbps"
        }
    ],
    "rows": [
        "686645",
        "12345",
        "88",
        "1.47",
        "8.67"
    ],
    "metaData": {
        "startTimeInEpoch": 1522980000,
        "offset": 0,
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "aggregation": 60,
        "endTimeInEpoch": 1522984260
    }
}

List Media Services Live Stream Packaging dimensions

Retrieves all of the dimensions available for Media Services Live Stream Packaging.

GET /media-reports/v1/media-services-live/rtmp-ingest/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 209,
        "name": "Stream Type",
        "description": "Type of stream - Primary (actual) or Backup."
    },
    {
        "id": 210,
        "name": "Source Type",
        "description": "Source type - IAT or Encoder."
    },
    {
        "id": 200,
        "name": "Time",
        "description": "Indicates the consumption time of the content. This dimension is set automatically."
    },
    {
        "id": 201,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 202,
        "name": "Stream ID",
        "description": "Unique identifier associated with a stream generated by the Akamai provisioning workflow."
    },
    {
        "id": 203,
        "name": "Unique End Point",
        "description": "The URL path after Stream ID in the ingest URL. Indicates bit rate of the stream."
    },
    {
        "id": 204,
        "name": "Encoder IP",
        "description": "IP address of encoder generating the stream."
    },
    {
        "id": 205,
        "name": "Authentication Scheme",
        "description": "Stream authentication scheme used. Values displayed can be Adobe, Akamai, or Octoshape."
    },
    {
        "id": 206,
        "name": "Entry Point",
        "description": "IP address of the entry point at which stream is ingested."
    },
    {
        "id": 207,
        "name": "File Type",
        "description": "File type of the ingested stream."
    },
    {
        "id": 208,
        "name": "Encoder IP",
        "description": "IP address of encoder generating the stream."
    }
]

List Media Services Live Stream Packaging metrics

Retrieves all of the metrics available for Media Services Live RTMP Ingest.

GET /media-reports/v1/media-services-live/rtmp-ingest/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 230,
        "name": "Avg Bit rate",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average amount of data transferred in a unit of time; calculated in terms of bits per second; and expressed in kbps, Mbps, Gbps etc."
    },
    {
        "id": 231,
        "name": "Query Agg",
        "type": "count",
        "description": "Query Agg"
    },
    {
        "id": 232,
        "name": "Avg Latency",
        "unit": "ms",
        "type": "time",
        "description": "Indicates the delay between encoder and entry point when sending a unit of media payload."
    },
    {
        "id": 233,
        "name": "Avg Packet Loss",
        "unit": "%",
        "type": "percent",
        "description": "Measures the quality of connection between encoder and entry point. Provides connection level ratio of data packets (bytes) lost to the data packets(bytes) sent by Encoder."
    },
    {
        "id": 234,
        "name": "Bytes Transferred",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Bytes Transferred"
    },
    {
        "id": 235,
        "name": "Avg Bit rate",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average amount of data transferred in a unit of time; calculated in terms of bits per second; and expressed in kbps, Mbps, Gbps etc."
    },
    {
        "id": 236,
        "name": "Avg Path Time",
        "unit": "ms",
        "type": "time",
        "description": "Average time taken from source to destination."
    }
]

Get Media Services Live Stream Packaging data

Retrieves Media Services Live Stream Packaging data for the given parameters.

POST /media-reports/v1/media-services-live/rtmp-ingest/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,streams}

Sample: /media-reports/v1/media-services-live/rtmp-ingest/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&cpcodes=12345%2C67890&limit=300&offset=0&aggregation=1440&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&streams=12345%2C67890

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
aggregation Number 1440 The time period in which to group each data record, expressed as number of seconds.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Identifies a set of reported streams as comma-separated ID values.

Status 200 application/json

Object type: Report

Download schema: mediaServicesData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Hits",
            "description": "Total number of requests made to the entry point posting objects.",
            "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
    }
}

Get Media Services Live Stream Packaging entry point switching information

Retrieves information about all of the entry point switches that occurred in a given period.

GET /media-reports/v1/media-services-live/rtmp-ingest/ep-switch/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,filterParams,sortParams,streams}

Sample: /media-reports/v1/media-services-live/rtmp-ingest/ep-switch/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&streams=12345%2C67890

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Identifies a set of reported streams as comma-separated ID values.

Status 200 application/json

Download schema: entryPointSwitchData.json

Response Body:

{
    "columns": [
        {
            "index": 0,
            "name": "Current Time",
            "type": "dimension"
        },
        {
            "index": 1,
            "name": "Stream ID",
            "type": "dimension"
        },
        {
            "index": 2,
            "name": "Entry Point Switch Time",
            "type": "dimension"
        },
        {
            "index": 3,
            "name": "Old Entry Point",
            "type": "dimension"
        },
        {
            "index": 4,
            "name": "New Entry Point",
            "type": "dimension"
        },
        {
            "index": 5,
            "name": "Stream Type",
            "type": "dimension"
        }
    ],
    "metaData": {
        "aggregation": 120,
        "endTimeInEpoch": 1487833200,
        "hasMoreData": false,
        "limit": 300,
        "offset": 0,
        "startTimeInEpoch": 1487826000,
        "timeZone": "GMT"
    },
    "rows": [
        [
            "1487829360",
            "266583",
            "1487829240",
            "198.18.52.238",
            "198.18.52.240",
            "Primary"
        ],
        [
            "1487830080",
            "266583",
            "1487829960",
            "198.18.52.240",
            "198.18.52.238",
            "Primary"
        ],
        [
            "1487832120",
            "266583",
            "1487831520",
            "198.18.52.238",
            "198.18.52.240",
            "Primary"
        ]
    ]
}

List Media Services Live HLS/HDS/DASH Ingest metrics

Retrieves all of the metrics available for HLS/HDS/DASH Ingest.

GET /media-reports/v1/msl3/passthrough/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 123456,
        "name": "Average Bit rate",
        "unit": "count",
        "type": "count",
        "description": "Average amount of data transferred"
    },
    {
        "id": 123457,
        "name": "Average Buffer Time",
        "type": "count",
        "description": "Average Buffer Time"
    },
    {
        "id": 123458,
        "name": "Average Client Bandwidth",
        "type": "bandwidth",
        "description": "Average client Bandwidth"
    }
]

List Media Services Live HLS/HDS/DASH Ingest dimensions

Retrieves all of the dimensions available for Media Services Live HLS/HDS/DASH Ingest.

GET /media-reports/v1/msl3/passthrough/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 12345,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 12346,
        "name": "Canadian Province",
        "description": "Canadian Province"
    }
]

List Media Services Live HLS/HDS/DASH Ingest data

Retrieves ingest data for Media Services Live HLS/HDS/DASH Ingest.

GET /media-reports/v1/msl3/passthrough/data{?startDate,endDate,ignorePutPost,cpcodes,enableCpCodeName}

Sample: /media-reports/v1/msl3/passthrough/data?startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&ignorePutPost=true&cpcodes=12345%2C67890&enableCpCodeName=true

Parameter Type Sample Description
Required query parameters
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
enableCpCodeName Boolean true When enabled, includes the name of the CP code in the output.
ignorePutPost Boolean true Specifies if the API should ignore ingest data when generating the response.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Concurrent Streams",
            "id": 123456,
            "description": "Sum of Average concurrent streams",
            "index": 1,
            "aggregate": "3141454.39"
        }
    ],
    "rows": [
        [
            "1543674600",
            "186575.959"
        ],
        [
            "1543761000",
            "185988.34"
        ],
        [
            "1543847400",
            "184741.378"
        ],
        [
            "1543933800",
            "180774.639"
        ],
        [
            "1544020200",
            "181598.317"
        ],
        [
            "1544106600",
            "184538.753"
        ],
        [
            "1544193000",
            "190988.807"
        ],
        [
            "1544279400",
            "187612.032"
        ],
        [
            "1544365800",
            "179426.637"
        ],
        [
            "1544452200",
            "178335.044"
        ],
        [
            "1544538600",
            "183263.786"
        ],
        [
            "1544625000",
            "183384.385"
        ],
        [
            "1544711400",
            "183790.081"
        ],
        [
            "1544797800",
            "189211.628"
        ],
        [
            "1544884200",
            "186208.98"
        ],
        [
            "1544970600",
            "189176.899"
        ],
        [
            "1545057000",
            "185838.721"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1543674600,
        "offset": 0,
        "dasTable": "strconcur_live_F_time",
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "messages": [
            "Estimated data begins at 19/Dec/2018 02:00:00 GMT"
        ],
        "aggregation": 86400,
        "rtWindow": 1545184800,
        "endTimeInEpoch": 1545143400
    }
}

List Media Services Live HLS/HDS/DASH Ingest active streams delivery data

Retrieves all delivery data for active streams using Media Services Live HLS/HDS/DASH Ingest.

GET /media-reports/v1/msl3/passthrough/active-streams/delivery/data{?cpcodes}

Sample: /media-reports/v1/msl3/passthrough/active-streams/delivery/data?cpcodes=12345%2C67890

Parameter Type Sample Description
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Stream ID",
            "description": "Unique identifier associated with a stream generated by the Akamai provisioning workflow.",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream Name",
            "description": "Name associated with a stream generated by the Akamai provisioning workflow for Stream Packaging",
            "index": 1
        },
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "index": 2
        },
        {
            "type": "metric",
            "name": "Viewers",
            "id": 12053,
            "description": "Viewers for Delivery",
            "index": 3,
            "aggregate": "1961.62",
            "dataType": "count"
        },
        {
            "type": "metric",
            "name": "Egress Bit Rate",
            "id": 12052,
            "description": "Bit Rate Delivered",
            "index": 4,
            "aggregate": "1027.96",
            "unit": "Mbps",
            "dataType": "bandwidth"
        }
    ],
    "rows": [
        [
            "238460",
            "238460",
            "241065",
            "481.066667",
            "718.237539"
        ],
        [
            "224534",
            "224534",
            "403505",
            "406.45",
            "142.291114"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1551432600,
        "offset": 0,
        "limit": 10000,
        "timeZone": "GMT",
        "hasMoreData": false,
        "dataStore": null,
        "aggregation": 300,
        "endTimeInEpoch": 1551432900
    }
}

List Media Services Live HLS/HDS/DASH Ingest active streams ingest data

Retrieves all ingest data for active streams using Media Services Live HLS/HDS/DASH Ingest.

GET /media-reports/v1/msl3/passthrough/active-streams/ingest/data{?cpcodes}

Sample: /media-reports/v1/msl3/passthrough/active-streams/ingest/data?cpcodes=12345%2C67890

Parameter Type Sample Description
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Stream ID",
            "description": "Unique identifier associated with a stream generated by the Akamai provisioning workflow.",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream Name",
            "description": "Name associated with a stream generated by the Akamai provisioning workflow for Stream Packaging",
            "index": 1
        },
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "index": 2
        },
        {
            "type": "metric",
            "name": "Ingest bit rate",
            "id": 12050,
            "description": "Ingest bit rate",
            "index": 3,
            "aggregate": "336084.6",
            "unit": "kbps",
            "dataType": "bandwidth"
        }
    ],
    "rows": [
        [
            "650557",
            "650557",
            "569190",
            "106608.136"
        ],
        [
            "238460",
            "238460",
            "241065",
            "33818.136"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1551432900,
        "offset": 0,
        "limit": 10000,
        "timeZone": "GMT",
        "hasMoreData": false,
        "dataStore": null,
        "aggregation": 300,
        "endTimeInEpoch": 1551433200
    }
}

List Media Services Live HLS/HDS/DASH Ingest data stores

Retrieves all data stores for Media Services Live HLS/HDS/DASH Ingest.

GET /media-reports/v1/msl3/passthrough/data-stores

Status 200 application/json

Download schema: dataStore.json

Response Body:

[
    {
        "id": 10021,
        "name": "us_live_D_geoid",
        "type": "standard",
        "description": "Table for user location US graph",
        "dimensions": [
            {
                "id": 10000,
                "name": "Time",
                "description": "Indicates the consumption time of the content. This dimension is set automatically.",
                "helpText": "Indicates the consumption time of the content. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10001,
                "name": "CP Code",
                "description": "Identifier assigned to a contract associated with a particular stream.",
                "helpText": "Identifier assigned to a contract associated with a particular stream.",
                "dataType": "CPCODE",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10020,
                "name": "State",
                "description": "The geographic region ID (state, territory or province) based on the associated country.",
                "helpText": "The geographic region ID (state, territory or province) based on the associated country.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 10401,
                "name": "OK Hits",
                "type": "count",
                "description": "OK hits",
                "dataType": "COUNT",
                "displayName": "OK hits 2",
                "helpText": "OK hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10402,
                "name": "OK Volume",
                "unit": "MB",
                "type": "volume",
                "description": "OK Volume",
                "dataType": "VOLUME",
                "displayName": "OK Volume",
                "helpText": "OK Volume",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    },
    {
        "id": 10007,
        "name": "us_live_D_hit",
        "type": "standard",
        "description": "Table for Visitor graph",
        "dimensions": [
            {
                "id": 10001,
                "name": "CP Code",
                "description": "Identifier assigned to a contract associated with a particular stream.",
                "helpText": "Identifier assigned to a contract associated with a particular stream.",
                "dataType": "CPCODE",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10020,
                "name": "State",
                "description": "The geographic region ID (state, territory or province) based on the associated country.",
                "helpText": "The geographic region ID (state, territory or province) based on the associated country.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 10105,
                "name": "Hits",
                "type": "count",
                "description": "Total Hits",
                "dataType": "COUNT",
                "displayName": "Hits 1",
                "helpText": "Total Hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10106,
                "name": "Volume",
                "unit": "MB",
                "type": "volume",
                "description": "Total Bandwidth",
                "dataType": "VOLUME",
                "displayName": "Volume 1",
                "helpText": "Total Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10110,
                "name": "Hits",
                "type": "count",
                "description": "Total Hits",
                "dataType": "COUNT",
                "displayName": "Hits 2",
                "helpText": "Total Hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10111,
                "name": "Volume",
                "unit": "MB",
                "type": "volume",
                "description": "Total Bandwidth",
                "dataType": "VOLUME",
                "displayName": "Volume 2",
                "helpText": "Total Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get a Media Services Live HLS/HDS/DASH Ingest data store

Retrieve a specific HLS/HDS/DASH Ingest data store, using its unique dataStoreId.

GET /media-reports/v1/msl3/passthrough/data-stores/{dataStoreId}

Sample: /media-reports/v1/msl3/passthrough/data-stores/10021

Parameter Type Sample Description
URL parameters
dataStoreId Integer 10021 The unique dataStoreId value associated with the desired data store.

Status 200 application/json

Download schema: dataStore.json

Response Body:

{
    "id": 10021,
    "name": "us_live_D_geoid",
    "type": "standard",
    "description": "Table for user location US graph",
    "dimensions": [
        {
            "id": 10000,
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "helpText": "Indicates the consumption time of the content. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10001,
            "name": "CP Code",
            "description": "Identifier assigned to a contract associated with a particular stream.",
            "helpText": "Identifier assigned to a contract associated with a particular stream.",
            "dataType": "CPCODE",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10020,
            "name": "State",
            "description": "The geographic region (state, territory or province) based on the associated country.",
            "helpText": "The geographic region (state, territory or province) based on the associated country.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 10401,
            "name": "OK Hits",
            "type": "count",
            "description": "OK hits",
            "dataType": "COUNT",
            "displayName": "OK hits 1",
            "helpText": "OK hits",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10402,
            "name": "OK Volume",
            "unit": "MB",
            "type": "volume",
            "description": "OK Volume",
            "dataType": "VOLUME",
            "displayName": "OK Volume 1",
            "helpText": "OK Volume",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 86400,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

List Media Services Live HD Flash 1.0 metrics

Retrieves all metrics available for Media Services Live HD Flash 1.0.

GET /media-reports/v1/msl3/hdn1/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 123456,
        "name": "Average Bit rate",
        "unit": "count",
        "type": "count",
        "description": "Average amount of data transferred"
    },
    {
        "id": 123457,
        "name": "Average Buffer Time",
        "type": "count",
        "description": "Average Buffer Time"
    },
    {
        "id": 123458,
        "name": "Average Client Bandwidth",
        "type": "bandwidth",
        "description": "Average client Bandwidth"
    }
]

List Media Services Live HD Flash 1.0 dimensions

Retrieves all dimensions available for Media Services Live HD Flash 1.0.

GET /media-reports/v1/msl3/hdn1/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 12345,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 12346,
        "name": "Canadian Province",
        "description": "Canadian Province"
    }
]

List Media Services Live HD Flash 1.0 data

Retrieves data for Media Services Live HD Flash 1.0.

GET /media-reports/v1/msl3/hdn1/data{?startDate,endDate,ignorePutPost,cpcodes,enableCpCodeName}

Sample: /media-reports/v1/msl3/hdn1/data?startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&ignorePutPost=true&cpcodes=12345%2C67890&enableCpCodeName=true

Parameter Type Sample Description
Required query parameters
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
enableCpCodeName Boolean true When enabled, includes the name of the CP code in the output.
ignorePutPost Boolean true Specifies if the API should ignore ingest data when generating the response.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Concurrent Streams",
            "id": 123456,
            "description": "Sum of Average concurrent streams",
            "index": 1,
            "aggregate": "3141454.39"
        }
    ],
    "rows": [
        [
            "1543674600",
            "186575.959"
        ],
        [
            "1543761000",
            "185988.34"
        ],
        [
            "1543847400",
            "184741.378"
        ],
        [
            "1543933800",
            "180774.639"
        ],
        [
            "1544020200",
            "181598.317"
        ],
        [
            "1544106600",
            "184538.753"
        ],
        [
            "1544193000",
            "190988.807"
        ],
        [
            "1544279400",
            "187612.032"
        ],
        [
            "1544365800",
            "179426.637"
        ],
        [
            "1544452200",
            "178335.044"
        ],
        [
            "1544538600",
            "183263.786"
        ],
        [
            "1544625000",
            "183384.385"
        ],
        [
            "1544711400",
            "183790.081"
        ],
        [
            "1544797800",
            "189211.628"
        ],
        [
            "1544884200",
            "186208.98"
        ],
        [
            "1544970600",
            "189176.899"
        ],
        [
            "1545057000",
            "185838.721"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1543674600,
        "offset": 0,
        "dasTable": "strconcur_live_F_time",
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "messages": [
            "Estimated data begins at 19/Dec/2018 02:00:00 GMT"
        ],
        "aggregation": 86400,
        "rtWindow": 1545184800,
        "endTimeInEpoch": 1545143400
    }
}

List Media Services Live HD Flash 1.0 active streams delivery data

Retrieves delivery data for all active Media Services Live HD Flash 1.0 streams.

GET /media-reports/v1/msl3/hdn1/active-streams/delivery/data{?cpcodes}

Sample: /media-reports/v1/msl3/hdn1/active-streams/delivery/data?cpcodes=12345%2C67890

Parameter Type Sample Description
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Unique End Point",
            "description": "Stream Port Value",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream ID",
            "description": "The Stream Identifier",
            "index": 1
        },
        {
            "type": "dimension",
            "name": "Stream Name",
            "description": "Stream Port Value for Stream Name",
            "index": 2
        },
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "CPCode Mapping to Stream ID",
            "index": 3
        },
        {
            "type": "metric",
            "name": "Viewers",
            "id": 11001,
            "description": "Concurrent Viewers",
            "index": 4,
            "aggregate": "-",
            "peak": "-",
            "unit": "count",
            "dataType": "count"
        },
        {
            "type": "metric",
            "name": "Egress Bit rate",
            "id": 11005,
            "description": "Egress Bit rate",
            "index": 5,
            "aggregate": "-",
            "peak": "-",
            "unit": "Mbps",
            "dataType": "bandwidth"
        }
    ],
    "rows": [],
    "metaData": {
        "startTimeInEpoch": 1551432600,
        "offset": 0,
        "limit": 10000,
        "timeZone": "GMT",
        "hasMoreData": false,
        "dataStore": null,
        "aggregation": 300,
        "endTimeInEpoch": 1551432900
    }
}

List Media Services Live HD Flash 1.0 active streams ingest data

Retrieves ingest data for all active Media Services Live HD Flash 1.0 streams.

GET /media-reports/v1/msl3/hdn1/active-streams/ingest/data{?cpcodes}

Sample: /media-reports/v1/msl3/hdn1/active-streams/ingest/data?cpcodes=12345%2C67890

Parameter Type Sample Description
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Unique End Point",
            "description": "Stream Port Value for Bit Rate or Unique End Point",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream ID",
            "description": "Stream Port Value for Stream ID",
            "index": 1
        },
        {
            "type": "dimension",
            "name": "Stream Name",
            "description": "Stream Port Value for Stream Name",
            "index": 2
        },
        {
            "type": "dimension",
            "name": "Stream Type",
            "description": "Stream Port Value for Stream Type",
            "index": 3
        },
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "Filename to process for CP Code",
            "index": 4
        },
        {
            "type": "dimension",
            "name": "Encoder IP",
            "description": "Encoder IP",
            "index": 5
        },
        {
            "type": "dimension",
            "name": "Entry Point",
            "description": "Encoder IP",
            "index": 6
        },
        {
            "type": "metric",
            "name": "Average Bit rate",
            "id": 11000,
            "description": "Average amount of data transferred",
            "index": 7,
            "aggregate": "219357.19",
            "unit": "kbps",
            "dataType": "bandwidth"
        }
    ],
    "rows": [
        [
            "TSP_ARG_1080@198922",
            "TSP_ARG_1080@198922",
            "TSP_ARG_1080@198922",
            "0",
            "rt-str/20190301/581522/entrypoint_-_F_time",
            "186.0.207.42",
            "200.123.195.6",
            "4479.6"
        ],
        [
            "TSP_ARG_1080@198922",
            "TSP_ARG_1080@198922",
            "TSP_ARG_1080@198922",
            "1",
            "rt-str/20190301/581522/entrypoint_-_F_time",
            "200.61.14.42",
            "72.246.94.21",
            "4475"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1551432300,
        "offset": 0,
        "limit": 10000,
        "timeZone": "GMT",
        "hasMoreData": false,
        "dataStore": null,
        "aggregation": 300,
        "endTimeInEpoch": 1551432600
    }
}

List Media Services Live HD Flash 1.0 data stores

Retrieves all data stores for Media Services Live HD Flash 1.0.

GET /media-reports/v1/msl3/hdn1/data-stores

Status 200 application/json

Download schema: dataStore.json

Response Body:

[
    {
        "id": 10021,
        "name": "us_live_D_geoid",
        "type": "standard",
        "description": "Table for user location US graph",
        "dimensions": [
            {
                "id": 10000,
                "name": "Time",
                "description": "Indicates the consumption time of the content. This dimension is set automatically.",
                "helpText": "Indicates the consumption time of the content. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10001,
                "name": "CP Code",
                "description": "Identifier assigned to a contract associated with a particular stream.",
                "helpText": "Identifier assigned to a contract associated with a particular stream.",
                "dataType": "CPCODE",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10020,
                "name": "State",
                "description": "The geographic region ID (state, territory or province) based on the associated country.",
                "helpText": "The geographic region ID (state, territory or province) based on the associated country.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 10401,
                "name": "OK Hits",
                "type": "count",
                "description": "OK hits",
                "dataType": "COUNT",
                "displayName": "OK hits 2",
                "helpText": "OK hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10402,
                "name": "OK Volume",
                "unit": "MB",
                "type": "volume",
                "description": "OK Volume",
                "dataType": "VOLUME",
                "displayName": "OK Volume",
                "helpText": "OK Volume",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    },
    {
        "id": 10007,
        "name": "us_live_D_hit",
        "type": "standard",
        "description": "Table for Visitor graph",
        "dimensions": [
            {
                "id": 10001,
                "name": "CP Code",
                "description": "Identifier assigned to a contract associated with a particular stream.",
                "helpText": "Identifier assigned to a contract associated with a particular stream.",
                "dataType": "CPCODE",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10020,
                "name": "State",
                "description": "The geographic region ID (state, territory or province) based on the associated country.",
                "helpText": "The geographic region ID (state, territory or province) based on the associated country.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 10105,
                "name": "Hits",
                "type": "count",
                "description": "Total Hits",
                "dataType": "COUNT",
                "displayName": "Hits 1",
                "helpText": "Total Hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10106,
                "name": "Volume",
                "unit": "MB",
                "type": "volume",
                "description": "Total Bandwidth",
                "dataType": "VOLUME",
                "displayName": "Volume 1",
                "helpText": "Total Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10110,
                "name": "Hits",
                "type": "count",
                "description": "Total Hits",
                "dataType": "COUNT",
                "displayName": "Hits 2",
                "helpText": "Total Hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10111,
                "name": "Volume",
                "unit": "MB",
                "type": "volume",
                "description": "Total Bandwidth",
                "dataType": "VOLUME",
                "displayName": "Volume 2",
                "helpText": "Total Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get a Media Services Live HD Flash 1.0 data store

Retrieve a specific HD Flash 1.0 data store, using its unique dataStoreId.

GET /media-reports/v1/msl3/hdn1/data-stores/{dataStoreId}

Sample: /media-reports/v1/msl3/hdn1/data-stores/10070

Parameter Type Sample Description
URL parameters
dataStoreId Integer 10070 The unique dataStoreId value associated with the desired data store.

Status 200 application/json

Download schema: dataStore.json

Response Body:

{
    "id": 10021,
    "name": "us_live_D_geoid",
    "type": "standard",
    "description": "Table for user location US graph",
    "dimensions": [
        {
            "id": 10000,
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "helpText": "Indicates the consumption time of the content. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10001,
            "name": "CP Code",
            "description": "Identifier assigned to a contract associated with a particular stream.",
            "helpText": "Identifier assigned to a contract associated with a particular stream.",
            "dataType": "CPCODE",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10020,
            "name": "State",
            "description": "The geographic region (state, territory or province) based on the associated country.",
            "helpText": "The geographic region (state, territory or province) based on the associated country.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 10401,
            "name": "OK Hits",
            "type": "count",
            "description": "OK hits",
            "dataType": "COUNT",
            "displayName": "OK hits 1",
            "helpText": "OK hits",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10402,
            "name": "OK Volume",
            "unit": "MB",
            "type": "volume",
            "description": "OK Volume",
            "dataType": "VOLUME",
            "displayName": "OK Volume 1",
            "helpText": "OK Volume",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 86400,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

List Media Services Live RTMP metrics

Retrieves all of the metrics available for Media Services Live RTMP.

GET /media-reports/v1/msl3/rtmp/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 123456,
        "name": "Average Bit rate",
        "unit": "count",
        "type": "count",
        "description": "Average amount of data transferred"
    },
    {
        "id": 123457,
        "name": "Average Buffer Time",
        "type": "count",
        "description": "Average Buffer Time"
    },
    {
        "id": 123458,
        "name": "Average Client Bandwidth",
        "type": "bandwidth",
        "description": "Average client Bandwidth"
    }
]

List Media Services Live RTMP dimensions

Retrieves all of the dimensions available for Media Services Live RTMP.

GET /media-reports/v1/msl3/rtmp/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 12345,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 12346,
        "name": "Canadian Province",
        "description": "Canadian Province"
    }
]

List Media Services Live RTMP active streams delivery data

Retrieves delivery data for all active Media Services Live RTMP streams.

GET /media-reports/v1/msl3/rtmp/active-streams/delivery/data{?cpcodes}

Sample: /media-reports/v1/msl3/rtmp/active-streams/delivery/data?cpcodes=12345%2C67890

Parameter Type Sample Description
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Unique End Point",
            "description": "Stream Port Value for Bit Rate or Unique End Point",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream ID",
            "description": "Stream Port Value for Stream ID",
            "index": 1
        },
        {
            "type": "dimension",
            "name": "Stream Name",
            "description": "Stream Port Value for Stream Name",
            "index": 2
        },
        {
            "type": "dimension",
            "name": "Stream Type",
            "description": "Stream Port Value for Stream Type",
            "index": 3
        },
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "Filename to process for CP Code",
            "index": 4
        },
        {
            "type": "dimension",
            "name": "Encoder IP",
            "description": "Encoder IP",
            "index": 5
        },
        {
            "type": "dimension",
            "name": "Entry Point",
            "description": "Encoder IP",
            "index": 6
        },
        {
            "type": "metric",
            "name": "Average Bit rate",
            "id": 10300,
            "description": "Average amount of data transferred",
            "index": 7,
            "aggregate": "88136.2",
            "unit": "kbps",
            "dataType": "bandwidth"
        }
    ],
    "rows": [
        [
            "test_betshop@s359703",
            "test_betshop@s359703",
            "test_betshop@s359703",
            "1",
            "rt-str/20190301/37665/entrypoint_-_F_time",
            "185.188.53.1",
            "23.46.208.101",
            "1544"
        ],
        [
            "basketball_usa_nba_retail_15328552_1364k@s655711",
            "basketball_usa_nba_retail_15328552_1364k@s655711",
            "basketball_usa_nba_retail_15328552_1364k@s655711",
            "1",
            "rt-str/20190301/353594/entrypoint_-_F_time",
            "91.201.212.251",
            "2.17.36.86",
            "1356"
        ],
        [
            "basketball_usa_nba_retail_15328552_1364k@s655711",
            "basketball_usa_nba_retail_15328552_1364k@s655711",
            "basketball_usa_nba_retail_15328552_1364k@s655711",
            "0",
            "rt-str/20190301/353594/entrypoint_-_F_time",
            "91.201.212.251",
            "95.101.37.12",
            "1355"
        ],
        [
            "basketball_usa_nba_retail_15330080_1364k@s655700",
            "basketball_usa_nba_retail_15330080_1364k@s655700",
            "basketball_usa_nba_retail_15330080_1364k@s655700",
            "1",
            "rt-str/20190301/353594/entrypoint_-_F_time",
            "91.201.212.251",
            "88.221.86.13",
            "1345.8"
        ],
        [
            "basketball_usa_nba_retail_15328938_1364k@s655689",
            "basketball_usa_nba_retail_15328938_1364k@s655689",
            "basketball_usa_nba_retail_15328938_1364k@s655689",
            "0",
            "rt-str/20190301/353594/entrypoint_-_F_time",
            "91.201.212.251",
            "95.101.170.170",
            "1316"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1551408300,
        "offset": 0,
        "limit": 10000,
        "timeZone": "GMT",
        "hasMoreData": false,
        "dataStore": null,
        "aggregation": 300,
        "endTimeInEpoch": "1551408600"
    }
}

List Media Services Live RTMP active streams ingest data

Retrieves ingest data for all active Media Services Live RTMP streams.

GET /media-reports/v1/msl3/rtmp/active-streams/ingest/data{?cpcodes}

Sample: /media-reports/v1/msl3/rtmp/active-streams/ingest/data?cpcodes=12345%2C67890

Parameter Type Sample Description
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Unique End Point",
            "description": "Stream Port Value",
            "index": 0
        },
        {
            "type": "dimension",
            "name": "Stream ID",
            "description": "The Stream Identifier",
            "index": 1
        },
        {
            "type": "dimension",
            "name": "Stream Name",
            "description": "Stream Port Value for Stream Name",
            "index": 2
        },
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "CPCode Mapping to Stream ID",
            "index": 3
        },
        {
            "type": "metric",
            "name": "Viewers",
            "id": 10301,
            "description": "Concurrent Viewers",
            "index": 4,
            "aggregate": "2328.6",
            "unit": "count",
            "dataType": "count"
        },
        {
            "type": "metric",
            "name": "Egress Bit rate",
            "id": 10305,
            "description": "Egress Bit rate",
            "index": 5,
            "aggregate": "1415.15",
            "unit": "Mbps",
            "dataType": "bandwidth"
        }
    ],
    "rows": [
        [
            "avup_single_123@s752713",
            "avup_single_123@s752713",
            "avup_single_123@s752713",
            "rt-str/20190301/508682/service_live_F_time",
            "628.2",
            "410.322822"
        ],
        [
            "avup_single_6@s752595",
            "avup_single_6@s752595",
            "avup_single_6@s752595",
            "rt-str/20190301/508682/service_live_F_time",
            "553",
            "353.547219"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1551408300,
        "offset": 0,
        "limit": 10000,
        "timeZone": "GMT",
        "hasMoreData": false,
        "dataStore": null,
        "aggregation": 300,
        "endTimeInEpoch": 1551408600
    }
}

List Media Services Live RTMP data

Retrieves data for Media Services Live RTMP.

GET /media-reports/v1/msl3/rtmp/data{?startDate,endDate,ignoreEdgeFlash,cpcodes,enableCpCodeName}

Sample: /media-reports/v1/msl3/rtmp/data?startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&ignoreEdgeFlash=true&cpcodes=12345%2C67890&enableCpCodeName=true

Parameter Type Sample Description
Required query parameters
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
enableCpCodeName Boolean true When enabled, includes the name of the CP code in the output.
ignoreEdgeFlash Boolean true Limits data to ignore edge flash data.

Status 200 application/json

Download schema: Msl3RtmpData.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Concurrent Streams",
            "id": 123456,
            "description": "Sum of Average concurrent streams",
            "index": 1,
            "aggregate": "3141454.39"
        }
    ],
    "rows": [
        [
            "1543674600",
            "186575.959"
        ],
        [
            "1543761000",
            "185988.34"
        ],
        [
            "1543847400",
            "184741.378"
        ],
        [
            "1543933800",
            "180774.639"
        ],
        [
            "1544020200",
            "181598.317"
        ],
        [
            "1544106600",
            "184538.753"
        ],
        [
            "1544193000",
            "190988.807"
        ],
        [
            "1544279400",
            "187612.032"
        ],
        [
            "1544365800",
            "179426.637"
        ],
        [
            "1544452200",
            "178335.044"
        ],
        [
            "1544538600",
            "183263.786"
        ],
        [
            "1544625000",
            "183384.385"
        ],
        [
            "1544711400",
            "183790.081"
        ],
        [
            "1544797800",
            "189211.628"
        ],
        [
            "1544884200",
            "186208.98"
        ],
        [
            "1544970600",
            "189176.899"
        ],
        [
            "1545057000",
            "185838.721"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1543674600,
        "offset": 0,
        "dasTable": "strconcur_live_F_time",
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "messages": [
            "Estimated data begins at 19/Dec/2018 02:00:00 GMT"
        ],
        "aggregation": 86400,
        "rtWindow": 1545184800,
        "endTimeInEpoch": 1545143400
    }
}

List Media Services Live RTMP data stores

Retrieves all data stores for Media Services Live RTMP.

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

Status 200 application/json

Download schema: dataStore.json

Response Body:

[
    {
        "id": 10021,
        "name": "us_live_D_geoid",
        "type": "standard",
        "description": "Table for user location US graph",
        "dimensions": [
            {
                "id": 10000,
                "name": "Time",
                "description": "Indicates the consumption time of the content. This dimension is set automatically.",
                "helpText": "Indicates the consumption time of the content. This dimension is set automatically.",
                "dataType": "TIME",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10001,
                "name": "CP Code",
                "description": "Identifier assigned to a contract associated with a particular stream.",
                "helpText": "Identifier assigned to a contract associated with a particular stream.",
                "dataType": "CPCODE",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10020,
                "name": "State",
                "description": "The geographic region ID (state, territory or province) based on the associated country.",
                "helpText": "The geographic region ID (state, territory or province) based on the associated country.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 10401,
                "name": "OK Hits",
                "type": "count",
                "description": "OK hits",
                "dataType": "COUNT",
                "displayName": "OK hits 2",
                "helpText": "OK hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10402,
                "name": "OK Volume",
                "unit": "MB",
                "type": "volume",
                "description": "OK Volume",
                "dataType": "VOLUME",
                "displayName": "OK Volume",
                "helpText": "OK Volume",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    },
    {
        "id": 10007,
        "name": "us_live_D_hit",
        "type": "standard",
        "description": "Table for Visitor graph",
        "dimensions": [
            {
                "id": 10001,
                "name": "CP Code",
                "description": "Identifier assigned to a contract associated with a particular stream.",
                "helpText": "Identifier assigned to a contract associated with a particular stream.",
                "dataType": "CPCODE",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10020,
                "name": "State",
                "description": "The geographic region ID (state, territory or province) based on the associated country.",
                "helpText": "The geographic region ID (state, territory or province) based on the associated country.",
                "dataType": "NUMBER",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "metrics": [
            {
                "id": 10105,
                "name": "Hits",
                "type": "count",
                "description": "Total Hits",
                "dataType": "COUNT",
                "displayName": "Hits 1",
                "helpText": "Total Hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10106,
                "name": "Volume",
                "unit": "MB",
                "type": "volume",
                "description": "Total Bandwidth",
                "dataType": "VOLUME",
                "displayName": "Volume 1",
                "helpText": "Total Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10110,
                "name": "Hits",
                "type": "count",
                "description": "Total Hits",
                "dataType": "COUNT",
                "displayName": "Hits 2",
                "helpText": "Total Hits",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            },
            {
                "id": 10111,
                "name": "Volume",
                "unit": "MB",
                "type": "volume",
                "description": "Total Bandwidth",
                "dataType": "VOLUME",
                "displayName": "Volume 2",
                "helpText": "Total Bandwidth",
                "group": [
                    {
                        "id": -1,
                        "name": "OTHERS",
                        "description": "OTHERS"
                    }
                ]
            }
        ],
        "aggregationInSeconds": 86400,
        "purgeIntervalInDays": 90,
        "maxQueryDurationInMinutes": 44640
    }
]

Get a Media Services Live RTMP data store

Retrieve a specific RTMP data store, using its unique dataStoreId.

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

Sample: /media-reports/v1/msl3/rtmp/data-stores/10028

Parameter Type Sample Description
URL parameters
dataStoreId Integer 10028 The unique dataStoreId value associated with the desired data store.

Status 200 application/json

Download schema: dataStore.json

Response Body:

{
    "id": 10021,
    "name": "us_live_D_geoid",
    "type": "standard",
    "description": "Table for user location US graph",
    "dimensions": [
        {
            "id": 10000,
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "helpText": "Indicates the consumption time of the content. This dimension is set automatically.",
            "dataType": "TIME",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10001,
            "name": "CP Code",
            "description": "Identifier assigned to a contract associated with a particular stream.",
            "helpText": "Identifier assigned to a contract associated with a particular stream.",
            "dataType": "CPCODE",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10020,
            "name": "State",
            "description": "The geographic region (state, territory or province) based on the associated country.",
            "helpText": "The geographic region (state, territory or province) based on the associated country.",
            "dataType": "NUMBER",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "metrics": [
        {
            "id": 10401,
            "name": "OK Hits",
            "type": "count",
            "description": "OK hits",
            "dataType": "COUNT",
            "displayName": "OK hits 1",
            "helpText": "OK hits",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        },
        {
            "id": 10402,
            "name": "OK Volume",
            "unit": "MB",
            "type": "volume",
            "description": "OK Volume",
            "dataType": "VOLUME",
            "displayName": "OK Volume 1",
            "helpText": "OK Volume",
            "group": [
                {
                    "id": -1,
                    "name": "OTHERS",
                    "description": "OTHERS"
                }
            ]
        }
    ],
    "aggregationInSeconds": 86400,
    "purgeIntervalInDays": 90,
    "maxQueryDurationInMinutes": 44640
}

List Media Services On Demand RTMP dimensions

Retrieves all of the dimensions available for Media Services On Demand RTMP.

GET /media-reports/v1/msod/msod-rtmp/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 19001,
        "name": "CP Code",
        "description": "Identifier assigned to a contract associated with a particular stream."
    },
    {
        "id": 19011,
        "name": "Canadian Province",
        "description": "Canadian Province"
    },
    {
        "id": 19009,
        "name": "Country",
        "description": "Country"
    },
    {
        "id": 19004,
        "name": "Domain",
        "description": "domain"
    },
    {
        "id": 19005,
        "name": "IP",
        "description": "clientip"
    },
    {
        "id": 19008,
        "name": "Language",
        "description": "Browser"
    },
    {
        "id": 19501,
        "name": "Level",
        "description": "Level"
    },
    {
        "id": 19006,
        "name": "OS",
        "description": "OS"
    },
    {
        "id": 19003,
        "name": "Player",
        "description": "Player"
    },
    {
        "id": 19007,
        "name": "Player Id",
        "description": "playerid"
    },
    {
        "id": 19010,
        "name": "State",
        "description": "State"
    },
    {
        "id": 19500,
        "name": "Subdirectories",
        "description": "Subdirectories"
    },
    {
        "id": 19000,
        "name": "Time",
        "description": "Indicates the consumption time of the content. This dimension is set automatically."
    },
    {
        "id": 19012,
        "name": "URL",
        "description": "URL"
    }
]

List Media Services On Demand RTMP metrics

Retrieves all of the metrics available for Media Services On Demand RTMP.

GET /media-reports/v1/msod/msod-rtmp/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 19509,
        "name": "0xx",
        "type": "count",
        "description": "0xx"
    },
    {
        "id": 19213,
        "name": "200",
        "type": "count",
        "description": "200"
    },
    {
        "id": 19214,
        "name": "206",
        "type": "count",
        "description": "206"
    },
    {
        "id": 19510,
        "name": "2xx",
        "type": "count",
        "description": "2xx"
    },
    {
        "id": 19216,
        "name": "302",
        "type": "count",
        "description": "302"
    },
    {
        "id": 19217,
        "name": "304",
        "type": "count",
        "description": "304"
    },
    {
        "id": 19511,
        "name": "3xx",
        "type": "count",
        "description": "3xx"
    },
    {
        "id": 19221,
        "name": "401",
        "type": "count",
        "description": "401"
    },
    {
        "id": 19219,
        "name": "404",
        "type": "count",
        "description": "404"
    },
    {
        "id": 19222,
        "name": "408",
        "type": "count",
        "description": "408"
    },
    {
        "id": 19512,
        "name": "4xx",
        "type": "count",
        "description": "4xx"
    },
    {
        "id": 19513,
        "name": "5xx",
        "type": "count",
        "description": "5xx"
    },
    {
        "id": 19514,
        "name": "6xx",
        "type": "count",
        "description": "6xx"
    },
    {
        "id": 19107,
        "name": "Average Buffer Time",
        "type": "count",
        "description": "Average Buffer Time"
    },
    {
        "id": 19102,
        "name": "Average Client Bandwidth",
        "type": "bandwidth",
        "description": "Average client Bandwidth"
    },
    {
        "id": 19101,
        "name": "Average Client Bandwidth in kilobits/sec",
        "unit": "kbps",
        "type": "bandwidth",
        "description": "Average client bandwidth in kbps"
    },
    {
        "id": 19109,
        "name": "Average Clip Play Time",
        "type": "count",
        "description": "Average Play Time"
    },
    {
        "id": 19108,
        "name": "Average Packet Loss",
        "type": "count",
        "description": "Average Packet Loss"
    },
    {
        "id": 19016,
        "name": "Average Play Time",
        "unit": "seconds",
        "type": "time",
        "description": "Average Play Time"
    },
    {
        "id": 19001,
        "name": "Avg Concurrent Streams",
        "type": "count",
        "description": "Sum of Average concurrent streams"
    },
    {
        "id": 19507,
        "name": "Avg Sec",
        "unit": "sec",
        "type": "count",
        "description": "Avg Sec"
    },
    {
        "id": 19210,
        "name": "Avg Secs.",
        "type": "count",
        "description": "Avg. Secs."
    },
    {
        "id": 19522,
        "name": "Avg. Secs. Per Day",
        "type": "count",
        "description": "Avg. Secs. Per Day"
    },
    {
        "id": 19007,
        "name": "Client Disconnect Hits",
        "type": "count",
        "description": "Client Disconnect [408]"
    },
    {
        "id": 19011,
        "name": "Client-Abort Hits",
        "unit": "count",
        "type": "count",
        "description": "No Status"
    },
    {
        "id": 19002,
        "name": "Edge Bandwidth",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Edge Bandwidth"
    },
    {
        "id": 19005,
        "name": "Edge Traffic in hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Sum Egress per second"
    },
    {
        "id": 19017,
        "name": "Edge Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Edge Volume"
    },
    {
        "id": 19201,
        "name": "Error Hits",
        "type": "count",
        "description": "Error hits"
    },
    {
        "id": 19503,
        "name": "Error Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Error Volume"
    },
    {
        "id": 19517,
        "name": "Error Volume Per Day",
        "unit": "MB",
        "type": "volume",
        "description": "Error Volume Per Day"
    },
    {
        "id": 19014,
        "name": "Flash Session Bytes",
        "unit": "MB",
        "type": "volume",
        "description": "Flash Session Bytes"
    },
    {
        "id": 19209,
        "name": "GUIDs",
        "type": "count",
        "description": "Guids"
    },
    {
        "id": 19521,
        "name": "GUIDs Per Day",
        "type": "count",
        "description": "GUIDs Per Day"
    },
    {
        "id": 19506,
        "name": "Guids",
        "type": "count",
        "description": "Guids"
    },
    {
        "id": 19105,
        "name": "Hits",
        "type": "count",
        "description": "Hits"
    },
    {
        "id": 19505,
        "name": "IPs",
        "type": "count",
        "description": "Ips"
    },
    {
        "id": 19520,
        "name": "Ips Per Day",
        "type": "count",
        "description": "Ips Per Day"
    },
    {
        "id": 19000,
        "name": "Max Concurrent Streams",
        "type": "count",
        "description": "Sum of Max concurrent streams"
    },
    {
        "id": 19008,
        "name": "Not-Found Hits",
        "type": "count",
        "description": "Not Found [404]"
    },
    {
        "id": 19401,
        "name": "OK Hits",
        "type": "count",
        "description": "OK hits"
    },
    {
        "id": 19402,
        "name": "OK Volume",
        "unit": "MB",
        "type": "volume",
        "description": "OK Volume"
    },
    {
        "id": 19518,
        "name": "OK volume per day",
        "unit": "MB",
        "type": "volume",
        "description": "OK volume per day"
    },
    {
        "id": 19012,
        "name": "Other Hits",
        "type": "count",
        "description": "Other [ All other status codes]"
    },
    {
        "id": 19504,
        "name": "Peak Conn.",
        "type": "count",
        "description": "Peak Conn."
    },
    {
        "id": 19519,
        "name": "Peak Conn. Per Day",
        "type": "count",
        "description": "Peak Conn. Per Day"
    },
    {
        "id": 19009,
        "name": "Permission Hits",
        "type": "count",
        "description": "Permission [400|401|403|433|434]"
    },
    {
        "id": 19508,
        "name": "Secs",
        "type": "count",
        "description": "Secs"
    },
    {
        "id": 19523,
        "name": "Secs Per Day",
        "type": "count",
        "description": "Secs Per Day"
    },
    {
        "id": 19013,
        "name": "Server-Disconnect Hits",
        "type": "count",
        "description": "Server-Disconnect Hits"
    },
    {
        "id": 19010,
        "name": "Server-Source-Error Hits",
        "type": "count",
        "description": "Server Error"
    },
    {
        "id": 19516,
        "name": "SubDirectories hits per day",
        "type": "count",
        "description": "SubDirectories hits by date"
    },
    {
        "id": 19004,
        "name": "Total Hits",
        "type": "count",
        "description": "Total Hits"
    },
    {
        "id": 19015,
        "name": "Total Play Time",
        "unit": "seconds",
        "type": "time",
        "description": "Play Time Interval"
    },
    {
        "id": 19003,
        "name": "Total Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Total Volume"
    },
    {
        "id": 19515,
        "name": "Total Volume Per Day",
        "unit": "MB",
        "type": "volume",
        "description": "Total Volume Per Day"
    },
    {
        "id": 19226,
        "name": "URL hits per day",
        "type": "count",
        "description": "URL hits by date"
    },
    {
        "id": 19524,
        "name": "URL hits per day for 0xx status code",
        "type": "count",
        "description": "Total URL hits for 0xx status code"
    },
    {
        "id": 19235,
        "name": "URL hits per day for 200 status code",
        "type": "count",
        "description": "URL hits by date for 200 status code"
    },
    {
        "id": 19236,
        "name": "URL hits per day for 206 status code",
        "type": "count",
        "description": "Total URL hits for 206 status code"
    },
    {
        "id": 19525,
        "name": "URL hits per day for 2xx status code",
        "type": "count",
        "description": "Total URL hits for 2xx status code"
    },
    {
        "id": 19238,
        "name": "URL hits per day for 302 status code",
        "type": "count",
        "description": "URL hits by date for 302 status code"
    },
    {
        "id": 19239,
        "name": "URL hits per day for 304 status code",
        "type": "count",
        "description": "URL hits by date for 304 status code"
    },
    {
        "id": 19526,
        "name": "URL hits per day for 3xx status code",
        "type": "count",
        "description": "Total URL hits for 3xx status code"
    },
    {
        "id": 19243,
        "name": "URL hits per day for 401 status code",
        "type": "count",
        "description": "Total URL hits for 401 status code"
    },
    {
        "id": 19241,
        "name": "URL hits per day for 404 status code",
        "type": "count",
        "description": "URL hits by date for 404 status code"
    },
    {
        "id": 19244,
        "name": "URL hits per day for 408 status code",
        "type": "count",
        "description": "URL hits by date for 408 status code"
    },
    {
        "id": 19527,
        "name": "URL hits per day for 4xx status code",
        "type": "count",
        "description": "Total URL hits for 4xx status code"
    },
    {
        "id": 19528,
        "name": "URL hits per day for 5xx status code",
        "type": "count",
        "description": "URL hits by date for 5xx status code"
    },
    {
        "id": 19529,
        "name": "URL hits per day for 6xx status code",
        "type": "count",
        "description": "Total URL hits for 6xx status code"
    },
    {
        "id": 19103,
        "name": "Unique Client IP",
        "type": "count",
        "description": "Unique Client IP"
    },
    {
        "id": 19112,
        "name": "Unique ClientIPs",
        "type": "count",
        "description": "Unique ClientIPs"
    },
    {
        "id": 19104,
        "name": "Unique Player ID",
        "type": "count",
        "description": "Unique Player ID"
    },
    {
        "id": 19100,
        "name": "Unique Visitor",
        "type": "count",
        "description": "Visitors"
    },
    {
        "id": 19106,
        "name": "Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Total Bandwidth"
    }
]

List Media Service On Demand RTMP data

Retrieves all data for Media Services On Demand RTMP.

GET /media-reports/v1/msod/msod-rtmp/data{?startDate,endDate,ignorePutPost,ignoreEdgeFlash,cpcodes}

Sample: /media-reports/v1/msod/msod-rtmp/data?startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&ignorePutPost=true&ignoreEdgeFlash=true&cpcodes=12345%2C67890

Parameter Type Sample Description
Required query parameters
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
ignoreEdgeFlash Boolean true Limits data to ignore edge flash data.
ignorePutPost Boolean true Specifies if the API should ignore ingest data when generating the response.

Status 200 application/json

Download schema: OnDemand-RTMP.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content. This dimension is set automatically.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Avg Concurrent Streams",
            "id": 19001,
            "description": "Sum of Average concurrent streams",
            "index": 1
        }
    ],
    "rows": [
        [
            "1543674600",
            "0.494"
        ],
        [
            "1543761000",
            "0.7"
        ],
        [
            "1543847400",
            "0.296"
        ],
        [
            "1543933800",
            "0.967"
        ],
        [
            "1544020200",
            "1.586"
        ],
        [
            "1544106600",
            "0.863"
        ],
        [
            "1544193000",
            "0.19"
        ],
        [
            "1544279400",
            "0.303"
        ],
        [
            "1544365800",
            "20.581"
        ],
        [
            "1544452200",
            "1.088"
        ],
        [
            "1544538600",
            "0.715"
        ],
        [
            "1544625000",
            "396.926"
        ],
        [
            "1544711400",
            "1151.529"
        ],
        [
            "1544797800",
            "1227.751"
        ],
        [
            "1544884200",
            "1240.823"
        ],
        [
            "1544970600",
            "1258.008"
        ],
        [
            "1545057000",
            "755.61"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1543674600,
        "offset": 0,
        "dasTable": "strconcur_vod_F_time",
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "messages": [
            "Estimated data begins at 18/Dec/2018 05:00:00 GMT"
        ],
        "aggregation": 86400,
        "rtWindow": 1545109200,
        "endTimeInEpoch": 1545143400
    }
}

List Progressive Media Delivery dimensions

Retrieves all of the dimensions available for Progressive Media Delivery.

GET /media-reports/v1/msod/pmd/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "id": 22005,
        "name": "Browser",
        "description": "Browser"
    },
    {
        "id": 22002,
        "name": "CP Code",
        "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served."
    },
    {
        "id": 22011,
        "name": "Canadian Province",
        "description": "Canadian Province"
    },
    {
        "id": 22009,
        "name": "Country",
        "description": "Country"
    },
    {
        "id": 22006,
        "name": "Domain",
        "description": "domain"
    },
    {
        "id": 22004,
        "name": "IP",
        "description": "client_ip"
    },
    {
        "id": 22008,
        "name": "OS",
        "description": "OS"
    },
    {
        "id": 22010,
        "name": "State",
        "description": "State"
    },
    {
        "id": 22003,
        "name": "Status Code",
        "description": "Response status code."
    },
    {
        "id": 22001,
        "name": "Time",
        "description": "Indicates the consumption time of the content. This dimension is set automatically."
    },
    {
        "id": 22012,
        "name": "URL",
        "description": "URL"
    },
    {
        "id": 22007,
        "name": "User Agent",
        "description": "user_agent"
    }
]

List Progressive Media Delivery metrics

Retrieves all of the metrics available for Progressive Media Delivery.

GET /media-reports/v1/msod/pmd/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "id": 22206,
        "name": "0xx",
        "type": "count",
        "description": "0xx"
    },
    {
        "id": 22221,
        "name": "0xx Hits",
        "type": "count",
        "description": "0xx Hits"
    },
    {
        "id": 22208,
        "name": "200",
        "type": "count",
        "description": "200"
    },
    {
        "id": 22209,
        "name": "206",
        "type": "count",
        "description": "206"
    },
    {
        "id": 22223,
        "name": "206 Hits",
        "type": "count",
        "description": "206 Hits"
    },
    {
        "id": 22207,
        "name": "2xx",
        "type": "count",
        "description": "2xx"
    },
    {
        "id": 22222,
        "name": "2xx Hits",
        "type": "count",
        "description": "2xx Hits"
    },
    {
        "id": 22211,
        "name": "302",
        "type": "count",
        "description": "302"
    },
    {
        "id": 22225,
        "name": "302 Hits",
        "type": "count",
        "description": "302 Hits"
    },
    {
        "id": 22212,
        "name": "304",
        "type": "count",
        "description": "304"
    },
    {
        "id": 22226,
        "name": "304 Hits",
        "type": "count",
        "description": "304 Hits"
    },
    {
        "id": 22210,
        "name": "3xx",
        "type": "count",
        "description": "3xx"
    },
    {
        "id": 22224,
        "name": "3xx Hits",
        "type": "count",
        "description": "3xx Hits"
    },
    {
        "id": 22214,
        "name": "404",
        "type": "count",
        "description": "404"
    },
    {
        "id": 22228,
        "name": "404 Hits",
        "type": "count",
        "description": "404 Hits"
    },
    {
        "id": 22213,
        "name": "4xx",
        "type": "count",
        "description": "4xx"
    },
    {
        "id": 22227,
        "name": "4xx Hits",
        "type": "count",
        "description": "4xx Hits"
    },
    {
        "id": 22220,
        "name": "All Error Hits",
        "type": "count",
        "description": "All Error Hits"
    },
    {
        "id": 22218,
        "name": "All Hits",
        "type": "count",
        "description": "All Hits"
    },
    {
        "id": 22219,
        "name": "All OK Hits",
        "type": "count",
        "description": "All OK Hits"
    },
    {
        "id": 22028,
        "name": "Edge 403 Hits",
        "unit": "count",
        "type": "count",
        "description": "Edge 403 Hits"
    },
    {
        "id": 22029,
        "name": "Edge 404 Hits",
        "unit": "count",
        "type": "count",
        "description": "Edge 404 Hits"
    },
    {
        "id": 22021,
        "name": "Edge Bandwidth",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Edge Bandwidth"
    },
    {
        "id": 22027,
        "name": "Edge Client Abort Hits",
        "unit": "count",
        "type": "count",
        "description": "Edge Client Abort Hits [000]"
    },
    {
        "id": 22103,
        "name": "Edge Hits",
        "type": "count",
        "description": "Edge hits"
    },
    {
        "id": 22026,
        "name": "Edge Redirect Hits",
        "unit": "count",
        "type": "count",
        "description": "Edge Redirect Hits [301|302]"
    },
    {
        "id": 22002,
        "name": "Edge Response",
        "unit": "MB",
        "type": "volume",
        "description": "Edge Response"
    },
    {
        "id": 22006,
        "name": "Edge Traffic in hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Sum Egress per second"
    },
    {
        "id": 22102,
        "name": "Edge Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Edge volume"
    },
    {
        "id": 22205,
        "name": "Error Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Error Volume"
    },
    {
        "id": 22202,
        "name": "Error hits",
        "type": "count",
        "description": "Error hits"
    },
    {
        "id": 22013,
        "name": "Forbidden Hits",
        "unit": "count",
        "type": "count",
        "description": "Forbidden [403]"
    },
    {
        "id": 22014,
        "name": "Forbidden Hits Traffic",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Forbidden [403] Traffic"
    },
    {
        "id": 22025,
        "name": "Hits",
        "type": "count",
        "description": "Hits"
    },
    {
        "id": 22022,
        "name": "Midgress Bandwidth",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Midgress Bandwidth"
    },
    {
        "id": 22004,
        "name": "Midgress Responses",
        "unit": "MB",
        "type": "volume",
        "description": "Midgress Responses"
    },
    {
        "id": 22034,
        "name": "Not-Found: 404 Traffic",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Not-Found: 404 Traffic"
    },
    {
        "id": 22009,
        "name": "Not-Modified Hits",
        "unit": "count",
        "type": "count",
        "description": "Not-Modified [304]"
    },
    {
        "id": 22203,
        "name": "OK hits",
        "type": "count",
        "description": "OK hits"
    },
    {
        "id": 22215,
        "name": "Offloaded Hits",
        "type": "count",
        "description": "Offloaded Hits"
    },
    {
        "id": 22204,
        "name": "OK Edge Volume",
        "unit": "MB",
        "type": "volume",
        "description": "OK Edge Volume"
    },
    {
        "id": 22017,
        "name": "OK Hits",
        "unit": "count",
        "type": "count",
        "description": "OK [200|206|210]"
    },
    {
        "id": 22036,
        "name": "OK Hits/sec",
        "unit": "count",
        "type": "count",
        "description": "OK [200|206|210]"
    },
    {
        "id": 22104,
        "name": "OK Volume",
        "unit": "MB",
        "type": "volume",
        "description": "OK Volume"
    },
    {
        "id": 22031,
        "name": "Origin 304 Hits",
        "unit": "count",
        "type": "count",
        "description": "Origin 304 Hits"
    },
    {
        "id": 22030,
        "name": "Origin 404 Hits",
        "unit": "count",
        "type": "count",
        "description": "Origin 404 Hits"
    },
    {
        "id": 22038,
        "name": "Origin 404 Hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Origin 404 Hits"
    },
    {
        "id": 22015,
        "name": "Origin Bandwidth",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Origin Bandwidth"
    },
    {
        "id": 22020,
        "name": "Origin Bandwidth Offload",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Sum Origin Bandwidth Offload  per second"
    },
    {
        "id": 22216,
        "name": "Origin Hits",
        "type": "count",
        "description": "Origin Hits"
    },
    {
        "id": 22032,
        "name": "Origin Redirect: 301/302 Hits",
        "unit": "count",
        "type": "count",
        "description": "Origin Redirect: 301/302 Hits"
    },
    {
        "id": 22039,
        "name": "Origin Redirect: 301/302 Hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Origin Redirect: 301/302 Hits"
    },
    {
        "id": 22003,
        "name": "Origin Response",
        "unit": "MB",
        "type": "volume",
        "description": "Origin Response"
    },
    {
        "id": 22040,
        "name": "Origin Server Error Hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Origin Server Error Hits: 500/501/502/503/504"
    },
    {
        "id": 22033,
        "name": "Origin Server Error Hits: 500/501/502/503/504",
        "unit": "count",
        "type": "count",
        "description": "Origin Server Error Hits: 500/501/502/503/504"
    },
    {
        "id": 22023,
        "name": "Origin Traffic hits",
        "unit": "count",
        "type": "count",
        "description": "Sum Origin traffic per second"
    },
    {
        "id": 22016,
        "name": "Origin Traffic in hits/sec",
        "type": "count",
        "description": "Sum Origin traffic per second"
    },
    {
        "id": 22035,
        "name": "Origin Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Origin Volume"
    },
    {
        "id": 22019,
        "name": "Other Hits",
        "unit": "count",
        "type": "count",
        "description": "Other [ All other status codes]"
    },
    {
        "id": 22041,
        "name": "Other Hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Other [ All other status codes]"
    },
    {
        "id": 22018,
        "name": "Permission Hits",
        "unit": "count",
        "type": "count",
        "description": "Permission [401|403|415]"
    },
    {
        "id": 22037,
        "name": "Permission Hits/sec",
        "unit": "count",
        "type": "count",
        "description": "Permission [401|403|415]"
    },
    {
        "id": 22005,
        "name": "Requests",
        "unit": "MB",
        "type": "volume",
        "description": "Requests"
    },
    {
        "id": 22011,
        "name": "Server Error Hits",
        "unit": "count",
        "type": "count",
        "description": "Server Error [500|501|502|503|504]"
    },
    {
        "id": 22000,
        "name": "Total Bandwidth",
        "unit": "Mbps",
        "type": "bandwidth",
        "description": "Total Bandwidth"
    },
    {
        "id": 22001,
        "name": "Total Volume",
        "unit": "MB",
        "type": "volume",
        "description": "Total Volume"
    },
    {
        "id": 22101,
        "name": "Visitors",
        "type": "count",
        "description": "Visitors"
    }
]

List Progressive Media Delivery data

Retrieves all data for Progressive Media Delivery.

GET /media-reports/v1/msod/pmd/data{?startDate,endDate,ignorePutPost,deliveryOption,cpcodes}

Sample: /media-reports/v1/msod/pmd/data?startDate=2014-03-22T15%3A30Z&endDate=2014-03-23T15%3A30Z&ignorePutPost=true&deliveryOption=non-secure&cpcodes=12345%2C67890

Parameter Type Sample Description
Required query parameters
endDate String 2014-03-23T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
startDate String 2014-03-22T15:30Z The timestamp string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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 premium secure customer-certificate traffic, or the default all.
ignorePutPost Boolean true Specifies if the API should ignore ingest data when generating the response.

Status 200 application/json

Download schema: progressiveMediaDelivery.json

Response Body:

{
    "columns": [
        {
            "type": "dimension",
            "name": "CP Code",
            "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Requests Volume",
            "id": 22005,
            "description": "Requests",
            "index": 1,
            "aggregate": "1.82",
            "unit": "MB"
        }
    ],
    "rows": [
        [
            "759977",
            "1.824443"
        ]
    ],
    "metaData": {
        "startTimeInEpoch": 1543674600,
        "offset": 0,
        "dasTable": "trafficsummary_-_F_time",
        "limit": 300,
        "timeZone": "GMT",
        "hasMoreData": false,
        "messages": [
            "Estimated data begins at 17/Dec/2018 20:00:00 GMT"
        ],
        "aggregation": 300,
        "rtWindow": 1545076800,
        "endTimeInEpoch": 1545143400
    }
}

List Adaptive Media Delivery dimensions

Deprecated. Retrieves all of the dimensions available for Adaptive Media Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/adaptive-media-delivery/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "description": "The time dimension",
        "id": 1,
        "name": "Time"
    },
    {
        "description": "The dimension representing country",
        "id": 2,
        "name": "Country"
    },
    {
        "description": "The operating system",
        "id": 3,
        "name": "OS"
    }
]

List Adaptive Media Delivery metrics

Deprecated. Retrieves all of the metrics available for Adaptive Media Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/adaptive-media-delivery/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "description": "The number of unique visitors",
        "id": 1,
        "name": "Visitors"
    },
    {
        "description": "The volume of data served by the edge server",
        "id": 2,
        "name": "Edge bytes"
    },
    {
        "description": "The number of hits to the origin",
        "id": 3,
        "name": "Origin Hits"
    }
]

Get Adaptive Media Delivery data

Deprecated. Retrieves Adaptive Media Delivery data for the given parameters. See the Media Delivery Reports API for the updated operation.

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

Sample: /media-reports/v1/adaptive-media-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&cpcodes=12345%2C67890&startDate=03/22/2014%3A15%3A30&endDate=03/23/2014%3A15%3A30&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&deliveryOption=non-secure&deliveryType=all&deliveryFormat=all&mediaAcceleration=all&mediaEncryption=all&ipVersion=all

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
Optional query parameters
aggregation String month The time period in which to group each data record, expressed as number of seconds or the keyword values, day, week, month, or year.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
deliveryFormat Enumeration all Reports 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 premium secure customer-certificate traffic, or the default all. The parameter 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 begin to use the new options.
deliveryType Enumeration all Limits data to the media’s delivery context, either live, vod (video on demand), or the default all.
endDate String 03/23/2014:15:30 Specifies the end of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.
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 Limits reported data to an IP version, either ipv4, ipv6, or the default all for both versions.
limit Number 300 The number of rows to return from 1 to 10000. The default value is 300.
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 media that is encrypted or unencrypted or specify the default all for unlimited data.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
startDate String 03/22/2014:15:30 Specifies the start of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.

Status 200 application/json

Download schema: mediaDeliveryData.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 Download Delivery dimensions

Deprecated. Retrieves all of the dimensions available for Download Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/download-delivery/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "description": "The time dimension",
        "id": 1,
        "name": "Time"
    },
    {
        "description": "The dimension representing country",
        "id": 2,
        "name": "Country"
    },
    {
        "description": "The operating system",
        "id": 3,
        "name": "OS"
    }
]

List Download Delivery metrics

Deprecated. Retrieves all of the metrics available for Download Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/download-delivery/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "description": "The number of unique visitors",
        "id": 1,
        "name": "Visitors"
    },
    {
        "description": "The volume of data served by the edge server",
        "id": 2,
        "name": "Edge bytes"
    },
    {
        "description": "The number of hits to the origin",
        "id": 3,
        "name": "Origin Hits"
    }
]

Get Download Delivery data

Deprecated. Retrieves Download Delivery data for the given parameters. See the Media Delivery Reports API for the updated operation.

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

Sample: /media-reports/v1/download-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&cpcodes=12345%2C67890&startDate=03/22/2014%3A15%3A30&endDate=03/23/2014%3A15%3A30&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&deliveryOption=non-secure&mediaAcceleration=all&ipVersion=all

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
Optional query parameters
aggregation String month The time period in which to group each data record, expressed as number of seconds or the keyword values, day, week, month, or year.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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 premium secure customer-certificate traffic, or the default all. The parameter 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 begin to use the new options.
endDate String 03/23/2014:15:30 Specifies the end of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.
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 Limits reported data to an IP version, either ipv4, ipv6, or the default all for both versions.
limit Number 300 The number of rows to return from 1 to 10000. The default value is 300.
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 for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
startDate String 03/22/2014:15:30 Specifies the start of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.

Status 200 application/json

Download schema: mediaDeliveryData.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 dimensions

Deprecated. Retrieves all of the dimensions available for Object Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/object-delivery/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "description": "The time dimension",
        "id": 1,
        "name": "Time"
    },
    {
        "description": "The dimension representing country",
        "id": 2,
        "name": "Country"
    },
    {
        "description": "The operating system",
        "id": 3,
        "name": "OS"
    }
]

List Object Delivery metrics

Deprecated. Retrieves all of the metrics available for Object Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/object-delivery/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "description": "The number of unique visitors",
        "id": 1,
        "name": "Visitors"
    },
    {
        "description": "The volume of data served by the edge server",
        "id": 2,
        "name": "Edge bytes"
    },
    {
        "description": "The number of hits to the origin",
        "id": 3,
        "name": "Origin Hits"
    }
]

Get Object Delivery data

Deprecated. Retrieves Object Delivery data for the given parameters. See the Media Delivery Reports API for the updated operation.

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

Sample: /media-reports/v1/object-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&cpcodes=12345%2C67890&startDate=03/22/2014%3A15%3A30&endDate=03/23/2014%3A15%3A30&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&mediaAcceleration=all

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
Optional query parameters
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
endDate String 03/23/2014:15:30 Specifies the end of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.
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. The default value is 300.
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 for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
startDate String 03/22/2014:15:30 Specifies the start of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.

Status 200 application/json

Download schema: mediaDeliveryData.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 dimensions

Deprecated. Retrieves all of the dimensions available for RTMP Media Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/rtmp-media-delivery/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "description": "The time dimension",
        "id": 1,
        "name": "Time"
    },
    {
        "description": "The dimension representing country",
        "id": 2,
        "name": "Country"
    },
    {
        "description": "The operating system",
        "id": 3,
        "name": "OS"
    }
]

List RTMP Media Delivery metrics

Deprecated. Retrieves all of the metrics available for RTMP Media Delivery. See the Media Delivery Reports API for the updated operation.

GET /media-reports/v1/rtmp-media-delivery/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "description": "The number of unique visitors",
        "id": 1,
        "name": "Visitors"
    },
    {
        "description": "The volume of data served by the edge server",
        "id": 2,
        "name": "Edge bytes"
    },
    {
        "description": "The number of hits to the origin",
        "id": 3,
        "name": "Origin Hits"
    }
]

Get RTMP Media Delivery data

Deprecated. Retrieves RTMP Media Delivery data for the given parameters. See the Media Delivery Reports API for the updated operation.

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

Sample: /media-reports/v1/rtmp-media-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&cpcodes=12345%2C67890&startDate=03/22/2014%3A15%3A30&endDate=03/23/2014%3A15%3A30&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&deliveryType=all

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
Optional query parameters
aggregation String month The time period in which to group each data record, expressed as number of seconds or the keyword values, day, week, month, or year.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
deliveryType Enumeration all Limits data to the media’s delivery context, either live, vod (video on demand), or the default all.
endDate String 03/23/2014:15:30 Specifies the end of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.
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. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
startDate String 03/22/2014:15:30 Specifies the start of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.

Status 200 application/json

Download schema: mediaDeliveryData.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 dimensions

Deprecated. Retrieves all of the dimensions available for Wholesale Delivery. See the Media Delivery Reports API for the updated version of this operation.

GET /media-reports/v1/wholesale-delivery/dimensions

Status 200 application/json

Download schema: dimensions.json

Response Body:

[
    {
        "description": "The time dimension",
        "id": 1,
        "name": "Time"
    },
    {
        "description": "The dimension representing the Sub Customer ID",
        "id": 2,
        "name": "Sub Customer ID"
    },
    {
        "description": "The Server Price Zone",
        "id": 3,
        "name": "Server Price Zone"
    }
]

List Wholesale Delivery metrics

Deprecated. Retrieves all of the metrics available for Wholesale Delivery. See the Media Delivery Reports API for the updated version of this operation.

GET /media-reports/v1/wholesale-delivery/metrics

Status 200 application/json

Download schema: metrics.json

Response Body:

[
    {
        "description": "Egress hits",
        "id": 1,
        "name": "Egress hits"
    },
    {
        "description": "The volume of data served by the origin server",
        "id": 2,
        "name": "Origin Bytes"
    },
    {
        "description": "The number of hits to the origin",
        "id": 3,
        "name": "Origin Hits"
    }
]

Get Wholesale Delivery data

Deprecated. Retrieves Wholesale Delivery data for the given parameters. See the Media Delivery Reports API for the updated version of this operation.

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

Sample: /media-reports/v1/wholesale-delivery/data?dimensions=1%2C2%2C3&metrics=1%2C2%2C3&cpcodes=12345%2C67890&startDate=03/22/2014%3A15%3A30&endDate=03/23/2014%3A15%3A30&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%20%22order%22%3A%22asc%22%2C%20%22id%22%3A40%7D%5D&deliveryOption=non-secure

Parameter Type Sample Description
Required query parameters
dimensions String 1,2,3 Identifies dimensions with comma-separated IDs.
metrics String 1,2,3 Identifies metrics with comma-separated IDs.
Optional query parameters
aggregation String month The time period in which to group each data record, expressed as number of seconds or the keyword values, day, week, month, or year.
cpcodes String 12345,67890 Use to limit report data to specific CP codes. Comma-separate multiple values.
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 premium secure customer-certificate traffic, or the default all. The parameter 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 begin to use the new options.
endDate String 03/23/2014:15:30 Specifies the end of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.
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. The default value is 300.
offset Number 0 The offset of the row for the start of data. Use this 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 reported data. See the SortParams object for details on its structure.
startDate String 03/22/2014:15:30 Specifies the start of the reported time range, expressed in mm/dd/yyyy:HH:MM format. The trailing :HH:MM 24-hour time segment is optional.

Status 200 application/json

Download schema: mediaDeliveryData.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 Media Services Reports API’s various data structures.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Member is required in requests, or always present in responses, even if its value is empty or null.
Member is optional, and may be omitted in some cases.

Report

Encapsulates a media data report for various products.

Download schema: mediaServicesData.json

Sample GET response:

{
    "columns": [
        {
            "type": "dimension",
            "name": "Time",
            "description": "Indicates the consumption time of the content.",
            "index": 0
        },
        {
            "type": "metric",
            "name": "Hits",
            "description": "Total number of requests made to the entry point posting objects.",
            "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
Report: Encapsulates a media data report for various products.
columns Report.columns[] Provides context for each element listed within corresponding rows.
metaData Report.metaData Reflects the set of parameter values included in the request that determines this report’s results.
rows Array Encapsulates the report’s two-dimensional table data. If there is no data to report, the array is empty.
Report.columns[]: Provides context for each element listed within corresponding rows.
aggregate String Provides an aggregate value for the dimension or metric expressed in string format. For example, for type: metric and name: Hits, the information returned would be 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: dimension or metric.
Report.metaData: Reflects the set of parameter values included in the request that determines this report’s results.
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 Indicates that 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 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 that 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
FilterParams: Encapsulates filtering parameters that are wrapped in an array, URL-encoded, and passed in with GET requests using the filterParams query parameter.
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 Identifies each dimension or metric filtering entity.
type Enumeration Specifies whether the provided id parameter is a dimension or a metric.
values Array List of values used to filter the result. Values represent either inclusions or exclusions, depending on what the condition parameter specifies.

SortParams

Encapsulates sorting parameters that 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
SortParams: Encapsulates sorting parameters that are wrapped in an array, URL-encoded, and passed in with GET requests using the sortParams query parameter.
id Integer The ID of the sorting entity. The sorting entity 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 Indicates if the id parameter 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. The API returns HTTP response codes that correspond to the httpStatus element in the JSON response, eliminating the need to query the header for the response code. For all non–2xx HTTPS status codes, the API responds with a JSON object such as the following:

{
    "httpStatus": 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. If the report yields an empty data set, the response yields an empty set of rows.
400 Bad input parameter. The Error detail should identify the cause.
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: 3/18/2019