API Endpoint Fields Reference¶

Complete list of all fields returned by the analytics endpoints.

GET /analytics/¶

Query Parameters¶

Parameter	Type	Required	Description
`type`	string	Yes	`"daily"` for daily breakdown or `"agg"` for aggregated totals
`brand_id`	string	No*	Brand identifier(s). Single ID or comma-separated (e.g., '1' or '1,2,3'). *Required if `account_id` not provided
`account_id`	string	No*	Account identifier(s). Single ID or comma-separated (e.g., '4' or '4,2'). *Required if `brand_id` not provided
`platform`	string	No	Platform codes separated by comma (e.g., 'fb' or 'fb,ig,sc'). If not provided, all platforms are summed
`since`	date	No	Start date (YYYY-MM-DD, default: today - 7 days)
`until`	date	No	End date (YYYY-MM-DD, default: today)

Note: If neither brand_id nor account_id is provided, defaults to all accessible brands.

Response Structure (type=daily)¶

{
  "data": [
    {
      "date": string,
      "brand_id": integer,  // Present when multiple brands or account_id not used
      "account_id": integer,   // Present when account_id parameter is used
      "account_name": string,  // Present when account_id parameter is used
      "platform": string,  // Present when platform parameter is specified
      "revenue": number,  // Rounded to 2 decimals
      "views": integer,
      "followers": integer,
      "new_followers": integer,
      "posts_count": integer,
      "interactions": integer
    }
  ],
  "total": integer,
  "since": string,
  "until": string,
  "platforms": string | array,
  "brand_ids": array  // Present when multiple brands
}

Response Structure (type=agg)¶

{
  "data": [
    {
      "platform": string,  // Present when platform parameter is specified
      "account_id": integer,
      "name": string,
      "network_id": string,
      "storage_avatar": string,
      "permalink": string,
      "views": integer,
      "views_video": integer,
      "revenue": number | null,  // Rounded to 2 decimals
      "interactions": integer,
      "posts_per_day": number,
      "new_followers": integer,
      "followers": integer,
      "posts_count": integer
    }
  ],
  "total": integer,
  "aggregates": {
    "total": {...},
    "average": {...}
  },
  "since": string,
  "until": string,
  "platforms": string | array,
  "brand_ids": array  // Present when multiple brands
}

Field Descriptions¶

type=daily fields¶

Field	Type	Description
`date`	string	Date in YYYY-MM-DD format
`brand_id`	integer	Brand identifier (present when multiple brands or account_id not used)
`account_id`	integer	Account identifier (present when account_id parameter is used)
`account_name`	string	Account name (present when account_id parameter is used)
`platform`	string	Platform code (present when platform parameter is specified)
`revenue`	number	Total revenue for the day (rounded to 2 decimals)
`views`	integer	Total views
`followers`	integer	Total followers at end of day
`new_followers`	integer	New followers gained during the day
`posts_count`	integer	Number of posts published
`interactions`	integer	Total interactions (likes, comments, shares, etc.)

type=agg fields¶

Field	Type	Description
`platform`	string	Platform code (present when platform parameter is specified)
`account_id`	integer	Account/page identifier
`name`	string	Account name
`network_id`	string	External platform network ID
`storage_avatar`	string	Avatar image URL
`permalink`	string	Account profile URL
`views`	integer	Total views for the period
`views_video`	integer	Total video views
`revenue`	number \| null	Total revenue (rounded to 2 decimals)
`interactions`	integer	Total interactions
`posts_per_day`	number	Average posts per day
`new_followers`	integer	New followers gained
`followers`	integer	Total followers
`posts_count`	integer	Total posts count

Response Metadata¶

Field	Type	Description
`total`	integer	Number of entries in data array
`since`	string	Start date used for filtering
`until`	string	End date used for filtering
`platforms`	string \| array	"all" or list of platform codes
`brand_ids`	array	List of brand IDs (present when multiple brands)
`aggregates`	object	Aggregated totals and averages (type=agg only)

Platform Codes¶

All endpoints return platform codes in lowercase:

Code	Platform
`fb`	Facebook
`ig`	Instagram
`th`	Threads
`tk`	TikTok
`yt`	YouTube
`sc`	Snapchat
`li`	LinkedIn
`da`	Dailymotion
`pi`	Pinterest