universallivetraffic-by-time report

The following shows how to generate the universallivetraffic-by-time report using either the Reporting API’s Generate a report POST operation or the Get a cacheable report GET operation. Details about each report’s supported products, metrics, filters, and available data intervals are also available dynamically by running the API’s Get a report type operation, also shown below. See also other available reports.

Report definition

Provides estimated traffic data for traditional Universal Live streams, for use in Event Center. Supports Apple HLS and Adobe HDS formats. .

This report allows you to configure the aggregation interval for each data record. Available interval values are: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

Business object: cpcode

Data available for: 90 days

Available metrics

Metric Description
Data metrics
hdsEdgeBitsPerSecond The estimated bandwidth of Adobe HDS Stream edge requests for given objects and filters.
hdsEdgeHitsPerSecond The estimated number of Adobe HDS Stream edge requests per second for given objects and filters.
hdsEdgeViewers The estimated number of Adobe HDS Stream concurrent viewers for given objects and filters.
hlsEdgeBitsPerSecond The estimated bandwidth of Apple HLS Stream edge requests for given objects and filters.
hlsEdgeHitsPerSecond The estimated number of Apple HLS Stream edge requests per second for given objects and filters.
hlsEdgeViewers The estimated number of Apple HLS Stream concurrent viewers for given objects and filters.
Summary metrics
hdsEdgeBitsPerSecondMax The peak estimated bandwidth of Adobe HDS Stream edge requests for given objects and filters.
hdsEdgeBytesTotal The total estimated volume of Adobe HDS Stream edge traffic for given objects and filters.
hdsEdgeHitsPerSecondMax The peak estimated number of Adobe HDS Stream edge requests per second for given objects and filters.
hdsEdgeHitsTotal The total estimated number of Adobe HDS Stream edge requests for given objects and filters.
hdsEdgeViewersMax The peak estimated number of Adobe HDS Stream edge concurrent viewers for given objects and filters.
hlsEdgeBitsPerSecondMax The peak estimated bandwidth of Apple HLS Stream edge requests for given objects and filters.
hlsEdgeBytesTotal The total estimated volume of Apple HLS Stream edge traffic for given objects and filters.
hlsEdgeHitsPerSecondMax The peak estimated number of Apple HLS Stream edge requests per second for given objects and filters.
hlsEdgeHitsTotal The total estimated number of Apple HLS Stream edge requests for given objects and filters.
hlsEdgeViewersMax The peak estimated number of Apple HLS Stream edge concurrent viewers for given objects and filters.

Available filters

Filter Type Description
Optional filters
stream_id String The unique identifier for the stream.

Sample report

POST /reporting-api/v1/reports/universallivetraffic-by-time/versions/1/report-data{?start,end,interval}

Sample: /reporting-api/v1/reports/universallivetraffic-by-time/versions/1/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES

Object type: Query

Download schema: report-request-schema.json

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40:00Z Specifies the start of the reported period as an ISO–8601 timestamp with optional time zone. The report includes data that matches the start value’s timestamp.
end String 2020-06-26T14:00:00Z Specifies the end of the reported period as an ISO–8601 timestamp with optional time zone. The report excludes any data that matches the end value’s timestamp.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.

JSON request members

Member Type Description
objectIds Array Specifies the set of cpcode values you want to report on.
objectIds Enumeration As an alternative to an array of ID values, specify all as a string for unfiltered data. Either way, objectIds is required.
metrics Array The set of desired metrics. If omitted, the report includes all available metrics.
filters Map of Arrays Specifies a set of custom filters, with each filter’s name keying an array with each filter’s set of values.

Request body:

{
    "objectIds": [
        "55232",
        "23433",
        "32433"
    ],
    "metrics": [
        "hdsEdgeBitsPerSecond",
        "hdsEdgeBitsPerSecondMax",
        "hdsEdgeBytesTotal",
        "hdsEdgeHitsPerSecond",
        "hdsEdgeHitsPerSecondMax",
        "hdsEdgeHitsTotal",
        "hdsEdgeViewers",
        "hdsEdgeViewersMax",
        "hlsEdgeBitsPerSecond",
        "hlsEdgeBitsPerSecondMax",
        "hlsEdgeBytesTotal",
        "hlsEdgeHitsPerSecond",
        "hlsEdgeHitsPerSecondMax",
        "hlsEdgeHitsTotal",
        "hlsEdgeViewers",
        "hlsEdgeViewersMax"
    ],
    "filters": {
        "stream_id": [
            "577596",
            "577598"
        ]
    }
}

