HomeAPI Reference
API Reference

List Metrics Data

get
https://analytics.zype.com/v3/platform_dynamics/metrics

This endpoint returns analytics data showing how your OTT business changes over time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required
Defaults to day

Group records by time intervals. Accepted values: day, week, month, year.

Allowed:
string

Filter records created after the specified start_date (filters[start_date_gte]=2018-11-01). If no start_date is specified, then data returned will date back two weeks ago.

string

Filter records created on or after the specified start_date.

string

Filter records created before the specified start_date.

string

Filter records created on or before the specified start_date.

string

Filter records created on the specified start_date. Comparison is date and time specific. If no time values are submitted, 00:00:00 UTC is assumed.

group_by
array of strings or null

Grouping by an array of Site Count properties will return the counts and deltas for each time interval. Accepted properties are: subscriptions, transactions, playlists, plans, consumers, apps, uploads, videos, video_imports, categories, mrr_sum

group_by
percentages
array of strings or null

To be used with group_by. Returns delta percentages per time interval for each property listed. Properties must be in 'group_by' array as well as 'percentages' array. Same list of properties is accepted

percentages
string

Sort results by value of a specific property + '_' + sort direction (Example - sort_by=start_date_asc, or sort_by=consumer_email_desc)

Responses

Updated 7 days ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 days ago