Statistics API

Per Liveblog Statistics APIs

Overview

Request: GET /api/analytics/v7/liveblog/{id}/dashboard/{date}.json

Path Parameters:

  • {id}: The liveblog read ID
  • {date}: The timeframe to look at. Can be a year (2024), a month (2024-11), a day (2024-11-20) or all

Optional Query Parameters:

  • tz: The timezone to use. Can be any valid java timezone name (example tz=Europe/Berlin). Default: UTC
  • origin: Filters the data by origin (example origin=www.tickaroo.com)

Returns: ApiV7LiveblogDashboard

Typescript Definition:

export interface AggregatedStatsFacet {
  // ID of this facet (e.g. device type, date, country)
  id: string
  // Unique Users if available
  uniques: number;
  // Deprecated, do not use
  views: number;
  // Equivalent to "PageViews", Counts initial loads, clicks on load more
  tickerLoads: number;
  // Number of page views, that had unique user tracking enabled
  tickerLoadsWithUniques: number;
  // Number of page views, that had retention tracking enabled
  tickerLoadsWithRetention: number;
  // Total retention time in milliseconds
  retentionMs: number;
}

export interface AggregatedStatsData {
  // Unique Users if available
  uniques: number;
  // Deprecated, do not use
  views: number;
  // Equivalent to "PageViews", Counts initial loads, clicks on load more
  tickerLoads: number;
  // Number of page views, that had unique user tracking enabled
  tickerLoadsWithUniques: number;
  // Number of page views, that had retention tracking enabled
  tickerLoadsWithRetention: number;
  // Total retention time in milliseconds
  retentionMs: number;
  // Unique users that had retention tracking enabled
  retentionUniques: number;
  // Data broken down by countries if available
  country?: AggregatedStatsFacet[]
  // Data broken down by device type if available
  device?: AggregatedStatsFacet[]
  // Data broken down by weekdays and hours if available
  weeklyHours?: (AggregatedStatsFacet|null)[]
  // PageViews per widget type
  widgetType: Record<string, number|undefined>;
}

export interface ApiV7LiveblogDashboard {
  // The Timezone the response uses
  tz: string
  // Aggregated Data for the specified date
  aggregated: AggregatedStatsData
  // Data by origin or, if origin is given, data by url on origin
  aggregatedOrigins: AggregatedStatsFacet[]
  // Data broken down by the next lower time frame (example: date=2024, periodData contains data per month) 
  periodData: AggregatedStatsFacet[]
}