GET
/
transactions
/
summary
curl --request GET \
  --url https://api.magebank.ai/transactions/summary \
  --header 'x-api-key: <x-api-key>'
{
  "totalEarned": 1250.50,
  "totalSpent": 750.25,
  "transactionCount": 15
}

Financial Overview: Get a concise summary of transaction totals across all your agents for any specified date range.

​
Request Headers

​
x-api-key
string
required

Your API key for authentication

​
Query Parameters

​
start_date
string
required

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

​
end_date
string
required

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

​
Response

​
totalEarned
number

Total amount received by your agents during the period

​
totalSpent
number

Total amount spent by your agents during the period

​
transactionCount
number

Total number of transactions during the period

{
  "totalEarned": 1250.50,
  "totalSpent": 750.25,
  "transactionCount": 15
}

​
Status Codes

Status CodeDescription
200Summary data retrieved successfully
400Bad Request - Invalid or missing parameters
401Unauthorized - User not authenticated
500Internal Server Error

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.