API Endpoints

Chart Data

This endpoint retrieves metrics data to plot the chart.

post/insights/chart-data

Request

Base URL
https://api.gumlet.com/v1
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/gumlet/apis/gumlet-rest-apis/docs/insights/chart-data/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

metricsstring[] required

Get data for one or more metrics in the same request. Please add any of these metrics. views, unique_views, downscale_percentage,upscale_percentage, rebuffer_percentage, startup_time, player_startup_time, seek_latency, exits_before_startup, playback_failure_percentage, completion_percent, completion_percent_by_views, rebuffer_duration, playing_time, rebuffer_count, rebuffer_frequency, average_bitrate, concurrent_users, playback_rate

property_idstring required

The five to ten character unique identifier of the Gumlet Insight Property available on the dashboard.

group_by'daily' | 'hourly'

Data can be grouped by daily or hourly. Metrics with histogram response (completion_percent, completion_percent_by_views) can not be grouped hourly

Response

200

Example response

{
  "views": [
    {
      "x": 1647475200000,
      "unit": "views"
    }
  ],
  "unique_views": [
    {
      "x": 1647475200000,
      "unit": "users"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.