sales

get sales analytics

Revenue trend and period-over-period comparison, grouped: each group carries revenue_total and revenue_monthly keyed by month, with Overall beside the groups.

start_date and end_date are required unless in_fiscal_year is sent, which takes this or last as a shorthand for the organisation's own fiscal year. categories narrows the groups and fields narrows the measures returned.

A key issued to one account is refused with account_mismatch: this read covers every account on the book. That account's own sales are at GET /sales/table.

Scope: sales:read.

get/api/v1/sales/analytics

Request

  • Base URL: https://api.app.tightly.io
  • URL: https://api.app.tightly.io/api/v1/sales/analytics
  • Auth: HTTP bearer

Query parameters

in_fiscal_yearstring

this or last. Shortcut for getting this fiscal year's or last fiscal year's data. If not provided, start_date and end_date are expected.

start_datestring date required
Example:2024-01-01

Start date for analytics period (ISO date format)

end_datestring date required
Example:2024-12-31

End date for analytics period (ISO date format)

categoriesstring

Comma separated categories to filter the budget

fieldsstring

Comma separated fields to be fetched

is_sampleboolean

When true, returns sample/demo data instead of real analytics

Headers

Tightly-Versionstring
Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

The sales analytics metrics

dataobject
messageobject

severity, service and desc.

Changes

No recorded changes to this operation across all 1 revision of this API.