Get account analytics
Retrieve build and screenshot metrics for an account. The personal access token must be scoped to the account. Use it when asked how many builds or screenshots an account produced over a period, or how that usage is trending.
Retrieve build and screenshot metrics for an account. The personal access token must be scoped to the account. Use it when asked how many builds or screenshots an account produced over a period, or how that usage is trending.
Authenticate as a user with a personal access token.
Send it as a bearer token in the Authorization header:
Authorization: Bearer <personal-access-token>Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.
In: header
Path Parameters
Slug of the account to retrieve analytics for.
1 <= lengthQuery Parameters
Start of the analytics period. Accepts a full ISO 8601 datetime (2026-09-01T09:30:00Z) or a date on its own (2026-09-01). A date on its own starts at 00:00:00.000 UTC on that day.
End of the analytics period, inclusive. Accepts a full ISO 8601 datetime (2026-09-01T09:30:00Z) or a date on its own (2026-09-01). A date on its own ends at 23:59:59.999 UTC on that day. Defaults to the current time.
Time period used to group each series data point.
Value in
- "day"
- "week"
- "month"
Optional project name filter. Pass one value or repeat the parameter for multiple projects.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/accounts/string/analytics?from=string&groupBy=day"{ "screenshots": { "series": [ { "total": -9007199254740991, "projects": { "property1": -9007199254740991, "property2": -9007199254740991 }, "ts": -9007199254740991 } ], "all": { "total": -9007199254740991, "projects": { "property1": -9007199254740991, "property2": -9007199254740991 } }, "projects": [ { "id": "string", "name": "string" } ] }, "builds": { "series": [ { "total": -9007199254740991, "projects": { "property1": -9007199254740991, "property2": -9007199254740991 }, "changesDetected": -9007199254740991, "noChanges": -9007199254740991, "accepted": -9007199254740991, "rejected": -9007199254740991, "ts": -9007199254740991 } ], "all": { "total": -9007199254740991, "projects": { "property1": -9007199254740991, "property2": -9007199254740991 }, "changesDetected": -9007199254740991, "noChanges": -9007199254740991, "accepted": -9007199254740991, "rejected": -9007199254740991 }, "projects": [ { "id": "string", "name": "string" } ] }}