Breakdown Data

​

This endpoint retrieves breakdown data of the given metrics by given breakdown field

Body
application/json
  • breakdowns
    Type: array object[] 1…3
    required

    Breakdown fields and metrics to retrieve data for. Supports 1 to 3 breakdowns per request.

  • 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.

  • workspace_id
    Type: string
    required

    The five to ten character unique identifier of the Gumlet workspace ID available on the Video Workspaces.

  • filters
    Type: array object[]

    Build segments of users using multiple filters on the data, value should be an exact match

Responses
  • application/json
  • application/json
  • application/json
Request Example for post/insights/breakdown-data
import Gumlet from '@gumlet/nodejs-sdk';

const client = new Gumlet({
  apiKey: process.env['API_KEY'], // defaults to the API_KEY env var
});

const videoAnalytic = await client.videoAnalytics.breakdownData({
  date_range: { start_at: '2026-07-20', end_at: '2026-08-20' },
  filters: [],
  breakdowns: [
    { name: 'custom_video_id', metric: 'views', page: 1, page_size: 10 },
    { name: 'custom_video_title', metric: 'completion_percent_by_views', page: 1, page_size: 10 },
  ],
  workspace_id: '6694c405e63913eecf3cf5fb',
});

console.log(videoAnalytic);

{
  "views": {
    "data": [
      {
        "key": "6710e83eb340677d98c71df7",
        "value": 253,
        "unit": "views"
      },
      {
        "key": "6710e83eb340677d98c71dd8",
        "value": 120,
        "unit": "views"
      }
    ],
    "has_next_page": true,
    "current_page": 1
  }
}

200