Media Reports API Resources

This section provides details on the API’s various URL resources and the methods and parameters you use to call them.

API Summary

Operation Method Endpoint
Download Delivery   (download RAML)
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   (download RAML)
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}
Adaptive Media Delivery   (download RAML)
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}
RTMP Media Delivery   (download RAML)
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   (download RAML)
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}
Media Services Live: HTTP Ingest   (download RAML)
List Media Services Live(HTTP Ingest) Dimensions GET /media-reports/v1/media-services-live/http-ingest/dimensions
List Media Services Live (HTTP Ingest) Metrics GET /media-reports/v1/media-services-live/http-ingest/metrics
Get Media Services Live (HTTP Ingest) Data GET /media-reports/v1/media-services-live/http-ingest/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,streams}
Get Media Services Live (HTTP Ingest) Entry Point Switch Information GET /media-reports/v1/media-services-live/http-ingest/ep-switch/data{?startDate,endDate,cpcodes,limit,offset,streams}
Media Services Live: RTMP Ingest   (download RAML)
List Media Services Live (RTMP Ingest) Dimensions GET /media-reports/v1/media-services-live/rtmp-ingest/dimensions
List Media Services Live (RTMP Ingest) Metrics GET /media-reports/v1/media-services-live/rtmp-ingest/metrics
Get Media Services Live (RTMP Ingest) Data GET /media-reports/v1/media-services-live/rtmp-ingest/data{?dimensions,metrics,startDate,endDate,cpcodes,limit,offset,aggregation,filterParams,sortParams,streams}
Get Media Services Live (RTMP Ingest) 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}

List Download Delivery Dimensions

Retrieves all the dimensions available for Download Delivery.

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

Status 200 application/json

Response Body:

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

List Download Delivery Metrics

Retrieves all the metrics available for Download Delivery.

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

Status 200 application/json

Response Body:

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

Get Download Delivery Data

Retrieves Download Delivery data for the given parameters.

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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&cpcodes=12345%2C%3Cwbr%3E67890&startDate=03/%3Cwbr%3E22/%3Cwbr%3E2014%3A15%3A30&endDate=03/%3Cwbr%3E23/%3Cwbr%3E2014%3A15%3A30&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&deliveryOption=non-secure&mediaAcceleration=all&ipVersion=all

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
Optional Query Parameters
aggregation String month The time period with which to group each data record, either expressed as the number of seconds or the keyword values day, week, month, or year.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryOption Enumeration non-secure Limits data to the type of traffic, either non-secure for non-secure traffic, secure-shared for secure shared-certificate traffic, secure-standard for standard secure customer-certificate traffic, secure-premium for premimum secure customer-certificate traffic, or the default all. The paramater continues to support the older options, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it is best to begin to use the newer 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 the reported data. See the FilterParams object for details on its structure.
ipVersion Enumeration all Limit reported data per IP version, either ipv4, ipv6, or the default all for either version.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
mediaAcceleration Enumeration all Limit reported data to media that is accelerated or nonaccelerated, or specify the default all for unlimited data.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
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

Response Body:

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

List Object Delivery Dimensions

Retrieves all the dimensions available for Object Delivery.

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

Status 200 application/json

Response Body:

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

List Object Delivery Metrics

Retrieves all the metrics available for Object Delivery.

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

Status 200 application/json

Response Body:

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

Get Object Delivery Data

Retrieves Object Delivery data for the given parameters.

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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&cpcodes=12345%2C%3Cwbr%3E67890&startDate=03/%3Cwbr%3E22/%3Cwbr%3E2014%3A15%3A30&endDate=03/%3Cwbr%3E23/%3Cwbr%3E2014%3A15%3A30&limit=300&offset=0&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&mediaAcceleration=all

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
Optional Query Parameters
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
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 the reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
mediaAcceleration Enumeration all Limit reported data to media that is accelerated or nonaccelerated, or specify the default all for unlimited data.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
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

Response Body:

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

List Adaptive Media Delivery Dimensions

Retrieves all the dimensions available for Adaptive Media Delivery.

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

Status 200 application/json

Response Body:

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

List Adaptive Media Delivery Metrics

Retrieves all the metrics available for Adaptive Media Delivery.

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

Status 200 application/json

Response Body:

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

Get Adaptive Media Delivery Data

