---
title: "Video Analytics"
method: POST
path: "/video/analytics"
tags: ["API Endpoints"]
---

# Video Analytics

`POST /video/analytics`

This endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption

## Request body

- object
  - `metrics` string[], required — Define the metric you need the data for, currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data`
  - `date_range` object, required — The timeframe to get the data for. Currently we only support a maximum of 60 days between `start_at` and `end_at`.
    - `start_at` string, date — The starting date to consider
    - `end_at` string, date — The ending date to consider
  - `filters` object
    - `collection_id` string — The ID of the `collection` you want to filter the data for
  - `top_assets_count` string — Count of video assets that should be returned. Max assets count is 1000 per page.
  - `top_assets_page` string — top_assets metric may get paginated response. Iterate this parameter to get more data.

## Response `200`

200

- object
  - `top_assets` object[]
    - `collection_id` string
    - `asset_id` string
    - `units` integer
    - `collection_name` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/gumlet/apis/gumlet-rest-apis.md) · [All operations](https://skmtc.net/gumlet/apis/gumlet-rest-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gumlet/gumlet-rest-apis/versions/b1f7ac2aeeec/schema)