Video Usage Analytics

​

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

Body
application/json
  • date_range
    Type: object
    required

    The timeframe to get the data for. Currently we only support a maximum of 60 days between start_at and end_at.

  • metrics
    Type: array 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

  • filters
    Type: object
  • top_assets_count
    Type: string

    Count of video assets that should be returned. Max assets count is 1000 per page.

  • top_assets_page
    Type: string

    top_assets metric may get paginated response. Iterate this parameter to get more data.

Responses
  • application/json
  • application/json
Request Example for post/video/analytics
curl https://api.gumlet.com/v1/video/analytics \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "metrics": [
    "bandwidth_consumption",
    "asset_duration",
    "storage_unit",
    "top_assets",
    "drm_requests"
  ],
  "date_range": {
    "start_at": "2026-08-01",
    "end_at": "2026-08-20"
  },
  "group_by": "daily"
}'

{
  "drm_requests": [
    {
      "units": 1,
      "timestamp": 1
    }
  ],
  "bandwidth_saving_unit": "",
  "storage_data_unit": "gb",
  "bandwidth_consumption": [
    {
      "units": 1,
      "timestamp": 1
    }
  ],
  "storage_unit": [
    {
      "units": 1,
      "timestamp": 1
    }
  ],
  "asset_duration": [
    {
      "units": 1,
      "timestamp": 1
    }
  ],
  "top_assets": [
    {
      "asset_id": "string",
      "units": "string",
      "workspace_id": "string",
      "duration": "string",
      "title": "string",
      "collection_name": "string"
    }
  ]
}

200