About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Analytics API Getting Started
Authentication
The API uses JWT token for authentication. The API accepts the token in the
Authorization
header, in the following format:
Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6Ik...0RMHrHDcEfxjoYZgeFONFh7HgQ
This header must be included with every request.
Obtaining the Access token
You can get JWT token from the OAuth2 token endpoint by setting the token_type
parameter to jwt
. This parameter must be set as HTTP POST parameter.
The OAuth2 flows are described here: Basic Authentication
The recommended authentication flow is Client credentials.
Time format
Every time field provided by the API is formatted by ISO8601 format (eg. 2018-07-16T19:20:30+01:00
).
The API also accepts parameters in this format only.
Terminology
- media: Media is a common word for both live broadcasts and recorded videos
- content type: The API has knowledge of two types of content that are live broadcasts and recorded videos
- content id: A numeric identifier of the media. For live it means channel ID, for video it means video ID
- segment: A part of the media watched by the user
Response times
Depending on your query and the underlying data size the response might take a minute.