Analytics

The Analytics API provides you with valuable information and insights to enhance your video creation experience.

summary

The summary api will help you analyze your video creation performance.

It offers insights such as the number of videos produced within your chosen timeframe, as well as the total duration of all videos created.

Query Paramaters:

• breakdown: (optional)

  • Specification of how you'd like to group your videos: by months, weeks, or days.

  • Type = Enum[ 'monthly' | 'weekly' | 'daily' ]

  • defaults to 'monthly'

• from_date: (optional)

  • The beginning of the selected timeframe

  • Type - Date ["yyyy-mm-dd"] (example: "2023-03-07")

  • defaults to one year ago

• to_date: (optional)

  • The end of the selected timeframe

  • Type - Date ["yyyy-mm-dd"] (example: "2023-03-07")

  • defaults to current date

The time frame for the "monthly" and "weekly" breakdowns must be less than a year, while for the "daily" breakdown, it must be less than a month.

• correlation_id: (optional)

  • match a unique identifier used to correlate between a users specific group

  • this field can be added on video creation

Get Summary

get

get analytics summary

Authorizations

APIKeyHeader

api-keystringRequired

Query parameters

breakdownall ofOptionalDefault: monthly

string · enumOptional

An enumeration.

Possible values:

from_datestring · dateOptional

to_datestring · dateOptional

correlation_idstringOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/analytics/summary

HTTPcURLJavaScriptPython

GET /api/v1/analytics/summary HTTP/1.1
api-key: YOUR_API_KEY
Accept: */*

[
  {
    "day": 1,
    "week": 1,
    "month": 1,
    "year": 1,
    "videos_created": 1,
    "total_duration": 1
  }
]