{ "opencollection": "1.0.0", "info": { "name": "Wowza Streaming Engine REST advanced_token_authentication analytics_engagement API", "version": "2.0.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "analytics_engagement", "type": "folder" }, "items": [ { "info": { "name": "Fetch engagement analytics data for a VOD stream", "type": "http" }, "http": { "method": "GET", "url": "http://localhost:8087/analytics/engagement/vod_streams/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The unique alphanumeric string that identifies the VOD stream." }, { "name": "from", "value": "", "type": "query", "description": "Use this parameter, along with **to**, to return historic viewer data. \n\nThe start of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **from** query parameter without setting the **to** query parameter, the data returned will reflect 30 days starting at the **from** date, or data up to to the current day, whichever is shorter.\n\nExample:\n**2023-01-14T10:31:54.486Z**" }, { "name": "to", "value": "", "type": "query", "description": "Use this parameter, along with **from**, to return historic viewer data. \n\n\nThe end of the range of time you want to view. Specify **YYYY-DD-MMT HH:MM:SSZ** where **HH** is a 24-hour clock in UTC. The range queried is rounded to the nearest second. If you set the **to** query parameter without setting the **from** query parameter, the data returned will be from the past 30 days.\n\nExample:\n**2023-02-14T10:31:54.486Z**" }, { "name": "include", "value": "", "type": "query", "description": "Specify the data you want returned in the response. The only valid value for this endpoint is **trend**.\n\nValid values are: trend\n\nExample:\n**trend**" } ] }, "docs": "(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. \n\nIf 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.\n\nIf the time range between **from** and **to** query parameters is:\n\n