/reports
gid is locked to the caller's own vendor id regardless of what else is filtered on.
An absent date range means the current month to date, not everything ever — an unbounded report would mean loading every hit the caller has ever driven just to total it. The resolved window travels back on filter.
A blank clientStartTime on a row means the respondent never reached the client at all: our own device, duplicate or security gate stopped them. That is the one thing status alone can never tell you.
https://dashboard.a2bsample.com/api/developer/playground/vendor/reportsAuthorizationandX-Api-Tokenas headers./reportshttps://dashboard.a2bsample.com/api/developer/playground/vendor/reportsSend a request to see the response.
Example request
Request
Headers3
AuthorizationstringrequiredThe secret half. A vendor token starts vnd_ — the four-character prefix says which table to resolve it in, so the row it matches is the caller. A clt_… token on this prefix is a 403, not a 404.
X-Api-TokenstringrequiredThe identity half — this vendor's own 40-hex apiToken, the value GET /api/developer/me echoes back. Compared in constant time against the bearer token's own row, so a bearer token lifted on its own is not enough to call the playground.
AcceptstringoptionalResponse media type.
Query parameters8
projectIdstring<uuid>optionalNarrow to one project. gid is locked to the caller's own vendor id regardless, so an unrelated project simply matches nothing rather than needing its own ownership check.
statusintegeroptionalProjectSurveyStatus code — one respondent's outcome.
countryIdstring<uuid>optionalTarget country.
fromDatestring<date>optionalStart of the window, inclusive. Absent means the first of the current month.
toDatestring<date>optionalEnd of the window, inclusive. Absent means today.
isTestbooleanoptionalRestrict to test or to live traffic. Absent means both.
pageNointegeroptionalPage number, 1-based. A null or non-positive value means the first page.
maxRowsintegeroptionalRows to return. The summary still covers the whole match, so a truncated report carries untruncated totals. (max 5000)
Responses
The report envelope. summary covers the whole match; rows is a page of it.
successboolean- Whether the call succeeded.
reportobject