Conviva API Metrics

The Metrics V3 API identifies each metric by a kebab-case name in the URL path, and this reference lists every metric name, grouped by category, with a short definition and a link to its full catalog entry.

Updated 2026-08-06 metrics

Metrics

These are the metric names you pass in the Metrics V3 API URL path, in kebab-case format. Each metric below shows its API key, its Pulse display name (linked to the full definition, units, and thresholds in the Metrics catalog), and a short description.

Format

Copy 
GET /3.0/metrics/{metric_name}

where metric_name is one of the keys below. To request several metrics in one call, use the custom-selection endpoint (see the Metrics V3 API Guide).

Note: The -with-ads, -without-ads, -with-pre-roll, and -without-pre-roll variants report the same base metric computed over the subset of sessions with (or without) those ads, as shown in the Experience Overview dashboard.

Plays and Attempts

  • attempts: Attempts
    Total number of times viewers attempted to start video playback during the selected interval.
  • attempts-with-pre-roll: Attempts (with Pre-Roll)
    Attempts counted for viewing sessions that included a pre-roll ad.
  • attempts-without-pre-roll: Attempts (without Pre-Roll)
    Attempts counted for viewing sessions that did not include a pre-roll ad.
  • plays: Plays
    A play is counted when the viewer sees the first frame of video. Excludes unsuccessful play attempts.
  • concurrent-plays: Concurrent Plays
    The maximum number of simultaneously active playing sessions in any 60-second bucket during the interval.
  • ended-plays: Ended Plays
    A play that ended during the interval where the session had at least one video frame viewed.
  • ended-plays-with-ads: Ended Plays (with Ads)
    Ended Plays for viewing sessions that included mid-roll or post-roll ads.
  • ended-plays-without-ads: Ended Plays (without Ads)
    Ended Plays for viewing sessions that did not include ads.
  • abandonment: Abandonment
    The percentage of play attempts that did not play after the viewer waited a long time for the video to start.
  • abandonment-with-pre-roll: Abandonment (with Pre-Roll)
    Abandonment measured for sessions that included a pre-roll ad.
  • abandonment-without-pre-roll: Abandonment (without Pre-Roll)
    Abandonment measured for sessions that did not include a pre-roll ad.

Audience (Unique Devices and Viewers)

  • unique-devices: Unique Devices
    The deduplicated count of unique devices in the current data.
  • unique-devices-with-attempts: Unique Devices with Attempts
    The number of distinct devices that had one or more attempts to start video during the interval.
  • good-unique-devices: Good Unique Devices
    Unique devices with no impacted (SPI) sessions during the interval.
  • good-unique-viewers: Good Unique Viewers
    Unique viewers with no impacted (SPI) sessions during the interval.
  • bad-unique-devices: Bad Unique Devices
    Unique devices with at least one impacted (SPI) session during the interval.
  • bad-unique-viewers: Bad Unique Viewers
    Unique viewers with at least one impacted (SPI) session during the interval.
  • spi-unique-devices: SPI Unique Devices
    The SPI breakout of unique devices, toggled alongside Streams and Viewers in the Experience Overview.
  • spi-unique-viewers: SPI Unique Viewers
    The SPI breakout of unique viewers, toggled alongside Streams and Devices in the Experience Overview.

Streaming Performance Index (SPI)

  • streaming-performance-index: Streaming Performance Index
    A KPI that highlights overall streaming performance, based on the percentage of sessions with a good or best viewing experience per your KPI settings.
  • spi-streams: SPI Streams
    The Conviva-monitored streaming sessions that contributed to the SPI calculation, per your SPI threshold settings.
  • good-session: Good Session
    A session that meets all SPI KPI threshold settings (a good, non-impacted experience).
  • bad-session: Bad Session
    An impacted session that fails one or more SPI KPI thresholds (a degraded experience).
  • good-session-average-life-playing-time-mins: Good Session Average Life Playing Time (Mins)
    The average lifetime playing time, in minutes, of good (non-impacted) sessions.
  • bad-session-average-life-playing-time-mins: Bad Session Average Life Playing Time (Mins)
    The average lifetime playing time, in minutes, of bad (impacted) sessions.
  • high-rebuffering: High Rebuffering
    The percent of Ended Plays with a high Connection Induced Rebuffering Ratio or Time, measured against the SPI threshold.
  • high-rebuffering-with-ads: High Rebuffering (with Ads)
    High Rebuffering computed over sessions that included ads.
  • high-rebuffering-without-ads: High Rebuffering (without Ads)
    High Rebuffering computed over sessions that did not include ads.
  • low-bitrate: Low Bitrate
    The percent of Ended Plays with a low bitrate, measured against per-screen-size bitrate thresholds.
  • low-bitrate-with-ads: Low Bitrate (with Ads)
    Low Bitrate computed over sessions that included ads.
  • low-bitrate-without-ads: Low Bitrate (without Ads)
    Low Bitrate computed over sessions that did not include ads.
  • high-startup-time: High Startup Time
    The percent of Plays that took too long for the video to start, measured against the SPI threshold.
  • high-startup-time-with-pre-roll: High Startup Time (with Pre-Roll)
    High Startup Time computed over sessions that had pre-roll ads.
  • high-startup-time-without-pre-roll: High Startup Time (without Pre-Roll)
    High Startup Time computed over sessions that had no pre-roll ads.

