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 JW Player Enterprise license.
Metrics
A metric is a quantitative measurement. The following sections list the metrics that we currently offer.
Ads
| Name | Metric ID | Description |
|---|---|---|
| Ad Clicks* integer | ad_clicks |
Number of times a video ad was clicked in an embedded player |
| Ad Completes* integer | ad_completes |
Number of times a video ad was completed in an embedded player |
| Ad Skips* integer | ad_skips |
Number of times a video ad was skipped in an embedded player |
* This premium metric requires a JW Player Enterprise or Developer license.
Engagement
| Name | Metric ID | Description |
|---|---|---|
| 25% Completes integer | 25_percent_completes |
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 integer | 50_percent_completes |
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 integer | 75_percent_completes |
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 percent | adjusted_complete_rate |
Adjusted completes per plays This metric is not available in dashboard Custom Reports. |
| Adjusted Completes integer | adjusted_completes |
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 not available in dashboard Custom Reports. |
| Complete Rate percent | complete_rate |
Plays per completes, expressed as a percentage |
| Content Score* integer | content_score |
Average of the play rate and complete rate |
* This premium metric requires a JW Player Enterprise or Developer license.
Performance
| Name | Metric_ID | Type | Description |
|---|---|---|---|
3-Second Plays☨  | 3_second_plays | Integer | Number of times viewers watched to the 3-second mark of a media item |
| 10-Second Plays☨ | 10_second_plays | Integer | Number of times viewers watched to the 10-second mark of a media item |
| 30-Second Plays☨ | 30_second_plays | Integer | Number of times viewers watched to the 30-second mark of a media item |
| Ad Impressions | ad_impressions | Integer | Number of ad starts across all embedded players |
| Completes | completes | Integer | Number of times a viewer watched the total duration 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: loading or refreshing a page with an embedded player, resetting an embedded player without refreshing the page. |
| 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 video starts across all embedded players 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 content watched across all embedded players, measured in seconds This metric excludes the duration of external live streams watched. |
* This premium metric requires a JW Player Enterprise or Developer license.
☨ This premium metric requires both a JW Player Enterprise and special authorization. Please contact your JW Player representative.
Viewers
| Name | Metric_ID | Type | Description |
|---|---|---|---|
| Ad Impressions per Viewer* | ads_per_viewer | Integer | Average number of ad impressions for a unique 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 OTT Apps that are integrated with a subscriber management provider, such as Cleeng or InPlayer. |
| Plays per Viewer* | plays_per_viewer | Integer | Average number of plays for each unique viewer |
| Time Watched per Viewer* | time_watched_per_viewer | Integer | Average duration of content watched for a unique viewer |
| Unique Viewers* | unique_viewers | Integer | Number of unique users who have played at least one media item |
* This premium metric requires a JW Player Enterprise or Developer license.
Dimensions
A dimension is an attribute of your metrics. For example, each Play Event has several attributes that help describe it. JW Player determines what Country it took place in, what Video it was for, what device was used, etc.
Content
| Name | Dimension_ID | Type | Description |
|---|---|---|---|
| Ad Schedule* | ad_schedule_id | String | 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 |
| Media | media_id | String | ID of the media item |
| Media Tag* | tag | String | Metadata associated with a media item |
| Play Reason* | play_reason | String | Indicator of how media playback was initiated Possible values: • autoplay: Autostarted playback, not dependent upon player viewability settings• click: A user clicked on the video• external: JavaScript call to the JW Player API• progression: Auto-advance on dynamic and manual playlists• related: Auto-advance on recommendation, search, and trending playlists• repeat: Auto-repeat based on the configuration of the player• unknown: Unknown reason• viewable: Autostarted playback when the player was viewable, dependent upon player viewability settings |
| Player | player_id | String | ID of the player on the page |
| Player Playback Mode | player_playback_mode | String | The player’s playback mode when the first frame of content is rendered. Possible values include: • VOD: Video on Demand• LIVE: Livestreams that do not support seeking• DVR: Livestreams that support seeking• NULL: Embed without plays |
| Playlist | playlist_id | String | ID of the playlist loaded into the player |
| Playlist Type* | playlist_type | String | Type of playlist Possible values include: • Article Matching• Dynamic• Feed1• Manual• None• Search• Trending |
| 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 | - | Duration of the content Possible values include: • Short (under 4 mins)• Medium (4-20 mins)• Long (over 20 mins) |
* This premium dimension requires a JW Player Enterprise or Developer license.
1 This is the same as a recommendations playlist.
Date/Time
| Name | Dimension_ID | Type | 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 dimension requires a JW Player Enterprise or Developer license.
Device
| Name | Dimension_ID | Type | 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 |
| Platform* | platform_id | String | SDK platform in which the player was embedded Possible values include: • android• chromecast (Chromecast Receiver)• fireos (Fire OS)• ios• roku• tvos (tvOS)• unknown• web |
* This premium dimension requires a JW Player Enterprise or Developer license.
Geography
| Name | Dimension_ID | Type | 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 dimension requires a JW Player Enterprise or Developer license.
Placement
| Name | Dimension_ID | Type | Description |
|---|---|---|---|
| Domain | page_domain | String | Domain within which a player was embedded Excluding www, all subdomains are also included. |
| URL* | page_url | String | URL of the page within which a player was embedded |
* This premium dimension requires a JW Player Enterprise license.
Updated 5 months ago