---
title: "Fetch engagement analytics data for a VOD stream"
method: GET
path: "/analytics/engagement/vod_streams/{id}"
tags: ["analytics_engagement"]
---

# Fetch engagement analytics data for a VOD stream

`GET /analytics/engagement/vod_streams/{id}`

(Available from version 1.11) This operation returns the engagement data for a specific VOD stream. Engagement data provides insight into how many plays your stream received and for how long. 

If you don't send from and to query parameters, the last hour's worth of data is returned. See the **trend** field in the response for information about sample intervals.

If the time range between **from** and **to** query parameters is:
    
<ul><li>Less than 60 minutes, the cache time between responses is 10 seconds.</li> <li>More than 60 minutes, the cache time between responses is 60 seconds.</li>

## Path parameters

- `id` string, required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `include` string

## Response `200`

Success

- AnalyticsEngagementVodStream
  - `vod_stream` object
    - `id` string, int32 — The unique alphanumeric string that identifies the VOD stream.
    - `play_rate` integer — The ratio between displays and plays. For example, 100 displays and 20 plays will result in 0.20 which means that 20% of the displays resulted in a play.
    - `completion_rate` integer — The ratio of viewers that watched the last segment of the asset. It is represented in a decimal value.
    - `duration_ms` integer — The length of the stream in milliseconds.
    - `avg_seconds_watched` integer — The average number of seconds the viewers viewed the stream.
    - `avg_percentage_watched` integer — The average time watched represented as a percentage.
    - `total_seconds_watched` integer — The total number of seconds the stream was viewed.
    - `trend` object — An array of viewer trend data for an asset in the given time period. <blockquote>Note: Data from the most recent hour data might not be included in the result of a time range that extends beyond the most recent 3 days. </blockquote> <strong>Default</strong>: Last hour
      - `percent` integer — A specific segment of the VOD asset. A VOD asset has 100 segments and each segment represents a completion percentage of the asset. For example, 1 is the data for 0 to 1% of the asset, 2 is the data for 1 to 2% and so on. Trend data is aggregated for each segment. Use _**duration_ms** / 1000 x **percent**_ to calculate a timestamp, in seconds, for the trend data.
      - `viewers` integer — The total number of unique viewers who watched this specific segment of the VOD asset. A unique viewer is a single IP address; multiple users that share the same IP address are counted once.
    - `limits` object — The time frame represented in the response.
      - `from` string, date-time — The start of the range of time represented in the response.
      - `to` string, date-time — The end of the range of time represented in the response.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `410` — Gone
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation.md) · [All operations](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wowza/wowza-video-rest-api-reference-documentation/revisions/157b6f741f2a/schema)