Statistics
The Statistics Endpoint allows you to query all statistical Data from all nexxOMNIA/nexxPLAY Environments by API. All Endpoints return an Object with "day" as Key and "KPI" as Value, unless otherwise indicated.
Please notice, that this Endpoint uses a different Set of Parameters as the usual Media Endpoints. Please make sure, that the mandatory Parameters are set.
You will find the full List of Parameters for all Statistic Endpoints at the End of this Section.
get
https://api.nexx.cloud/v3.1/
statistics/displaysbyday
/displaysbyday
get
https://api.nexx.cloud/v3.1/
statistics/playerstartsbyday
/playerstartsbyday
get
https://api.nexx.cloud/v3.1/
statistics/viewsbyday
/viewsbyday
get
https://api.nexx.cloud/v3.1/
statistics/downloadsbyday
/downloadsbyday
get
https://api.nexx.cloud/v3.1/
statistics/clicksbyday
/clicksbyday
You can replace "byday" for Displays, PlayerStarts, Views, Downloads and Clicks with "byhour" or "byweekday" if you need the Results to be grouped by the respective timeframe.
get
https://api.nexx.cloud/v3.1/
statistics/viewsexternalbyday
/viewsexternalbyday
get
https://api.nexx.cloud/v3.1/
statistics/viewtimebyday
/viewtimebyday
get
https://api.nexx.cloud/v3.1/
statistics/viewtimeaveragebyday
/viewtimeaveragebyday
get
https://api.nexx.cloud/v3.1/
statistics/viewprogressbyday
/viewprogressbyday
get
https://api.nexx.cloud/v3.1/
statistics/itemlist
/itemlist
The Chart Endpoints return an Object with Media ID as Key and KPI as Value.
get
https://api.nexx.cloud/v3.1/
statistics/chartsbydisplays
/chartsbydisplays
get
https://api.nexx.cloud/v3.1/
statistics/chartsbyplayerstarts
/chartsbyplayerstarts
get
https://api.nexx.cloud/v3.1/
statistics/chartsbyviews
/chartsbyviews
get
https://api.nexx.cloud/v3.1/
statistics/chartsbyviewsexternal
/chartsbyviewsexternal
get
https://api.nexx.cloud/v3.1/
statistics/chartsbyviewtime
/chartsbyviewtime
get
https://api.nexx.cloud/v3.1/
statistics/chartsbyviewtimeaverage
/chartsbyviewtimeaverage
get
https://api.nexx.cloud/v3.1/
statistics/chartsbycompletion
/chartsbycompletion
get
https://api.nexx.cloud/v3.1/
statistics/chartsbydownloads
/chartsbydownloads
get
https://api.nexx.cloud/v3.1/
statistics/chartsbyclicks
/chartsbyclicks
The Distribution Endpoints return an Object with Distribution Item (for exmaple, Country Code) as Key and Number of Occurences as Value.
get
https://api.nexx.cloud/v3.1/
statistics/distributionbygateway
/distributionbygateway
get
https://api.nexx.cloud/v3.1/
statistics/distributionbydevice
/distributionbydevice
get
https://api.nexx.cloud/v3.1/
statistics/distributionbyos
/distributionbyos
get
https://api.nexx.cloud/v3.1/
statistics/distributionbybrowser
/distributionbybrowser
get
https://api.nexx.cloud/v3.1/
statistics/distributionbydeliverydomain
/distributionbydeliverydomain
get
https://api.nexx.cloud/v3.1/
statistics/distributionbyslug
/distributionbyslug
get
https://api.nexx.cloud/v3.1/
statistics/distributionbypodcastapp
/distributionbypodcastapp
get
https://api.nexx.cloud/v3.1/
statistics/distributionbycountry
/distributionbycountry
get
https://api.nexx.cloud/v3.1/
statistics/distributionbychannel
/distributionbychannel
get
https://api.nexx.cloud/v3.1/
statistics/distributionbyformat
/distributionbyformat
get
https://api.nexx.cloud/v3.1/
statistics/distributionbylicensor
/distributionbylicensor
The RealTime Endpoints will return an Object with Performance KPIs per Gateway (or per Media ID in case of the RealTime Chart Endpoints) for the given Period.
The RealTime Endpoints will not respect any of the given Standard Statistics Parameters below (except "streamtype").
get
https://api.nexx.cloud/v3.1/
statistics/realtime
/realtime
get
https://api.nexx.cloud/v3.1/
statistics/realtimeexternal
/realtimeexternal
get
https://api.nexx.cloud/v3.1/
statistics/realtimecharts
/realtimecharts
get
https://api.nexx.cloud/v3.1/
statistics/realtimechartsexternal
/realtimechartsexternal
get
https://api.nexx.cloud/v3.1/
statistics/adrequestsbyday
/adrequestsbyday
get
https://api.nexx.cloud/v3.1/
statistics/adimpressionsbyday
/adimpressionsbyday
get
https://api.nexx.cloud/v3.1/
statistics/adclicksbyday
/adclicksbyday
get
https://api.nexx.cloud/v3.1/
statistics/aderrorsbyday
/aderrorsbyday
You can replace "byday" in all Cases with "byhour" or "byweekday" if you need the Results to be grouped by the respective timeframe.
get
https://api.nexx.cloud/v3.1/
statistics/registationsbyday
/registrationsbyday
get
https://api.nexx.cloud/v3.1/
statistics/loginsbyday
/loginsbyday
get
https://api.nexx.cloud/v3.1/
statistics/revenuebyday
/revenuebyday
get
https://api.nexx.cloud/v3.1/
statistics/subscriptionsbyday
/subscriptionsbyday
get
https://api.nexx.cloud/v3.1/
statistics/subscriptionterminationsbyday
/subscriptionterminationsbyday
Parameter | Values | Description |
includeNetworkDomains | [0, 1] | if the calling Domain is Network Domain, and all Results from all Network Domains shall be combined, set this Parameter to 1 |
streamtype | Streamtype | the target Media Streamtype (mandatory) |
from | Date (YYYY-MM-DD) | Starting Day of the Analysis (mandatory) |
to | Date (YYYY-MM-DD) | End Day of the Analysis (mandatory) |
gateway | [desktop, mobile, amp, fbia, tablet, ios, android, smarttv, androidtv, podcast] | The Analysis will only respect Results from this Gateway. |
timezone | TimeZone Name | The Analysis will consider from/to and Day Borders as Dates in the given Timezone. If skipped, the Domain Default Timezone will be used. |
device | [pc, mobile, tablet, tv, smart] | The Analysis will only respect Results by items of this Device Type |
item | int | The Analysis will focus only on a specific Media item (if item is set, and streamtype is set to "allmedia", item will be interpreted as GlobalID) |
itemReference | [ID, GID, hash, refnr, externalReference] | If Media Items are used as Keys for the Result Items, by default, their "ID" is returned. Setting this Parameter to another Item Property will change this Key to the desired Attribute. |
limit | int | in contrast to the Media API, the limit can be set on this Endpoint to 100.000 if necessary. This can make sense on all Methods, that return long lists of Media Items. |
channel | int | The Analysis will only respect Results in this Channel |
format | int | The Analysis will only respect Results in this Format |
deliveryPartner | int | The Analysis will only respect Results from this Delivery Partner |
affiliatePartner | int | The Analysis will only respect Results from this Affiliate Partner |
campaign | int | The Analysis will only respect Results from this Campaign |
licensor | int | The Analysis will only respect Results by items of this Licensor |
pageIntegration | [js, embed, wc, native] | The Analysis will only respect Results by items of Media, that was included by this Type of integration. |
browser | [firefox, chrome, edge, explorer, safari, opera, samsung browser] | The Analysis will only respect Results by Media, that was delivered on the given Browser |
os | [windows, macOS, linux, ios, android, chromeOS] | The Analysis will only respect Results by Media, that was delivered on the given Operating System |
countryCode | 2-Letter Country Code | The Analysis will only respect Results by Media, that was delivered in the given Country |
regionCode | int | The Analytics will only respect Results by Media, that was delivered in the given Country Region (3Q nexx Region ID) |
manufacturer | String | The Analysis will only respect Results by Media, that was delivered by Devices from the given Manufacturer. |
deliveryDomain | String | The Analysis will only respect Results by Media, that was delivered on the given Domain |
consentEnvironment | [none, onlystring, 1, 2] | The Analysis will only respect Results by Media, that were delivered in the given User Consent Environment |
playbackMode | [bumper, preview, pseudolive, scenesplit, story, presentation, endless, premiere, mini, micro, hero] | The Analysis will only respect Results by Media, that was delivered in this PlaybackMode |
dataMode | [api, static, offline] | The Analysis will only respect Results by Media, that was delivered in this DataMode |
mediaOrigin | [own, remote] | The Analysis will only respect Results by Media, that are managed by nexxOMNIA (or are Remote Media) |
startCondition | [autoplay, autoplaymuted, manual, manualmuted] | The Analysis will only respect Results by Media, that was started as defined. |
viewCount | [onlyfirst, afterfirst] | The Analysis will only respect Results, where the View was the initial Media in the Player ("onlyfirst") or came later ("afterfirst") |
Last modified 7d ago