OCT-103 Gumlet outreach
GET/video/streaming-duration

List top streamed video assets

Lists the video assets with the highest streaming usage over a specified date range. Use start_at and end_at to define the range, and provide a workspace identifier to scope the results. Use page and page_size to retrieve results in pages.

6 parameters
start_atstringrequired

Start date for the analytics range in yyyy-MM-dd format.

end_atstringrequired

End date for the analytics range in yyyy-MM-dd format.

workspace_idstringoptional

The video workspace identifier to filter results by; this is preferred over the deprecated collection_id.

collection_idstringoptional

The deprecated video collection identifier, still accepted for backwards compatibility; use workspace_id instead.

pagestringoptional

Page number for the results. Defaults to 1 when omitted.

Default:1
page_sizestringoptional

Number of assets to return per page. Defaults to 1000 when omitted.

Default:1000

4 status codes
200Returns an object containing a data array of asset identifiers and streaming usage values, plus a has_next_page flag.
dataarray<object>optional
has_next_pagebooleanoptional
Default:true
400Returned when the request is invalid.

One documented failure

  • invalid_parameter_value

    The parameter value is invalid.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 400 indicates an invalid request; a 401 indicates a missing or invalid API key or bearer token. A 403 indicates an unpaid account or insufficient role permissions. start_at and end_at must use yyyy-MM-dd format; prefer workspace_id over the deprecated collection_id.