GET /reporting-api/v1/reports/universallivetraffic-by-time/versions/1/report-data{?start,end,interval,objectIds,allObjectIds,metrics,filters}

Sample: /reporting-api/v1/reports/universallivetraffic-by-time/versions/1/report-data?start=2020-06-26T13%3A40%3A00Z&end=2020-06-26T14%3A00%3A00Z&interval=FIVE_MINUTES&objectIds=55232,23433,32433&metrics=hdsEdgeBitsPerSecond%2ChdsEdgeBitsPerSecondMax&filters=stream_id%3D577598%2Cstream_id%3D577597

Query parameters

Parameter Type Sample Description
Required
start String 2020-06-26T13:40:00Z Specifies the end of the reported period as an ISO–8601 timestamp with optional time zone. The report excludes any data that matches the end value’s timestamp.
end String 2020-06-26T14:00:00Z Specifies if unavailable reports should be shown.
interval Enumeration FIVE_MINUTES The duration of each data record. Available values: MONTH, WEEK, DAY, HOUR, FIVE_MINUTES.
Optional
allObjectIds Boolean true As an alternative to objectIds, enabling this generates a report that includes all IDs available for the cpcode objectType. This parameter is ignored if the request also specifies a set of objectIds.
objectIds String 55232,23433,32433 As an alternative to allObjectIds, specifies the set of unique IDs for the cpcode objectType you want to report on, formatted as a comma-delimited list.
metrics String hdsEdgeBitsPerSecond,hdsEdgeBitsPerSecondMax Specifies a comma-separated list of metrics to include in the report, otherwise all metrics if omitted. The set of available metrics depends on the type of report. URL-encode the entire value in the GET request.
filters String stream_id=577598,stream_id=577597 Specifies criteria to filter the report’s data. The set of available filters depends on the type of report. Separate each filter name and value with an equals (=) character, and separate various name/value pairs with commas (,). To specify more than one filter value, repeat the filter name. See the accompanying example for guidance. URL-encode the entire value in the GET request.

Status 200 application/json

Object type: Report

Download schema: report-response-schema.json

Response body:

{
    "metadata": {
        "name": "universallivetraffic-by-time",
        "version": "1",
        "outputType": "FLAT",
        "groupBy": [
            "startdatetime"
        ],
        "interval": "FIVE_MINUTES",
        "start": "2020-06-26T13:40:00Z",
        "end": "2020-06-26T14:00:00Z",
        "availableDataEnds": null,
        "suggestedRetryTime": null,
        "rowCount": 4,
        "filters": [
            {
                "name": "stream_id",
                "values": [
                    "577597",
                    "577595"
                ]
            }
        ],
        "columns": [
            {
                "name": "groupBy",
                "label": "startdatetime"
            },
            {
                "name": "hdsEdgeBitsPerSecond",
                "label": "Adobe HDS Edge Bits/Sec"
            },
            {
                "name": "hdsEdgeHitsPerSecond",
                "label": "Adobe HDS Edge Hits/Sec"
            },
            {
                "name": "hdsEdgeViewers",
                "label": "Adobe HDS Edge Viewers"
            },
            {
                "name": "hlsEdgeBitsPerSecond",
                "label": "Apple HLS Edge Bits/Sec"
            },
            {
                "name": "hlsEdgeHitsPerSecond",
                "label": "Apple HLS Edge Hits/Sec"
            },
            {
                "name": "hlsEdgeViewers",
                "label": "Apple HLS Edge Viewers"
            }
        ],
        "objectType": "cpcode",
        "objectIds": [
            "55232",
            "23433",
            "32433"
        ]
    },
    "data": [
        {
            "startdatetime": "2020-06-26T13:40:00Z",
            "hdsEdgeBitsPerSecond": "1670.450015",
            "hdsEdgeHitsPerSecond": "4940.901389",
            "hdsEdgeViewers": "2740",
            "hlsEdgeBitsPerSecond": "4520.59819",
            "hlsEdgeHitsPerSecond": "2889.925987",
            "hlsEdgeViewers": "2612"
        },
        {
            "startdatetime": "2020-06-26T13:45:00Z",
            "hdsEdgeBitsPerSecond": "1958.43602",
            "hdsEdgeHitsPerSecond": "1499.795048",
            "hdsEdgeViewers": "3425",
            "hlsEdgeBitsPerSecond": "1905.745788",
            "hlsEdgeHitsPerSecond": "100.884981",
            "hlsEdgeViewers": "3562"
        },
        {
            "startdatetime": "2020-06-26T13:50:00Z",
            "hdsEdgeBitsPerSecond": "532.834272",
            "hdsEdgeHitsPerSecond": "81.932334",
            "hdsEdgeViewers": "1273",
            "hlsEdgeBitsPerSecond": "2963.711966",
            "hlsEdgeHitsPerSecond": "1342.721701",
            "hlsEdgeViewers": "3692"
        },
        {
            "startdatetime": "2020-06-26T13:55:00Z",
            "hdsEdgeBitsPerSecond": "542.263888",
            "hdsEdgeHitsPerSecond": "4308.657518",
            "hdsEdgeViewers": "1914",
            "hlsEdgeBitsPerSecond": "2144.751074",
            "hlsEdgeHitsPerSecond": "1774.855206",
            "hlsEdgeViewers": "3106"
        }
    ],
    "summaryStatistics": {
        "hdsEdgeBitsPerSecondMax": {
            "value": "3961.767456",
            "details": {}
        },
        "hdsEdgeBytesTotal": {
            "value": "3278",
            "details": {}
        },
        "hdsEdgeHitsPerSecondMax": {
            "value": "1798.415487",
            "details": {}
        },
        "hdsEdgeHitsTotal": {
            "value": "743",
            "details": {}
        },
        "hdsEdgeViewersMax": {
            "value": "1089",
            "details": {}
        },
        "hlsEdgeBitsPerSecondMax": {
            "value": "2127.435921",
            "details": {}
        },
        "hlsEdgeBytesTotal": {
            "value": "2012",
            "details": {}
        },
        "hlsEdgeHitsPerSecondMax": {
            "value": "1083.397717",
            "details": {}
        },
        "hlsEdgeHitsTotal": {
            "value": "3998",
            "details": {}
        },
        "hlsEdgeViewersMax": {
            "value": "3179",
            "details": {}
        }
    }
}

