Skip to main content
GET
Transaction Summary
Financial Overview: Get a concise summary of transaction totals across all your agents for any specified date range.

Request Headers

string
required
Your API key for authentication

Query Parameters

string
required
Start date for summary (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ)
string
required
End date for summary (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ)

Response

number
Total amount received by your agents during the period
number
Total amount spent by your agents during the period
number
Total number of transactions during the period

Status Codes

All Agents Included: The summary automatically combines transactions across all your agents, providing a consolidated financial overview.
Zero Results: If no agents are found or no transactions exist for the specified period, the endpoint will return zeros for all values with a 200 status code.