Retrieves Adaptive Media Delivery data for the given parameters.

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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&cpcodes=12345%2C%3Cwbr%3E67890&startDate=03/%3Cwbr%3E22/%3Cwbr%3E2014%3A15%3A30&endDate=03/%3Cwbr%3E23/%3Cwbr%3E2014%3A15%3A30&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%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 Specifies dimensions as comma-separated IDs.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
Optional Query Parameters
aggregation String month The time period with which to group each data record, either expressed as the number of seconds or the keyword values day, week, month, or year.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryFormat Enumeration all Report on sp_hds for stream packaging HDS, sp_hls for stream packaging HLS, pt_hls for HLS, pt_hds for HDS, pt_dash for DASH, smooth for Microsoft Smooth Streaming, others, or the default all.
deliveryOption Enumeration non-secure Limits data to the type of traffic, either non-secure for non-secure traffic, secure-shared for secure shared-certificate traffic, secure-standard for standard secure customer-certificate traffic, secure-premium for premimum secure customer-certificate traffic, or the default all. The paramater continues to support the older options, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it is best to begin to use the newer options.
deliveryType Enumeration all Limit 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 the reported data. See the FilterParams object for details on its structure.
ipVersion Enumeration all Limit reported data per IP version, either ipv4, ipv6, or the default all for either version.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
mediaAcceleration Enumeration all Limit reported data to media that is accelerated or nonaccelerated, or specify the default all for unlimited data.
mediaEncryption Enumeration all Limit reported data to media that is encrypted or unencrypted or specify the default all for unlimited data.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
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

Response Body:

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

List RTMP Media Delivery Dimensions

Retrieves all the dimensions available for RTMP Media Delivery.

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

Status 200 application/json

Response Body:

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

List RTMP Media Delivery Metrics

Retrieves all the metrics available for RTMP Media Delivery.

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

Status 200 application/json

Response Body:

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

Get RTMP Media Delivery Data

Retrieves RTMP Media Delivery data for the given parameters.

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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&cpcodes=12345%2C%3Cwbr%3E67890&startDate=03/%3Cwbr%3E22/%3Cwbr%3E2014%3A15%3A30&endDate=03/%3Cwbr%3E23/%3Cwbr%3E2014%3A15%3A30&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&deliveryType=all

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
Optional Query Parameters
aggregation String month The time period with which to group each data record, either expressed as the number of seconds or the keyword values day, week, month, or year.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryType Enumeration all Limit 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 the reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
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

Response Body:

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

List Wholesale Delivery Dimensions

Retrieves all the dimensions available for Wholesale Delivery.

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

Status 200 application/json

Response Body:

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

List Wholesale Delivery Metrics

Retrieves all the metrics available for Wholesale Delivery.

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

Status 200 application/json

Response Body:

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

Get Wholesale Delivery Data

Retrieves Wholesale Delivery data for the given parameters.

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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&cpcodes=12345%2C%3Cwbr%3E67890&startDate=03/%3Cwbr%3E22/%3Cwbr%3E2014%3A15%3A30&endDate=03/%3Cwbr%3E23/%3Cwbr%3E2014%3A15%3A30&limit=300&offset=0&aggregation=month&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&deliveryOption=non-secure

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
Optional Query Parameters
aggregation String month The time period with which to group each data record, either expressed as the number of seconds or the keyword values day, week, month, or year.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
deliveryOption Enumeration non-secure Limits data to the type of traffic, either non-secure for non-secure traffic, secure-shared for secure shared-certificate traffic, secure-standard for standard secure customer-certificate traffic, secure-premium for premimum secure customer-certificate traffic, or the default all. The paramater continues to support the older options, http for non-secure traffic, ssl for secure shared-certificate traffic, and essl for secure customer-certificate traffic. However, it is best to begin to use the newer 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 the reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
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

Response Body:

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

List Media Services Live(HTTP Ingest) Dimensions

Retrieves all the dimensions available for Media Services Live HTTP Ingest(HLS/HDS/DASH).

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

Status 200 application/json

Response Body:

[
    {
        "id": 1,
        "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
        "name": "Time"
    },
    {
        "id": 2,
        "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
        "name": "CP Code"
    },
    {
        "id": 3,
        "description": "Stream Id",
        "name": "Stream ID"
    }
]

List Media Services Live (HTTP Ingest) Metrics

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

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

Status 200 application/json

Response Body:

