Platform DocsPlayers DocsRelease Notes
API Reference
System StatusSubmit a CaseDashboard LoginCompany Site

Fetches an analytics report over a custom date range

post
https://api.jwplayer.com/v2/sites//analytics/queries/

Fetches an analytics report over a custom date range

Path Params
string
required
length between 8 and 8

Unique alphanumeric ID of the site

Query Params
string
enum
Defaults to default

Data set against which to run the request query

The default option includes all JWX data, excluding OTT data.

The ott option (OTT data) includes the following subset of dimensions and metrics:

DIMENSIONS

  • country_code
  • custom_parameter_name
  • custom_parameter_value
  • eastern_date
  • media_id
  • platform_id
  • playlist_id
  • playlist_type
  • tag
  • upload_date
  • video_duration

METRICS

  • ad_impressions
  • ads_per_viewer
  • completes
  • complete_rate
  • logged_in_unique_viewers
  • plays
  • plays_per_viewer
  • time_watched
  • time_watched_per_viewer
  • unique_viewers
Allowed:
string
enum
Defaults to json

File type of the response query output

Allowed:
Body Params
dimensions
array of strings

Dimensions to include in the report query response

dimensions
string
required

Last date of a query date range in YYYY-MM-DD format

This date is based on UTC -4/ UTC -5. Time zone is affected by whether daylight saving time or standard time is in effect.

filter
array of objects

Defines how to restrict the data returned in the response

filter
integer

Indicates that eligible dimensions are enriched with additional metadata

Depending on the dimension, enriched metadata appears either in the includes or metadata.name object of the query response.

This feature requires an Enterprise account.

Possible Values:

  • 0: Do not include enriched metadata
  • 1: Include enriched metadata

Default: 0

metrics
array of objects
required

Metrics to include in the report query response

metrics*
integer

Index of the page of results

The value of the first page of results is 0. The number of total pages is inversely related to the page_length.

integer

(JSON only) Total number of records returned on each page of results

If not set, the default value is 10. This value must be ≤ 100.

string
enum

Preconfigured time range for a report query

Allowed:
sort
array of objects

Defines the field by which to sort the data and the order of the sort

sort
string
required

First date of a query date range in YYYY-MM-DD format

This date is based on UTC -4/ UTC -5. Time zone is affected by whether daylight saving time or standard time is in effect.

Response

Updated 3 months ago

Language
Credentials
Header
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago 
© 2007- Longtail Ad Solutions, Inc.