Transactions summary
The /reports/transactions-summary endpoint returns transaction totals for month-to-date, quarter-to-date, and year-to-date periods with comparisons to the prior equivalent periods.
GET /reports/transactions-summary
Query parameters
| Parameter | Type | Description |
|---|
baseCurrency | string | Target currency for conversion. Defaults to account base currency. |
fix_fx | boolean | Use fixed exchange rates. |
region | string | Filter by region or country codes (space-separated). |
currency | string | Filter by currency codes (space-separated). |
plan | string | Filter by plan group IDs (space-separated). |
industry | string | Filter by industry (space-separated). |
data_source | string | Filter by data source ID (space-separated). |
Example response
200 OK
{
"currency": "usd",
"summary": {
"mtd": 95000,
"prev_mtd": 88000,
"qtd": 280000,
"prev_qtd": 260000,
"ytd": 520000,
"prev_ytd": 480000,
"mtd_change_pct": 7.95,
"qtd_change_pct": 7.69,
"ytd_change_pct": 8.33
}
}
Response fields
| Field | Type | Description |
|---|
currency | string | Reporting currency |
mtd | number | Month-to-date net transactions (cents) |
prev_mtd | number | Previous month's equivalent period (cents) |
qtd | number | Quarter-to-date net transactions (cents) |
prev_qtd | number | Previous quarter's equivalent period (cents) |
ytd | number | Year-to-date net transactions (cents) |
prev_ytd | number | Previous year's equivalent period (cents) |
mtd_change_pct | float | Month-to-date percentage change vs prior |
qtd_change_pct | float | Quarter-to-date percentage change vs prior |
ytd_change_pct | float | Year-to-date percentage change vs prior |