[
    {
        "id": 1,
        "type": "bandwidth",
        "description": "Average Bitrate",
        "unit": "kbps",
        "name": "Avg Bitrate"
    },
    {
        "id": 2,
        "type": "percent",
        "description": "Error Rate",
        "unit": "%",
        "name": "Error Rate"
    },
    {
        "id": 3,
        "type": "count",
        "description": "Hits",
        "name": "Hits"
    }
]

Get Media Services Live (HTTP Ingest) Data

Retrieves HTTP Ingest data for the given parameters.

GET /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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&startDate=2014–03–22T15%3A30Z%20or%202014–03–22T15%3A30%2B05%3A30&endDate=2014–03–23T15%3A30Z%20or%202014–03–23T15%3A30%2B05%3A30&cpcodes=12345%2C%3Cwbr%3E67890&limit=300&offset=0&aggregation=1440&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&streams=12345%2C%3Cwbr%3E67890

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014–03–23T15:30Z or 2014–03–23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014–03–22T15:30Z or 2014–03–22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
Optional Query Parameters
aggregation Number 1440 The time period with which to group each data record, expressed as the number of seconds. Note that for this endpoint, this parameter does not accept keyword string values.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
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 the reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Specify the set of reported streams as comma-separated ID values.

Status 200 application/json

Response Body:

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

Get Media Services Live (HTTP Ingest) Entry Point Switch Information

Retrieves information about all 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%20or%202014–03–22T15%3A30%2B05%3A30&endDate=2014–03–23T15%3A30Z%20or%202014–03–23T15%3A30%2B05%3A30&cpcodes=12345%2C%3Cwbr%3E67890&limit=300&offset=0&streams=12345%2C%3Cwbr%3E67890

Parameter Type Sample Description
Required Query Parameters
endDate String 2014–03–23T15:30Z or 2014–03–23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
startDate String 2014–03–22T15:30Z or 2014–03–22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
Optional Query Parameters
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
streams String 12345,67890 Specify the set of reported streams as comma-separated ID values.

Status 200 application/json

Response Body:

{
    "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"
        ]
    ],
    "columns": [
        {
            "index": 0,
            "type": "dimension",
            "name": "Current Time"
        },
        {
            "index": 1,
            "type": "dimension",
            "name": "Stream ID"
        },
        {
            "index": 2,
            "type": "dimension",
            "name": "Entry Point Switch Time"
        },
        {
            "index": 3,
            "type": "dimension",
            "name": "Old Entry Point"
        },
        {
            "index": 4,
            "type": "dimension",
            "name": "New Entry Point"
        },
        {
            "index": 5,
            "type": "dimension",
            "name": "Stream Type"
        }
    ],
    "metaData": {
        "startTimeInEpoch": 1487826000,
        "endTimeInEpoch": 1487833200,
        "hasMoreData": false,
        "aggregation": 120,
        "limit": 300,
        "offset": 0,
        "timeZone": "GMT"
    }
}

List Media Services Live (RTMP Ingest) Dimensions

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

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

Status 200 application/json

Response Body:

[
    {
        "id": 1,
        "description": "Indicates the time at which content was consumed. This dimension is set automatically.",
        "name": "Time"
    },
    {
        "id": 2,
        "description": "Content Provider Code (CPCode) is an identifier assigned to a contract and used for reporting, billing and monitoring traffic served.",
        "name": "CP Code"
    },
    {
        "id": 3,
        "description": "Stream Id",
        "name": "Stream ID"
    }
]

List Media Services Live (RTMP Ingest) Metrics

Retrieves all the metrics available for MSL RTMP Ingest.

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

Status 200 application/json

Response Body:

[
    {
        "id": 1,
        "type": "bandwidth",
        "description": "Average Bitrate",
        "unit": "kbps",
        "name": "Avg Bitrate"
    },
    {
        "id": 2,
        "type": "percent",
        "description": "Error Rate",
        "unit": "%",
        "name": "Error Rate"
    },
    {
        "id": 3,
        "type": "count",
        "description": "Hits",
        "name": "Hits"
    }
]

Get Media Services Live (RTMP Ingest) Data

Retrieves RTMP Ingest data for the given parameters.

