<img src="https://img.shields.io/badge/%20-ALL-%2300B180" style="float:left"/><br />

ο»Ώ

  • Premium metrics and dimensions denoted in the following tables require a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

  • Be mindful of the <a href="https://docs.jwplayer.com/platform/docs/analytics-data-availability" target="_blank">Data Availability</a> when making queries.

<br />

This reference details each available metric and dimension across JWP's analytics offerings.

The following tables use the following icons:

  • βœ… - The product offering supports the metric or dimension.

  • ❌ - The product offering does not support the metric or dimension.

  • ℹ️ - This dimension or metric requires an SQL query or calculation.


ο»Ώ

## Metrics

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

### Ads

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name</th> <th> API ID</th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>Ad Clicks*</strong></td> <td width="25%"> <strong>ad_clicks</strong> integer </td> <td width="30%"> Number of times a video ad was clicked in an embedded player </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Ad Completes*</strong></td> <td> <strong>ad_completes</strong> integer</td> <td> Number of times a video ad was completed in an embedded player </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Ad Skips*</strong></td> <td> <strong>ad_skips</strong> integer </td> <td> Number of times a video ad was skipped in an embedded player </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

### Engagement

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name</th> <th> API ID</th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>25% Completes</strong> </td> <td width="25%"> <strong>25_percent_completes</strong> integer </td> <td width="30%"> Number of times viewers watched to the 25% mark of a media item <br /><br /> This metric is only available for media items over 30 seconds. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#engagement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></a></div> </td> </tr> <tr> <td> <strong>50% Completes</strong> </td> <td> <strong>50_percent_completes</strong> integer </td> <td> Number of times viewers watched to the 50% mark of a media item <br /><br /> This metrics is only available for media items over 30 seconds. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#engagement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></a></div> </td> </tr> <tr> <td> <strong>75% Completes</strong> </td> <td> <strong>75_percent_completes</strong> integer </td> <td> Number of times viewers watched to the 75% mark of a media item <br /><br /> This metrics is only available for media items over 30 seconds. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#engagement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Adjusted Complete Rate</strong> </td> <td> <strong>adjusted_complete_rate</strong> percent </td> <td> Adjusted completes per play <br /><br /> This metric is only available through the API. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Adjusted Completes</strong> </td> <td> <strong>adjusted_completes</strong> integer </td> <td> Used to calculate the Content Score, number of times a viewer watched at least 75% the total duration of a media item <br /><br /> This metric is only available through the API. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Complete Rate</strong> </td> <td> <strong>complete_rate</strong> percent </td> <td> Ratio of completes divided by plays <br /><br /> This metric provides insight into how often users watch the end of a media item after starting it. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Content Score*</strong> </td> <td> <strong>content_score</strong> integer </td> <td> Average of the play rate and complete rate <br /><br /> This metric is only available through the API. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Video Seeks</strong> </td> <td> <strong>video_seeks</strong> integer </td> <td> Total number of times the user used the seek functionality of the player during this play session </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#engagement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></a></div> </td> </tr> <tr> <td> <strong>Video Shares</strong> </td> <td> <strong>video_shares</strong> integer </td> <td> Total number of times a viewer has clicked an option to share to social media </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#engagement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></a></div> </td> </tr> <tr> <td> <strong>Watched Duration Viewable</strong> </td> <td> <strong>watched_duration_viewable</strong> integer </td> <td> Total viewable watched duration for this session in seconds <br /><br /> In this instance, <em>viewable</em> means that 50% of the video pixels are in the viewport of the active tab. </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#engagement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

### Performance

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name</th> <th> API ID</th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>Ad Impressions</strong> </td> <td width="25%"> <strong>ad_impressions</strong> integer </td> <td width="30%" > Number of ad starts across all embedded players</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Ad Viewable Impressions</strong> </td> <td> <strong>ad_viewable_impressions</strong> integer </td> <td> Total number of viewable ad impressions in this session, as defined by the IAB (a viewer has watched an ad for 2 consecutive seconds with at least 50% of the pixels in the viewport) <br /><br /> The following are required to properly receive metrics: <ul> <li>Player version 8.5+</li> <li>Ad schedule ID</li> </ul> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#performance" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Completes</strong> </td> <td> <strong>completes</strong> integer </td> <td> Number of times a viewer watched the end of a media item</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Count Playback Stalls</strong> </td> <td> <strong>count_playback_stalls</strong> integer </td> <td> Number of times the player buffers for this play session</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#performance" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Embeds</strong> </td> <td> <strong>embeds</strong> integer </td> <td> Number of times a player has been set up on a page <br /><br /> The following behaviors can log an embed: <ul> <li>Loading or refreshing a page with an embedded</li> <li>Resetting an embedded player without refreshing the page</li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>First Frame</strong> </td> <td> <strong>first_frame</strong> integer </td> <td> Time in milliseconds (ms) until first frame is displayed </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#performance" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Play Rate*</strong> </td> <td> <strong>play_rate</strong> percent </td> <td> Plays per embeds <br /><br /> Only the first play (based on the <code>firstFrame</code> event) for a given embed is counted. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#performance" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Plays</strong> </td> <td> <strong>plays</strong> integer </td> <td> Number of media item starts <br /><br /> The player does not have to be visible for this event to fire. This is based on the <code>firstFrame</code> player event. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Setup Duration</strong> </td> <td> <strong>setup_duration</strong> integer </td> <td> Time in milliseconds (ms) for the player to set up </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Time Watched</strong> </td> <td> <strong>time_watched</strong> integer </td> <td> Total duration of media content watched, measured in seconds <br /><br /> This metric excludes the duration of external live streams watched. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#performance" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Underbuffer (cumulative)</strong> </td> <td> <strong>underbuffer_cumulative</strong> integer </td> <td> Total milliseconds (ms) spent buffering since the play attempt for a given media item</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

