v8

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-2526602.8 MB

Analytics - Summary

Get Earnings Overview

Get earnings overview by category for selected accounts within a date range. Returns total earnings, subscriptions, posts, messages, tips, streams, and content stats.

post/api/analytics/summary/earnings

Request body

account_idsstring[] required

Array of account prefixed IDs to get earnings for

start_datestring required

The start date (ISO 8601 format)

end_datestring required

The end date (ISO 8601 format)

Example request

{
  "account_ids": [
    "acc_abc123",
    "acc_def456"
  ],
  "start_date": "2024-01-01",
  "end_date": "2024-12-31"
}

Response

total_earningsnumber

subscriptionsnumber

postsnumber

messagesnumber

tipsnumber

streamsnumber

total_accountsinteger

total_messagesinteger

total_imagesinteger

total_videosinteger

Example response

{
  "total_earnings": 15000.5,
  "subscriptions": 8000,
  "posts": 2500,
  "messages": 3000,
  "tips": 1300,
  "streams": 200.5,
  "total_accounts": 5,
  "total_messages": 1250,
  "total_images": 450,
  "total_videos": 120
}