Toplivestream

Returns top statistics for live streams.

It is not possible to filter on both geographic data and on clients.

Tokens

This action requires the following tokens:

  • stats-view

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
alsodeleted Boolean false If set to true, also include the deleted objects in the results
client Label   Only show stats for the given client
clientformfactor Label   Only show stats for the given client form factor
clientsoftwaretype Label   Only show stats for the given client software type
clientos Label   Only show stats for the given client OS
clientosname String   Only show stats for the clients with the given OS name
clientosversion String   Only show stats for the clients with the given OS version
clientsoftware Label   Only show stats for the given client software
clientsoftwarename String   Only show stats for the clients with the given software name
clientsoftwareversion String   Only show stats for the clients with the given software version
countrycode String   Only show stats for the given country
regioncode String   Only show stats for the given region
cityname String   Only show stats for the given city
start DateTime   The start of the range to get the stats from. If omitted, return stats from the first moment available
end DateTime   The end of the range to get the stats from. If omitted, return stats until the last moment available
createdafter DateTime   Only consider Items which have a creation date later than or equal to the argument. Using this option also excludes archived items from the results.
sortby String plays

Fetch the top-X given by this sorting criteria

This argument can only contain one of the following values:

  • views
  • bytes
  • plays
  • impressions
  • impressionsab
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
firstdate DateTime The earliest date that stats are available for the provided arguments. The start date will take into account the creation of specific items and live streams if provided and it will never return a date below the date the account or customer was created, if these are supplied. Requesting stats for the current arguments before this date will thus not return anything
lastdate DateTime The latest date that stats are available for the provided arguments. Requesting stats for the current arguments after this date will thus not return anything

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
livestream

The live stream of this top-X object

The value of this field is an object containing the following fields:

Name Type Description
id Hash Livestream ID
title String Title of the live stream
description String Description of the live stream
type Label The type of this livestream; for available livestream types, refer to the documentation of the Livestream command
account

The account to which the live stream belongs

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
views Integer Number of (unique) views, as defined in Statistics
bytes Integer Number of bytes, as defined in Statistics
plays Integer Number of plays, as defined in Statistics
impressions Integer Number of impressions, as defined in Statistics
impressionsab Integer Number of ad-blocked impressions, as defined in Statistics
avgsecondsviewed Integer Average number of seconds viewed, as defined in Statistics
secondsviewed Integer Number seconds viewed, as defined in Statistics
avgviewers Integer Number of viewers, as defined in Statistics
adimpressions Integer Number of ad impressions, as defined in Statistics
adstarts Integer Number of ad starts, as defined in Statistics
adskips Integer Number of ad skips, as defined in Statistics
adcompletes Integer Number of ad completes, as defined in Statistics
adclicks Integer Number of ad clicks, as defined in Statistics

Errors

This action will always return one of the default status codes.