Skip to main contentIBM Video Streaming Developers

Total views

Total views for a given time period for all types of content

Provides a total view count for both live and on demand content for a given time period.

GET https://analytics-api.video.ibm.com/v1/total-views/summary

Parameters

The query parameters for the GET request:

PARAMETERTYPEIMPORTANCE DESCRIPTION
date_time_fromstringREQUIREDStart date and time for a period in ISO8601 format
date_time_tostringREQUIREDEnd date and time for a period in ISO8601 format
_pageintegerOPTIONALRequested page number (value is 1 by default)
_limitintegerOPTIONALRequested page size (value is 10 by default, max. 10 000)

Success response

Upon success a response with HTTP status “200 OK” is returned with an array under a data key. The elements of the array contain every data point wrapped in a series object matching the query parameters. Each object has the following attributes under the attributes key:

KEYTYPEDESCRIPTION
dimension_typestringThe requested dimension type
pointarrayData point
valueintegerNumeric value

Example of a success response:

{
"data": [
{
"attributes": {
"dimension_type": "summary",
"point": "2020-07-16T00:00:00+01:00",
"value": 11
},
"type": "Series"

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR CONDITIONS
400 Bad RequestValidation of the parameters has failed; the response contains a detailed explanation
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
404 Not FoundResource was not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Total views for a given time period for all content within a defined dimension

Provides a total view count for both live and on demand content for a defined dimension. Dimensions can be based on geographic regions, devices used to watch or reported by time intervals like month or day.

GET https://analytics-api.video.ibm.com/v1/total-views/{dimension}

Parameters

The query parameters for the GET request:

PARAMETERTYPEIMPORTANCE DESCRIPTION
dimensionstringREQUIREDPossible values are month, day, hour, device, view-source, country, region
date_time_fromstringREQUIREDStart date and time for a period in ISO8601 format
date_time_tostringREQUIREDEnd date and time for a period in ISO8601 format
_pageintegerOPTIONALRequested page number (value is 1 by default)
_limitintegerOPTIONALRequested page size (value is 10 by default, max. 10 000)

Success response

Upon success a response with HTTP status “200 OK” is returned with an array under a data key. The elements of the array contain every data point wrapped in a series object matching the query parameters. Each object has the following attributes under the attributes key:

KEYTYPEDESCRIPTION
dimension_typestringThe requested dimension type
pointarrayData point
valueintegerNumeric value

Example of a success response:

{
"data": [
{
"attributes": {
"dimension_type": "day",
"point": "2020-07-16T00:00:00+01:00",
"value": 11
},
"type": "Series"

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR CONDITIONS
400 Bad RequestValidation of the parameters has failed, the response contains a detailed explanation
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
404 Not FoundResource was not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Total views for a given time period and content type

GET https://analytics-api.video.ibm.com/v1/total-views/{content_type}/summary

Parameters

The query parameters for the GET request:

PARAMETERTYPEIMPORTANCE DESCRIPTION
content_typestringREQUIREDType of the content, either live or recorded
date_time_fromstringREQUIREDStart date and time for a period in ISO8601 format
date_time_tostringREQUIREDEnd date and time for a period in ISO8601 format
_pageintegerOPTIONALRequested page number (value is 1 by default)
_limitintegerOPTIONALRequested page size (value is 10 by default, max. 10 000)

Success response

Upon success a response with HTTP status “200 OK” is returned with an array under a data key. The elements of the array contain every data point wrapped in a series object matching the query parameters. Each object has the following attributes under the attributes key:

KEYTYPEDESCRIPTION
dimension_typestringThe requested dimension type
pointarrayData point
valueintegerNumeric value

Example of a success response:

{
"data": [
{
"attributes": {
"dimension_type": "summary",
"point": "2020-07-16T00:00:00+01:00",
"value": 11
},
"type": "Series"

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR CONDITIONS
400 Bad RequestValidation of the parameters has failed, the response contains a detailed explanation
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
404 Not FoundResource was not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request

Total views for a given time period and content type bucketed by a defined dimension

GET https://analytics-api.video.ibm.com/v1/total-views/{content_type}/{dimension}

Parameters

The query parameters for the GET request:

PARAMETERTYPEIMPORTANCE DESCRIPTION
content_typestringREQUIREDType of the content, either live or recorded
content_idstringOPTIONALA list of comma separated IDs
dimensionstringREQUIREDPossible values are month, day, hour, device, view-source, country, region
date_time_fromstringREQUIREDStart date and time for a period in ISO8601 format
date_time_tostringREQUIREDEnd date and time for a period in ISO8601 format
_pageintegerOPTIONALRequested page number (value is 1 by default)
_limitintegerOPTIONALRequested page size (value is 10 by default, max. 10 000)

Success response

Upon success a response with HTTP status “200 OK” is returned with an array under a data key. The elements of the array contain every data point wrapped in a series object matching the query parameters. Each object has the following attributes under the attributes key:

KEYTYPEDESCRIPTION
dimension_typestringThe requested dimension type
pointarrayData point
valueintegerNumeric value

Example of a success response:

{
"data": [
{
"attributes": {
"dimension_type": "day",
"point": "2020-07-16T00:00:00+01:00",
"value": 11
},
"type": "Series"

Error responses

Possible error responses:

HTTP RESPONSE CODEERROR CONDITIONS
400 Bad RequestValidation of the parameters has failed, the response contains a detailed explanation
401 UnauthorizedThe provided access token is missing, revoked, expired or malformed
404 Not FoundResource was not found
503 Service UnavailableThere is a temporary error on the server which makes it impossible to serve the request