Sign in
Analytics - Financial

Get Profitability History

Get historical profitability data for a specific account over multiple months.

get/api/analytics/financial/profitability/{account}/history

Query parameters

account_prefixed_idstring required

The account prefixed ID.

Example:acct_abc123

The account prefixed ID.

monthsinteger

Number of months of history to retrieve (1-60, default 12). Must be at least 1. Must not be greater than 60.

Example:12

Number of months of history to retrieve (1-60, default 12). Must be at least 1. Must not be greater than 60.

Response

yearinteger
monthinteger
gross_revenuenumber
net_revenuenumber
profitnumber
marginnumber

Example response

[
  {
    "year": 2024,
    "month": 1,
    "gross_revenue": 10000,
    "net_revenue": 8000,
    "profit": 6000,
    "margin": 75
  }
]

Changes

Changed in 2 of the 8 revisions of this API.21