v8

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

Get Profitability

Calculate profitability for creators including revenue, costs, commissions, and margins for a specific month.

post/api/analytics/financial/profitability

Request body

account_idsstring[] required

Array of account prefixed IDs

yearinteger required

The year to calculate profitability for

monthinteger required

The month to calculate profitability for (1-12)

Example request

{
  "account_ids": [
    "acc_abc123",
    "acc_def456"
  ],
  "year": 2024,
  "month": 6
}

Response

creator_idinteger
namestring
gross_revenuenumber
net_revenuenumber
total_costsnumber
commissionnumber
profitnumber
marginnumber

Example response

[
  {
    "creator_id": 12345,
    "name": "Creator Name",
    "gross_revenue": 10000,
    "net_revenue": 8000,
    "total_costs": 500,
    "commission": 1500,
    "profit": 6000,
    "margin": 75
  }
]