Metrics and dimensions

Read definitions of each metric and dimension returned in an Analytics API query response.

Last Updated: August 6, 2019

IMPORTANT

Premium metrics and dimensions denoted in the following tables require a JW Player Enterprise or Developer license.

Metrics

A metric is a quantitative measurement. The following sections list the metrics that we currently offer.

Ads

Name Metric_ID Type 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 JW Player Enterprise or Developer license.


Engagement

Name Metric_ID Type 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 plays

This metric is not available in dashboard Custom Reports.
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 not available in dashboard Custom Reports.
Complete Rate complete_rate Percent Plays per completes, expressed as a percentage
Content Score* content_score Integer 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
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 Integer Indicator of how media playback was initiated

Possible values include:

0: Unknown reason
1: A user clicked on the video
2: Autostarted playback, not dependent upon player viewability settings
3: Auto-repeat based on the configuration of the player
4: JavaScript call to the JW Player API
5: Auto-advance on recommendation, search, and trending playlists
6: Auto-advance on dynamic and manual playlists
7: Autostarted playback when the player was viewable, dependent upon player viewability settings
Player player_id String ID of the player on the page
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 or Developer license.


Metrics and dimensions


Read definitions of each metric and dimension returned in an Analytics API query response.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.