Status 200 text/csv

Response Body:

#METADATA_START
name,universallivetraffic-by-time
version,1
source,universallivetraffic-by-time/versions/1
groupBy,startdatetime
start,2020-06-26T13:40:00Z
end,2020-06-26T14:00:00Z
interval,`FIVE_MINUTES`
availableDataEnds,
suggestedRetryTime,
rowCount,4
objectType,cpcode
objectIds,55232,23433,32433
stream_id,577597,577595
#METADATA_END

#SUMMARYSTATISTICS_START
hdsEdgeBitsPerSecondMax,3961.767456
hdsEdgeBytesTotal,3278
hdsEdgeHitsPerSecondMax,1798.415487
hdsEdgeHitsTotal,743
hdsEdgeViewersMax,1089
hlsEdgeBitsPerSecondMax,2127.435921
hlsEdgeBytesTotal,2012
hlsEdgeHitsPerSecondMax,1083.397717
hlsEdgeHitsTotal,3998
hlsEdgeViewersMax,3179
#SUMMARYSTATISTICS_END

#COLUMNS_START
startdatetime,hdsEdgeBitsPerSecond,hdsEdgeHitsPerSecond,hdsEdgeViewers,hlsEdgeBitsPerSecond,hlsEdgeHitsPerSecond,hlsEdgeViewers
#COLUMNS_END

#DATA_START
2020-06-26T13:40:00Z,1670.450015,4940.901389,2740,4520.59819,2889.925987,2612
2020-06-26T13:45:00Z,1958.43602,1499.795048,3425,1905.745788,100.884981,3562
2020-06-26T13:50:00Z,532.834272,81.932334,1273,2963.711966,1342.721701,3692
2020-06-26T13:55:00Z,542.263888,4308.657518,1914,2144.751074,1774.855206,3106
#DATA_END

Get report details

This sample Get a report type operation gets the same information you need to run the universallivetraffic-by-time report as provided in this reference documentation, but available dynamically to your API client application.

GET /reporting-api/v1/reports/universallivetraffic-by-time/versions/1

Status 200 application/json

Object type: ReportType

Download schema: data-row-schema.json

Response body:

