Viewer Analytics

This endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.

Body

application/json

date_range
Type: object
required

The timeframe to get the data for. The maximum range between start_at and end_at is 60 days.

Properties: 2
metrics
Type: array of stringenum
required

Get data for one or more metrics in the same request. Supported values: views, unique_views, impressions, completion_percent_by_views, playing_time, concurrent_users, widget_form_submitted, and cta_clicks.
values
- views
- unique_views
- impressions
- completion_percent_by_views
- playing_time
- concurrent_users
- widget_form_submitted
- cta_clicks
chart_dimension
Type: object

Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order.

Properties: 1
download
Type: boolean

Whether the request is to download the chart data
filters
Type: array of object

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

Properties: 3
group_by
Type: "daily" or "weekly" or "monthly"enum

Data can be grouped by daily, weekly or monthly.
workspace_id
Type: string

Gumlet workspace ID

Responses

application/json
application/json
application/json
application/json
application/json
application/json

post/insights/viewer-analytics

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.viewerData({
  metrics: ['views'],
  date_range: {
    start_at: '2024-01-01',
    end_at: '2024-01-01',
  },
  group_by: 'daily',
});

console.log(videoAnalytic);

Show Schema

{
  "views": [
    {
      "x": 1647475200000,
      "y": null,
      "unit": "views"
    },
    {
      "x": 1647561600000,
      "y": null,
      "unit": "views"
    },
    {
      "x": 1647648000000,
      "y": 6,
      "unit": "views"
    },
    {
      "x": 1647734400000,
      "y": 24,
      "unit": "views"
    },
    {
      "x": 1647820800000,
      "y": 33,
      "unit": "views"
    },
    {
      "x": 1647907200000,
      "y": 16,
      "unit": "views"
    }
  ],
  "unique_views": [
    {
      "x": 1647475200000,
      "y": null,
      "unit": "users"
    },
    {
      "x": 1647561600000,
      "y": null,
      "unit": "users"
    },
    {
      "x": 1647648000000,
      "y": 1,
      "unit": "users"
    },
    {
      "x": 1647734400000,
      "y": 1,
      "unit": "users"
    },
    {
      "x": 1647820800000,
      "y": 1,
      "unit": "users"
    },
    {
      "x": 1647907200000,
      "y": 1,
      "unit": "users"
    }
  ]
}

200

Video Analytics

Breakdown Data