FLflexprice
Analytics

Run a financial report

Changed on

Runs the report identified by key. range is an absolute YYYY-MM-DD..YYYY-MM-DD (end exclusive) or last_N_days. compare is previous_period or previous_year.

post/analytics/reports/{key}/query

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/analytics/reports/{key}/query
  • Auth
    API key in header x-api-key

Path parameters

keystring required

Report key

Request body

compare'previous_period' | 'previous_year'
currencystring
dimensionsstring[]
grain'day' | 'week' | 'month'
limitinteger
offsetinteger
rangestring required
shape'timeseries' | 'breakdown' | 'scalar' required

Example request

{
  "range": "2026-09-01..2026-10-01"
}

Response

OK

Changes