Quality (Bitrate, Frame Rate, Rebuffering)

  • bitrate: Avg. Peak Bitrate
    The time-weighted peak bitrate played, excluding buffering and paused time. Called Average Bitrate in SSD and the APIs.
  • framerate: Average Frame Rate
    The average number of decoded frames per second during playback, excluding buffering and paused video.
  • rebuffering-ratio: Rebuffering Ratio
    The percentage of total viewing time during which viewers experienced rebuffering, excluding initial startup buffering and paused time.
  • connection-induced-rebuffering-ratio: Connection Induced Rebuffering Ratio
    The percentage of total viewing time spent in non-seek, connection-induced rebuffering.
  • cir-related-exits: CIR Related Exits
    The number and percent of ended plays where connection-induced rebuffering occurred within 5 seconds of the session end.
  • non-zero-cirr-ended-plays: Connection Induced Interrupted Plays
    Ended plays that had one or more interruptions caused by connection-induced (non-seek) rebuffering.
  • zero-cirr-ended-plays: Zero CIRR Ended Plays
    The percentage of ended plays with no connection-induced rebuffering during the interval.
  • pause-ratio: Paused Ratio
    Session pause time divided by pause, playing, and rebuffering time, across sessions with an ended play.
  • paused-time: Paused Time
    The sum of session pause time, calculated only for sessions that have ended.
  • percentage-complete: Average % Complete
    Viewed play duration compared with total content length, for VOD sessions with successful playback.

Startup, Restart, and Exits

  • video-start-time: Video Startup Time
    The time from the play attempt to the first frame displayed. Excludes pre-roll ad startup and playback.
  • video-restart-time: Video Restart Time
    The average number of seconds after a user-initiated seek until the video resumes playing.
  • exits-before-video-start: Exits Before Video Start
    Attempts that ended before video start without a reported fatal error during the interval.

Playing Time

  • minutes-played: Playing Time (Ended)
    Total video playing time, in minutes, across sessions that ended during the interval. Includes playing time from SSAI-inserted ads.
  • interval-minutes-played: Playing Time (Interval)
    Combined viewing time across all devices for sessions that played in the interval.

Failures (Playback and Start)

Ads

  • ad-attempts: Ad Attempts
    The total number of attempts to fetch ad creatives in the period, regardless of outcome.
  • ad-impressions: Ad Impressions
    Ad creatives that successfully started in the interval, equivalent to an ad impression.
  • ad-completed-creative-plays: Completed Ad Creative Plays
    Ad creatives that successfully played at least 90% of their content (also shown as a percent of Ad Impressions).
  • ad-ended-plays: Ad Ended Plays
    The number of ad creatives that ended in the interval.
  • ad-concurrent-plays: Ad Concurrent Plays
    The number of concurrently playing ad creatives (max per 60-second bucket for historical intervals).
  • ad-unique-devices: Ad Unique Devices
    The number of devices that had any Ad Ended Plays during the interval.
  • ad-bitrate: Ad Average Bitrate
    The average bitrate across all ad creatives that played in the interval.
  • ad-framerate: Ad Frame Rate
    The Average Frame Rate metric measured for ad creatives.
  • ad-actual-duration: Ad Actual Duration
    Total ad creative playing time divided by the number of ad creatives that played in the interval.
  • ad-minutes-played: Ad Minutes
    Total ad viewing time across sessions that ended, excluding ad pause and ad rebuffering time.
  • ad-percentage-complete: Ads Completed (% of Ad Impressions)
    The average percentage of ad creatives viewed, ad playing time divided by total creative length.
  • ad-rebuffering-ratio: Ad Rebuffering Ratio
    The percentage of ad creative viewing time spent rebuffering, excluding startup buffering and paused time.
  • ad-connection-induced-rebuffering-ratio: Ad Connection Induced Rebuffering Ratio
    The Connection Induced Rebuffering Ratio metric measured for ad creatives.
  • ad-video-restart-time: Ad Video Restart Time
    The Video Restart Time metric measured for ad creatives.
  • ad-video-start-time: Ad Startup Time
    The number of seconds between an attempt to fetch an ad creative and its first frame playing.
  • ad-video-start-failures: Ad Start Failures
    The percentage of Ad Attempts that failed to fetch or play the ad creative in the period.
  • ad-video-playback-failures: Ad Playback Failures
    Ended ad creatives that terminated with a playback failure error.
  • ad-slate-duration: % Slate Duration
    The percentage of live server-side ad session time during which ad slates played instead of ads.
  • ad-slate-plays: % Slate Plays
    The percentage of live server-side Ad Attempts during which ad slates played.
  • ads-not-started: Ads Not Started
    The sum of Ad Start Failures, Exits Before Ad Start, and Ad Slate Plays in the period.
  • exits-before-ad-start: Exits Before Ad Start
    Ad creative attempts that were terminated, usually by the viewer, before the ad started playing.
  • exits-during-pre-roll: Exit During Pre-Roll
    Viewers who exit during the pre-roll ad, before the main video starts, for ads delivered with Client-Side Ad Insertion (CSAI).

Selecting Multiple Metrics in a Request

Use the custom-selection endpoint to select up to a maximum of 12 singular metrics in one request. Use the ?metric query parameter once per metric.

Copy 
GET https://api.conviva.com/insights/3.0/metrics/custom-selection?metric=attempts&metric=bitrate&metric=concurrent-plays