Ingest

Operations related to ingest analytics for a live stream.

Fetch ingest analytics data for a live stream

(Available from version 1.11) This operation returns the ingest data for a specific live stream. You'll use the query parameters to return live vs historic data, as well as specific types of ingest data.

Querying live data

To get data for currently live streams, do not send include, from, and to values.

This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value.

Querying historic data

To get data for streams that ran previously, send include, from, and to values.

This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value in addition to trend data.

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 includes minutes and seconds. If you include seconds, Wowza Video rounds down to the minute. The maximum difference between from and to is 90 days. If you set the from query parameter without setting the to query parameter, the data returned will reflect 90 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 includes minutes and seconds. If you include seconds, Wowza Video rounds down to the minute. The maximum difference between from and to is 90 days. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 90 days or from your last invoice date, whichever is shorter.

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

include
string

Specify the data you want returned in the response.

Valid value is: trend.

Example: trend

Responses
200

Success

Response Schema: application/json
object (live_stream)
object (limits_metric)

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/analytics/ingest/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/ingest/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": {
    }
}