### Viewers

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name</th> <th> API ID</th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>Ad Impressions per Viewer*</strong> </td> <td width="25%"> <strong>ads_per_viewer</strong> integer </td> <td width="30%"> Number of ad impressions divided by the number of unique viewers <br /><br /> This provides insight into how many ads are being served for each viewer. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#viewers" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Logged-In Unique Viewers*</strong></td> <td> <strong>logged_in_unique_viewers</strong> integer </td> <td> Number of unique authenticated users who have played at least one media item <br /><br /> Values are only returned for Apps that are integrated with a subscriber management provider, such as Cleeng or InPlayer. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Plays per Viewer*</strong> </td> <td> <strong>plays_per_viewer</strong> integer </td> <td> Number of plays divided by the number of unique viewers <br /><br /> This provides insight into how many media items are being watched by each viewer. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#viewers" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Time Watched per Viewer</strong></td> <td> <strong>time_watched_per_viewer</strong> integer </td> <td> Total time watched in seconds divided by the number of unique viewers <br /><br /> This provides insight into the duration of a media item each viewer is watching. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#viewers" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Unique Viewers</strong> </td> <td> <strong>unique_viewers</strong> integer </td> <td> Approximate number of unique users who have played at least one media item <br /><br /> A unique viewer is defined by IP and user agent. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#viewers" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />


ο»Ώ

## 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.

<br />