GET /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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&startDate=2014–03–22T15%3A30Z%20or%202014–03–22T15%3A30%2B05%3A30&endDate=2014–03–23T15%3A30Z%20or%202014–03–23T15%3A30%2B05%3A30&cpcodes=12345%2C%3Cwbr%3E67890&limit=300&offset=0&aggregation=1440&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&streams=12345%2C%3Cwbr%3E67890

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014–03–23T15:30Z or 2014–03–23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014–03–22T15:30Z or 2014–03–22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
Optional Query Parameters
aggregation Number 1440 The time period with which to group each data record, expressed as the number of seconds. Note that for this endpoint, this parameter does not accept keyword string values.
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
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 the reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Specify the set of reported streams as comma-separated ID values.

Status 200 application/json

Response Body:

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

Get Media Services Live (RTMP Ingest) Entry Point Switching Information

Retrieves information about all 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%2C%3Cwbr%3E2%2C%3Cwbr%3E3&metrics=1%2C%3Cwbr%3E2%2C%3Cwbr%3E3&startDate=2014–03–22T15%3A30Z%20or%202014–03–22T15%3A30%2B05%3A30&endDate=2014–03–23T15%3A30Z%20or%202014–03–23T15%3A30%2B05%3A30&cpcodes=12345%2C%3Cwbr%3E67890&limit=300&offset=0&filterParams=%5B%7B%22type%22%3A%22dimension%22%2C%3Cwbr%3E%22values%22%3A%5B%22GB%22%5D%2C%3Cwbr%3E%22id%22%3A4%2C%3Cwbr%3E%22condition%22%3A%22in%22%7D%2C%3Cwbr%3E%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22values%22%3A%5B16%5D%2C%3Cwbr%3E%22id%22%3A155%2C%3Cwbr%3E%22condition%22%3A%22gt%22%7D%5D&sortParams=%5B%7B%22type%22%3A%22metric%22%2C%3Cwbr%3E%22order%22%3A%22asc%22%2C%3Cwbr%3E%22id%22%3A40%7D%5D&streams=12345%2C%3Cwbr%3E67890

Parameter Type Sample Description
Required Query Parameters
dimensions String 1,2,3 Specifies dimensions as comma-separated IDs.
endDate String 2014–03–23T15:30Z or 2014–03–23T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
metrics String 1,2,3 Specifies metrics as comma-separated IDs.
startDate String 2014–03–22T15:30Z or 2014–03–22T15:30+05:30 The start date string in ISO 8601 format yyyy-MM-ddTHH:mmZ or yyyy-MM-ddTHH:mm+HH:mm. The time part is optional and should be in the 24-hour format. An offset is either (1) a capital “Z” indicating UTC, or (2) a string of the form “+HH:mm” or “-HH:mm”. NOTE: The separator between date and time parts SHOULD be a capital T.
Optional Query Parameters
cpcodes String 12345,67890 Specifies the set of comma-delimited CP codes for which to report data.
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 the reported data. See the FilterParams object for details on its structure.
limit Number 300 The number of rows to return, from 1 to 10000, 300 by default.
offset Number 0 The offset of the row from which reported data should start, used to request progressive batches of data. For example, you can make 10 requests for 1000 records by setting the overall limit to 100, then setting the offset to 0, 100, 200, and so on for each request.
sortParams String [{“type”:“metric”,“order”:“asc”,“id”:40}] A UTF–8 URL-encoded JSON object representing sort parameters that rearrange the reported data. See the SortParams object for details on its structure.
streams String 12345,67890 Specify the set of reported streams as comma-separated ID values.

Status 200 application/json

Response Body:

{
    "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"
        ]
    ],
    "columns": [
        {
            "index": 0,
            "type": "dimension",
            "name": "Current Time"
        },
        {
            "index": 1,
            "type": "dimension",
            "name": "Stream ID"
        },
        {
            "index": 2,
            "type": "dimension",
            "name": "Entry Point Switch Time"
        },
        {
            "index": 3,
            "type": "dimension",
            "name": "Old Entry Point"
        },
        {
            "index": 4,
            "type": "dimension",
            "name": "New Entry Point"
        },
        {
            "index": 5,
            "type": "dimension",
            "name": "Stream Type"
        }
    ],
    "metaData": {
        "startTimeInEpoch": 1487826000,
        "endTimeInEpoch": 1487833200,
        "hasMoreData": false,
        "aggregation": 120,
        "limit": 300,
        "offset": 0,
        "timeZone": "GMT"
    }
}

Last modified: 10/4/2017