FAST Metrics Retrieval APIs

This document outlines the procedure to retrieve metrics data for from Vimai using Metabase API.

1. Prerequisites and Secure Authentication

To access the Vimai Metabase API to retrieve the metrics:

• Metrics API Endpoint: https://metabase.vimai.io

• Authentication Method:

  • Please contact to get the API Key.

  • Include the header in every request: X-API-KEY: <API_KEY>

---

2. Metrics Export API Endpoint

Each metrics in Metabase is termed as Card.

There are 2 available APIs to get metrics in Metabase:

Metabase use POST instead of GET for these metrics API to be able to support complex filtering (that requires json filter definition)

API	Method	Endpoint
Get the metrics in json format	POST	https://metabase.vimai.io/api/card/{metrics_id}/query/json
Get the metrics in csv format	POST	https://metabase.vimai.io/api/card/{metrics_id}/query/csv

Filtering Params:

The 3 filters available are:

Param Slug	Param Name	Param Type	Description
from_date	From Date	date/single	Filtering to only get metrics on and after this from-date
to_date	To Date	date/single	Filtering to only get metrics on and before this to-date
channel_slug	Channel Slug	string	Filtering to only get metrics on specific channel

Those filtering params will be sent as items in parameters array fields in the request body, with the format:

{
  "parameters": [
    {
      "type": "{ParamType}",
      "value": "{Filtering Value}",
      "name": "{Param Name}",
      "slug": "{Param Slug}"
    },
    {
      "type": "{ParamType}",
      "value": "{Filtering Value}",
      "name": "{Param Name}",
      "slug": "{Param Slug}"
    }
  ]
}

Sample requests:

Sample metrics request with no param filtering:

curl -X POST \
  'https://metabase.vimai.io/api/card/[CARD-ID]/query/json' \
  -H 'X-API-KEY: <API_KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

Sample metrics request with param filtering:

curl -X POST \
  'https://metabase.vimai.io/api/card/[CARD-ID]/query/json' \
  -H 'X-API-KEY: <API_KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{
    "parameters": [
      {
        "type": "date/single",
        "value": "2025-11-01",
        "name": "From Date",
        "slug": "from_date"
      },
      {
        "type": "date/single",
        "value": "2025-11-30",
        "name": "To Date",
        "slug": "to_date"
      }
    ]
  }'

3. Metrics Available For Retrieval

The following metrics are available for retrieval:

Metrics Group	Metric Name	Description	Card ID
Summary Metrics	Total View Minutes In Period	Metrics Chart Type: Single Number Description: The total view minutes in filtering period	400
	Total Impressions In Period	Metrics Chart Type: Single Number Description: The total FAST ads impression in filtering period	399
	Total Ads Revenue In Period	Metrics Chart Type: Single Number Description: The total FAST ads revenue in filtering period	398
Overview Metrics	[FAST] Daily Total View Count	Metrics Chart Type: Daily Time Series Description: The total view count by date time series	392
	[FAST] Daily Total View Minutes	Metrics Chart Type: Daily Time Series Description: The total view minute by date time series	394
	FAST Ads - Daily Revenue Metrics	Metrics Chart Type: Daily Time Series Description: The FAST ads revenue by date time series	385
	FAST Ads - Daily Impression Metrics	Metrics Chart Type: Daily Time Series Description: The FAST ads impression count by date time series	386
	FAST Ads - Daily CPM Metrics	Metrics Chart Type: Daily Time Series Description: The FAST ads CPM by date time series	389
Detail Channel Metrics	[FAST] Daily View Count By Channel	Metrics Chart Type: Daily Time Series Description: The total view count by channel & date time series	373
	[FAST] Total View Count By Channel	Metrics Chart Type: Single Value Description: The total view count by channel, used to construct [FAST] Channel View Percentage Pie Chart Metrics	377
	[FAST] Daily View Minutes By Channel	Metrics Chart Type: Daily Time Series Description: The total view minute by channel & date time series	376
	[FAST] Daily Unique Viewer Count	Metrics Chart Type: Daily Time Series Description: The total unique view count by channel & date time series	372
Detail Content Metrics	[FAST] Program View Count And Total Duration	Metrics Chart Type: Table Descriptions: The FAST program's view count and view duration table.	379
	[FAST] Channel Program Total View Minutes	Metrics Chart Type: Table Description: The FAST program total view minute, used to construct Channel Program View Duration Percentage Pie Chart Metrics	382