### \_Content

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name </th> <th> Dimension ID </th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>Ad Client</strong> </td> <td width="25%"> <strong>ad_client</strong> integer </td> <td width="30%"> Ad client being used <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>Null</code>: Player not enabled for ads</li> <li><code>0</code>: VAST</li> <li><code>1</code>: Google IMA</li> <li><code>2</code>: FreeWheel</li> <li><code>3</code>: DAI</li> </ul> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Ad Schedule*</strong> </td> <td> <strong>ad_schedule_id</strong> string </td> <td> (Custom Reports) Name or ID associated with a specific ad schedule <br /><br /> (API) ID associated with a specific ad schedule </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Advance Type</strong> </td> <td> <strong>advance_type</strong> string </td> <td> Denotes the method by which the playlist advanced at the end of this play session <br /><br /> <strong>Possible Values</strong>: <li><code>Null</code>: User did not play video, user abandoned during play of video, or no advancement at end of play</li> <li><code>Auto</code>: Auto play</li> <li><code>Click</code>: User clicked on a video</li> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Analytics ID</strong> </td> <td> <strong>analytics_id</strong> string </td> <td> 22-character alphanumeric ID representing a grouping of properties </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Feed ID</strong> </td> <td> <strong>feed_id</strong> string </td> <td> Unique ID for a playlist <br /><br /> <em><strong>NOTE</strong>: This dimension is the same as <code>playlist_id</code> in the Dashboard and API.</em> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Has Ad Block</strong></td> <td> <strong>has_ad_block</strong> integer </td> <td> Indicates if an ad block is detected for this session due to a browser blocking ads <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>-1</code>: unknown</li> <li><code>0</code>: No ad block</li> <li><code>1</code>: Ad block</li> </ul> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Is Autostart</strong></td> <td> <strong>is_autostart</strong> integer </td> <td> Player autostart setting for the first video upon embed of the player <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>0</code>: Not autostart</li> <li><code>1</code>: Autostart</li> <li><code>2</code>: Autostart on viewable</li> </ul> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Is Click to Play</strong></td> <td> <strong>is_click_to_play</strong> integer </td> <td> Denotes whether the reason for this play is a user click, auto or unknown <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>-1</code>: unknown</li> <li><code>0</code>: auto</li> <li><code>1</code>: user click</li> </ul> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Is First Play*</strong></td> <td> <strong>is_first_play</strong> boolean </td> <td> Indicator that the media was the first media item within a playlist or embed</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Media</strong> </td> <td> <strong>media_id</strong> string </td> <td> (Custom Reports) Name or ID of the media item <br /><br /> (API) ID of the media item </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Media Tag*</strong> </td> <td> <strong>tag</strong> string </td> <td> Metadata media tag associated with a media item</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Media Title</strong> </td> <td> <strong>media_title</strong> string </td> <td> Title of the media</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Media Type</strong> </td> <td> <strong>media_type</strong> string </td> <td> Media type player has played</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Media URL</strong> </td> <td> <strong>media_url</strong> string </td> <td> URL of the media item</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Number of Ad Breaks</strong></td> <td> <strong>num_ad_breaks</strong> integer </td> <td> Total number of ad break events that occurred during this session </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Play ID</strong> </td> <td> <strong>play_id</strong> string </td> <td> Unique ID generated for each play session</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Play Reason*</strong> </td> <td> <strong>play_reason</strong> string </td> <td> Indicator of how media playback was initiated <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>autoplay</code>: Autostarted playback, not dependent upon player viewability settings</li> <li><code>click</code>: A user clicked on the video</li> <li><code>external</code>: JavaScript call to the JW Player API</li> <li><code>progression</code>: Auto-advance on dynamic and manual playlists</li> <li><code>related</code>: Auto-advance on recommendation adn search playlists</li> <li><code>repeat</code>: Auto-repeat based on the configuration of the player</li> <li><code>unknown</code>: Unknown reason</li> <li><code>viewable</code>: Autostarted playback when the player was viewable, dependent upon player viewability settings</li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Play Sequence</strong> </td> <td> <strong>play_seq</strong> integer </td> <td> Item number within a playlist</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#_content" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Player</strong> </td> <td> <strong>player_id</strong> string </td> <td> (Custom Reports) Name or ID of the player <br /><br /> (API) ID of the player </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Player Playback Mode</strong> </td> <td> <strong>player_playback_mode</strong> string </td> <td> Player's playback mode when the first frame of content is rendered <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>DVR</code>: Livestreams that support seeking</li> <li><code>LIVE</code>: Livestreams that do not support seeking</li> <li><code>NULL</code>: Embed without plays</li> <li><code>VOD</code>: Video on Demand</li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Playlist</strong> </td> <td> <strong>playlist_id</strong> string </td> <td> (Custom Reports) Name or ID of the playlist <br /><br /> (API) ID of the playlist </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Playlist Type*</strong> </td> <td> <strong>playlist_type</strong> string </td> <td> Type of playlist <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>Article Matching</code></li> <li><code>Dynamic</code></li> <li><code>Feed</code><sup>1</sup></li> <li><code>Manual</code></li> <li><code>No Playlist (NULL)</code></li> <li><code>Search</code></li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Promotion*</strong> </td> <td> <strong>promotion</strong> string </td> <td> ID of the playlist pinned into a recommendations playlist that promoted the media item played in a player</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Video Duration*</strong> </td> <td> <strong>video_duration</strong> string </td> <td> Duration of the content <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>Short (under 4 mins)</code></li> <li><code>Medium (4-20 mins)</code></li> <li><code>Long (over 20 mins)</code></li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license. <sup>1</sup> This is the same as a recommendations playlist.</sup>

<br />

### Date/Time

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name </th> <th> Dimension ID </th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>Eastern Date</strong> </td> <td width="25%"> <strong>eastern_date</strong> string </td> <td width="30%"> Date when the media item started to play within a player, using <code>YYYY-MM-DD</code> (USA - Eastern Time) format</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>End Time</strong> </td> <td> <strong>end_time</strong> string </td> <td> End time of session in UTC as a datetime string</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Start Time</strong> </td> <td> <strong>start_time</strong> string </td> <td> Start time of session in UTC as a datetime string</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#datetime" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Upload Date*</strong> </td> <td> <strong>upload_date</strong> string </td> <td> Date when the media item was last uploaded to the platform, using <code>YYYY-MM-DD</code> (USA - Eastern Time) format</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Viewer Timezone Offset</strong> </td> <td> <strong>viewer_tz_offset</strong> integer </td> <td> UTC offset for the timezone of the user represented as an integer from -12 to 14 </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#datetime" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

