Popularity

Operations related to popularity analytics.

Fetch popularity analytics data for a live stream

(Available from version 1.11) This operation returns the popularity data for a specific live stream. Popularity data provides insight into how many times your stream is displayed to a possible viewer and how many times it's played.

If you don't send from and to query parameters, the last hour's worth of data is returned.

Use the include query parameter to specify whether you want to return trend data. See the trend field in the response for information about sample intervals.

If the time range between from and to query parameters is:

  • Less than 60 minutes, the cache time between responses is 10 seconds.
  • More than 60 minutes, the cache time between responses is 60 seconds.
Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

query Parameters
from
string <date-time>

Use this parameter, along with to, to return historic viewer data.

The start of the range of time you want to view. Specify YYYY-DD-MMT HH:MM:SSZ where HH is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the from query parameter without setting the to query parameter, the data returned will reflect 30 days starting at the from date, or data up to to the current day, whichever is shorter.

Example: 2023-01-14T10:31:54.486Z

to
string <date-time>

Use this parameter, along with from, to return historic viewer data.

The end of the range of time you want to view. Specify YYYY-DD-MMT HH:MM:SSZ where HH is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 30 days.

Example: 2023-02-14T10:31:54.486Z

include
string

Specify the data you want returned in the response. he only valid value for this endpoint is trend.

Valid value is: trend.

Example: trend

Responses
200

Success

Response Schema: application/json
object (live_stream)
id
string <int32>

The unique alphanumeric string that identifies the live stream.

plays
integer <int32>

The total number of plays for a live stream. A play is registered when the stream begins to play.

displays
integer <int32>

The total number of displays for a live stream. A display is registered when the player is completely loaded and ready to play the live stream.

object (Array of popularity trends)

An array of popularity trend data. The granularity of sampled data changes based on the from and to query values you use:

  1. Requests made for data within the most recent 3 days returns sample intervals by the hour. You can return sample intervals by the minute by specifying a specific hour range.

  2. Requests made for data beyond the most recent 3 days can only return sample intervals by the hour or day. The minute data is not retained beyond the 3rd day.

Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days.

Default: Last hour

object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/analytics/popularity/live_streams/{id}
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/analytics/popularity/live_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend"
Response samples
application/json
{
  • "live_stream": {
    },
  • "limits": {
    }
}

Fetch popularity analytics data for a VOD stream

(Available from version 1.11) This operation returns the popularity data for a specific VOD stream. Popularity data provides insight into how many times your video is displayed to a possible viewer and how many times it's played.

If you don't send from and to query parameters, the last hour's worth of data is returned. See the trend field in the response for information about sample intervals.

Use the include query parameter to specify whether you want to return trend data. See the trend field in the response for information about sample intervals.

If the time range between from and to query parameters is:

  • Less than 60 minutes, the cache time between responses is 10 seconds.
  • More than 60 minutes, the cache time between responses is 60 seconds.
Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

query Parameters
from
string <date-time>

Use this parameter, along with to, to return historic viewer data.

The start of the range of time you want to view. Specify YYYY-DD-MMT HH:MM:SSZ where HH is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the from query parameter without setting the to query parameter, the data returned will reflect 30 days starting at the from date, or data up to to the current day, whichever is shorter.

Example: 2023-01-14T10:31:54.486Z

to
string <date-time>

Use this parameter, along with from, to return historic viewer data.

The end of the range of time you want to view. Specify YYYY-DD-MMT HH:MM:SSZ where HH is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 30 days.

Example: 2023-02-14T10:31:54.486Z

include
string

Specify the data you want returned in the response. The only valid value for this endpoint is trend.

Valid value is: trend.

Example: trend

Responses
200

Success

Response Schema: application/json
object (vod_stream)
id
string <int32>

The unique alphanumeric string that identifies the VOD stream.

plays
integer <int32>

The total number of plays for a VOD stream. A play is registered when the stream begins to play.

displays
integer <int32>

The total number of displays for a VOD stream. A display is registered when the player is completely loaded and ready to play the VOD stream.

object (Array of popularity trends)

An array of popularity trend data. The granularity of sampled data changes based on the from and to query values you use:

  1. Requests made for data within the most recent 3 days returns sample intervals by the hour. You can return sample intervals by the minute by specifying a specific hour range.

  2. Requests made for data beyond the most recent 3 days can only return sample intervals by the hour or day. The minute data is not retained beyond the 3rd day.

Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days.

Default: Last hour

object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/analytics/popularity/vod_streams/{id}
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/analytics/popularity/vod_streams/tvctq36g?from=2023-04-14T10:31:54.486Z&to=2023-07-13T10:31:54.486Z&include=trend"
Response samples
application/json
{
  • "vod_stream": {
    },
  • "limits": {
    }
}
© 2007-2024 Wowza Media Systems, ™ LLC. All rights reserved.   Security & Privacy Policy | Legal | System Status