reports

Get ARR report

get/v3/reports/arr

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/reports/arr
  • Auth: API key in header Authorization

Query parameters

pagenumber double

Page Number

limitnumber double

Max items per page. Defaults to 50. Values above 500 will be rejected.

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: startMonth (string): eq, gte endMonth (string): eq, lte customerId (uuid): eq currency (string): eq

Example: filter=startMonth:eq:value

Format: startMonth/endMonth must be YYYY-MM (e.g. 2026-01); currency must be a valid ISO 4217 code (e.g. USD, EUR).

Response

Get ARR by filter

payloadV3ReportsArrGetResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

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