Metrics and dimensions
Read definitions of each metric and dimension returned in an Analytics API query response.
- Premium metrics and dimensions denoted in the following tables require a JWP Enterprise license.
- Be mindful of the Data Availability when making queries.
Metrics
A metric is a quantitative measurement. The following sections list the metrics that we currently offer.
Ads
Name | Metric ID | Description |
---|---|---|
Ad Clicks* | ad_clicks integer | Number of times a video ad was clicked in an embedded player |
Ad Completes* | ad_completes integer | Number of times a video ad was completed in an embedded player |
Ad Skips* | ad_skips integer | Number of times a video ad was skipped in an embedded player |
* This premium metric requires a JWP Enterprise license.
Engagement
Name | Metric ID | Description |
---|---|---|
25% Completes | 25_percent_completes integer | Number of times viewers watched to the 25% mark of a media item
This metric is only available for media items over 30 seconds. |
50% Completes | 50_percent_completes integer | Number of times viewers watched to the 50% mark of a media item
This metrics is only available for media items over 30 seconds. |
75% Completes | 75_percent_completes integer | Number of times viewers watched to the 75% mark of a media item
This metrics is only available for media items over 30 seconds. |
Adjusted Complete Rate | adjusted_complete_rate percent | Adjusted completes per play
This metric is only available through the API. |
Adjusted Completes | adjusted_completes integer | Used to calculate the Content Score, number of times a viewer watched at least 75% the total duration of a media item
This metric is only available through the API. |
Complete Rate | complete_rate percent | Ratio of completes divided by plays
This metric provides insight into how often users watch the end of a media item after starting it. |
Content Score* | content_score integer | Average of the play rate and complete rate
This metric is only available through the API. |
* This premium metric requires a JWP Enterprise license.
Performance
Name | Metric ID | Description |
---|---|---|
Ad Impressions | ad_impressions integer | Number of ad starts across all embedded players |
Completes | completes integer | Number of times a viewer watched the end of a media item |
Embeds | embeds integer | Number of times a player has been set up on a page
The following behaviors can log an embed:
|
Play Rate* | play_rate percent | Plays per embeds
Only the first play (based on the firstFrame event) for a given embed is counted.
|
Plays | plays integer | Number of media item starts
The player does not have to be visible for this event to fire. This is based on the firstFrame player event.
|
Time Watched | time_watched integer | Total duration of media content watched, measured in seconds
This metric excludes the duration of external live streams watched. |
* This premium metric requires a JWP Enterprise license.
Viewers
Name | Metric ID | Description |
---|---|---|
Ad Impressions per Viewer* | ads_per_viewer integer | Number of ad impressions divided by the number of unique viewers
This provides insight into how many ads are being served for each viewer. |
Logged-In Unique Viewers* | logged_in_unique_viewers integer | Number of unique authenticated users who have played at least one media item
Values are only returned for Apps that are integrated with a subscriber management provider, such as Cleeng or InPlayer. |
Plays per Viewer* | plays_per_viewer integer | Number of plays divided by the number of unique viewers
This provides insight into how many media items are being watched by each viewer. |
Time Watched per Viewer | time_watched_per_viewer integer | Total time watched in seconds divided by the number of unique viewers
This provides insight into the duration of a media item each viewer is watching. |
Unique Viewers | unique_viewers integer | Approximate number of unique users who have played at least one media item
A unique viewer is defined by IP and user agent. |
* This premium metric requires a JWP Enterprise license.
Dimensions
A dimension is an attribute of your metrics. For example, each play event has several attributes that add context to the event. JWP determines the country where the event occurred, the associated video, and the device used.
Content
Name | Dimension ID | Description |
---|---|---|
Ad Schedule* | ad_schedule_id string | (Custom Reports) Name or ID associated with a specific ad schedule
(API) ID associated with a specific ad schedule |
Is First Play* | is_first_play boolean | Indicator that the media was the first media item within a playlist or embed |
Media | media_id string | (Custom Reports) Name or ID of the media item
(API) ID of the media item |
Media Tag* | tag string | Metadata media tag associated with a media item |
Play Reason* | play_reason string | Indicator of how media playback was initiated
Possible Values:
|
Player | player_id string | (Custom Reports) Name or ID of the player
(API) ID of the player |
Player Playback Mode | player_playback_mode string | Player's playback mode when the first frame of content is rendered
Possible Values:
|
Playlist | playlist_id string | (Custom Reports) Name or ID of the playlist
(API) ID of the playlist |
Playlist Type* | playlist_type string | Type of playlist
Possible Values:
|
Promotion* | promotion string | ID of the playlist pinned into a recommendations playlist that promoted the media item played in a player |
Video Duration* | video_duration string | Duration of the content
Possible Values:
|
* This premium metric requires a JWP Enterprise license.
1 This is the same as a recommendations playlist.
Date/Time
Name | Dimension ID | Description |
---|---|---|
Eastern Date | eastern_date string | Date when the media item started to play within a player, using YYYY-MM-DD (USA - Eastern Time) format |
Upload Date* | upload_date string | Date when the media item was last uploaded to the platform, using YYYY-MM-DD (USA - Eastern Time) format |
* This premium metric requires a JWP Enterprise license.
Device
Name | Dimension ID | Description |
---|---|---|
Browser* | browser string | Type of browser used to watch a media item |
Device | device_id string | Type of device used to watch a media item
Possible Values:
|
Platform* | platform_id string | SDK platform in which the player was embedded
Possible Values:
|
* This premium metric requires a JWP Enterprise license.
Geography
Name | Dimension ID | Description |
---|---|---|
City* | city string | City from which a user accessed the media item
The value is based on the ISO 3166-2 standard. |
Country | country_code string | Two-letter country code from which a user accessed a media item
The value is the ISO 3166-1 alpha-2 country code. |
* This premium metric requires a JWP Enterprise license.
Placement
Name | Dimension ID | Description |
---|---|---|
Domain | page_domain string | Domain within which a player was embedded
By excluding www, all subdomains are also included. |
URL* | page_url string | URL of the page within which a player was embedded |
* This premium metric requires a JWP Enterprise license.
Updated about 1 month ago