### Device

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name </th> <th> Dimension ID </th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>App Bundle ID</strong> </td> <td width="25%"> <strong>app_bundle_id</strong> string </td> <td width="30%"> (Apps) Identifier unique to the app</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>App Install Instance ID</strong> </td> <td> <strong>ott_app_install_instance_id</strong> string </td> <td> (Apps) App install instance ID</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>App User ID</strong> </td> <td> <strong>ott_app_user_id</strong> string </td> <td> (Apps) App account ID or its hash</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#device" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>App Version</strong> </td> <td> <strong>app_version</strong> string </td> <td> (Apps) Version of the app</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Average Player Height</strong> </td> <td> <strong>avg_player_height</strong> number </td> <td> Average player height in pixels throughout session</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#device" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Average Player Size</strong> </td> <td> <strong>avg_player_pixel_size</strong> integer </td> <td> Average pixel widths of the player for the play session, grouped by player size buckets <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>0</code>: Unknown</li> <li><code>1</code>: Small (<=320px)</li> <li><code>2</code>: Medium (321-640px)</li> <li><code>3</code>: Large (>640px) </li> </ul> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Average Player Width</strong> </td> <td> <strong>avg_player_width</strong> number </td> <td> Average player width in pixels throughout session</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#device" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Browser*</strong> </td> <td> <strong>browser</strong> string </td> <td> Type of browser used to watch a media item</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Device</strong> </td> <td> <strong>device_id</strong> string </td> <td> Type of device used to watch a media item <br /><br /> <strong>Possible Values</strong>: <ul> <li>Connected Device</li> <li>Connected TV</li> <li>Desktop</li> <li>Other</li> <li>Phone</li> <li>Tablet</li> <li>Unknown</li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> <tr> <td> <strong>Device Firmware Version</strong> </td> <td> <strong>ott_device_firmware_version</strong> string </td> <td> (Apps) Firmware version of the OTT device</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Device Model</strong> </td> <td> <strong>ott_device_model</strong> string </td> <td> (Apps) OTT Device Model number</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#device" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Operating System</strong> </td> <td> <strong>ott_os</strong> string </td> <td> (Apps) Name of the OS on the OTT device</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#device" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Operating System Language</strong> </td> <td> <strong>ott_os_language</strong> string </td> <td> (Apps) Language of the OS on the OTT device</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#device" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Operating System Version</strong> </td> <td> <strong>ott_os_version</strong> string </td> <td> (Apps) Version of the OS on the OTT device</td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Platform*</strong> </td> <td> <strong>platform_id</strong> string </td> <td> SDK platform in which the player was embedded <br /><br /> <strong>Possible Values</strong>: <ul> <li><code>android</code></li> <li><code>chromecast</code><em>(Chromecast receiver)</em></li> <li><code>fireos</code></li> <li><code>ios</code></li> <li><code>roku</code></li> <li><code>tvos</code></li> <li><code>unknown</code></li> <li><code>web</code></li> </ul> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

### Geography

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name </th> <th> Dimension ID </th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>City*</strong> </td> <td width="25%"> <strong>city</strong> string </td> <td width="30%"> City from which a user accessed the media item <br /><br /> The value is based on the <a href="https://en.wikipedia.org/wiki/ISO_3166-2" target="_blank">ISO 3166-2</a> standard. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>Country</strong> </td> <td> <strong>country_code</strong> string </td> <td> Two-letter country code from which a user accessed a media item <br /><br /> The value is the <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2" target="_blank">ISO 3166-1 alpha-2</a> country code. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

### Placement

<span class="manual-tbl-font"> <table> <thead> <tr> <th> Name</th> <th> API ID</th> <th> Description </th> <th> API </th> <th> Custom Reports </th> <th> Data Sharing </th> </tr> </thead> <tbody> <tr> <td width="20%"> <strong>Domain</strong> </td> <td width="25%"> <strong>page_domain</strong> string </td> <td width="30%"> Domain within which a player was embedded <br /><br /> By excluding <em>www</em>, all subdomains are also included. </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><a href="/platform/docs/analytics-sql-calculations-for-metrics-and-dimensions#placement" title="View SQL Query or Calculation" target="_blank"><strong>ℹ️</strong></div> </td> </tr> <tr> <td> <strong>Plugin Document Referrer</strong> </td> <td> <strong>plugin_document_referrer</strong> string </td> <td> Referrer to the page where player is embedded <br /><br /> This information is gathered from the DOM. </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>❌</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> <tr> <td> <strong>URL</strong> </td> <td> <strong>page_url</strong> string </td> <td> URL of the page within which a player was embedded</td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> <td> <div style="text-align:center;"><strong>βœ…</strong></div> </td> </tr> </tbody> </table> </span>

\* This premium metric requires a JWP <a href="https://jwplayer.com/pricing/" target="_blank">Enterprise</a> license.

<br />

<!-- Removes the automatic page-to-page navigation at the bottom of the page -->

<style> .rm-Pagination { display: none; } </style>