/reports
200, not 201, and nothing is persisted. This generates a report; it does not create a resource. reportId is a correlation id for logs and for matching a response to the request that produced it — not a handle to fetch back later. Making reports durable would be a table and a repository, not a change to the response shape.
The generator loads the whole match rather than paging in SQL, precisely because the summary has to cover everything. That is affordable because of the month-to-date default; a caller wanting an entire history should page.
https://dashboard.a2bsample.com/api/developer/playground/client/reportsAuthorizationandX-Api-Tokenas headers./reportshttps://dashboard.a2bsample.com/api/developer/playground/client/reportsSend a request to see the response.
Example request
Request
Headers4
AuthorizationstringrequiredThe secret half. A client token starts clt_ — the four-character prefix says which table to resolve it in, so the row it matches is the caller. A vnd_… token on this prefix is a 403, not a 404.
X-Api-TokenstringrequiredThe identity half — this client's own 40-hex apiToken, issued alongside the bearer token and handed over with it. Compared in constant time against the bearer token's own row by DeveloperApiAuthFilter, before any handler runs, so a bearer token lifted on its own is not enough to call anything here. There is no endpoint that will tell you this value — an integrator who has lost it asks for the pair to be regenerated.
Content-TypestringrequiredRequest media type.
AcceptstringoptionalResponse media type.
Body8
namestringoptionalFree-text label, echoed back. Nothing keys off it.
projectIdstring<uuid>optionalMust be one of the caller's own.
statusintegeroptionalcountryIdstring<uuid>optionalfromDatestring<date>optionaltoDatestring<date>optionalisTestbooleanoptionalmaxRowsintegeroptional(max 5000)
Request body
Responses
The generated report. Nothing was stored.
successboolean- Whether the call succeeded.
reportobject