{
    "name": "universallivetraffic-by-time",
    "description": "Provides estimated traffic data for traditional Universal Live streams, for use in Event Center. Supports Apple HLS and Adobe HDS formats. .",
    "businessObjectName": "cpcode",
    "version": 1,
    "status": "PUBLISHED",
    "deprecated": false,
    "timeBased": true,
    "outputType": "FLAT",
    "requiredRoles": [
        "None"
    ],
    "available": true,
    "metrics": [
        {
            "name": "hdsEdgeBitsPerSecond",
            "description": "The estimated bandwidth of Adobe HDS Stream edge requests for given objects and filters.",
            "label": "Adobe HDS Edge Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "hdsEdgeBitsPerSecondMax",
            "description": "The peak estimated bandwidth of Adobe HDS Stream edge requests for given objects and filters.",
            "label": "Adobe HDS Edge Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "hdsEdgeHitsPerSecond",
            "description": "The estimated number of Adobe HDS Stream edge requests per second for given objects and filters.",
            "label": "Adobe HDS Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "hdsEdgeHitsPerSecondMax",
            "description": "The peak estimated number of Adobe HDS Stream edge requests per second for given objects and filters.",
            "label": "Adobe HDS Edge Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "hdsEdgeHitsTotal",
            "description": "The total estimated number of Adobe HDS Stream edge requests for given objects and filters.",
            "label": "Adobe HDS Edge Hits Total",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "hdsEdgeViewers",
            "description": "The estimated number of Adobe HDS Stream concurrent viewers for given objects and filters.",
            "label": "Adobe HDS Edge Viewers",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "hdsEdgeViewersMax",
            "description": "The peak estimated number of Adobe HDS Stream edge concurrent viewers for given objects and filters.",
            "label": "Adobe HDS Edge Viewers Maximum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "hlsEdgeBitsPerSecond",
            "description": "The estimated bandwidth of Apple HLS Stream edge requests for given objects and filters.",
            "label": "Apple HLS Edge Bits/Sec",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "hlsEdgeBitsPerSecondMax",
            "description": "The peak estimated bandwidth of Apple HLS Stream edge requests for given objects and filters.",
            "label": "Apple HLS Edge Bits/Sec Maximum",
            "unit": "BIT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "hlsEdgeHitsPerSecond",
            "description": "The estimated number of Apple HLS Stream edge requests per second for given objects and filters.",
            "label": "Apple HLS Edge Hits/Sec",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": false
        },
        {
            "name": "hlsEdgeHitsPerSecondMax",
            "description": "The peak estimated number of Apple HLS Stream edge requests per second for given objects and filters.",
            "label": "Apple HLS Edge Hits/Sec Maximum",
            "unit": "COUNT_PER_SECOND",
            "summaryStatistic": true
        },
        {
            "name": "hlsEdgeHitsTotal",
            "description": "The total estimated number of Apple HLS Stream edge requests for given objects and filters.",
            "label": "Apple HLS Edge Hits Total",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "hlsEdgeViewers",
            "description": "The estimated number of Apple HLS Stream concurrent viewers for given objects and filters.",
            "label": "Apple HLS Edge Viewers",
            "unit": "COUNT",
            "summaryStatistic": false
        },
        {
            "name": "hlsEdgeViewersMax",
            "description": "The peak estimated number of Apple HLS Stream edge concurrent viewers for given objects and filters.",
            "label": "Apple HLS Edge Viewers Maximum",
            "unit": "COUNT",
            "summaryStatistic": true
        },
        {
            "name": "hdsEdgeBytesTotal",
            "description": "The total estimated volume of Adobe HDS Stream edge traffic for given objects and filters.",
            "label": "Adobe HDS Edge Bytes Total",
            "unit": "BYTE",
            "summaryStatistic": true
        },
        {
            "name": "hlsEdgeBytesTotal",
            "description": "The total estimated volume of Apple HLS Stream edge traffic for given objects and filters.",
            "label": "Apple HLS Edge Bytes Total",
            "unit": "BYTE",
            "summaryStatistic": true
        }
    ],
    "groupOutlyingValues": {
        "enabled": false
    },
    "groupBy": [
        "startdatetime"
    ],
    "filters": [
        {
            "name": "stream_id",
            "type": "string",
            "description": "The unique identifier for the stream.",
            "required": false
        }
    ],
    "intervals": [
        "MONTH",
        "WEEK",
        "DAY",
        "HOUR",
        "FIVE_MINUTES"
    ],
    "dataRetentionDays": 90,
    "links": [
        {
            "rel": "self",
            "href": "/reporting-reports-executor-api/v1/reports/universallivetraffic-by-time/versions/1"
        },
        {
            "rel": "versions",
            "href": "/reporting-reports-executor-api/v1/reports/universallivetraffic-by-time/versions"
        },
        {
            "rel": "all-reports",
            "href": "/reporting-reports-executor-api/v1/reports"
        },
        {
            "rel": "execute-report",
            "href": "/reporting-reports-executor-api/v1/reports/universallivetraffic-by-time/versions/1/report-data"
        }
    ]
}