Analytics

Retrieve account-level build and screenshot metrics over time.

Get account analytics

get

Retrieve build and screenshot metrics for an account. The personal access token must be scoped to the account.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

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.

Path parameters

accountSlugstring · min: 1Required

Slug of the account to retrieve analytics for.

Query parameters

fromstring · date-timeRequired

Start of the analytics period, as an ISO 8601 datetime.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

tostring · date-timeOptional

End of the analytics period, as an ISO 8601 datetime. Defaults to the current time.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

groupBystring · enumRequired

Time period used to group each series data point.

Possible values:

projectNamesany ofOptional

Optional project name filter. Pass one value or repeat the parameter for multiple projects.

string · min: 1 · max: 100OptionalPattern: ^[a-zA-Z0-9_\-.]+$

or

string[]Optional

Responses

200

Account analytics

application/json

400

Invalid parameters

application/json

401

Unauthorized

application/json

500

Server error

application/json

get/accounts/{accountSlug}/analytics

HTTPcURLJavaScriptPython

GET /v2/accounts/{accountSlug}/analytics?from=2026-08-09T20%3A56%3A11.942Z&groupBy=day HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "screenshots": {
    "series": [
      {
        "total": 1,
        "projects": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "ts": 1
      }
    ],
    "all": {
      "total": 1,
      "projects": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    },
    "projects": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  },
  "builds": {
    "series": [
      {
        "total": 1,
        "projects": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "changesDetected": 1,
        "noChanges": 1,
        "accepted": 1,
        "rejected": 1,
        "ts": 1
      }
    ],
    "all": {
      "total": 1,
      "projects": {
        "ANY_ADDITIONAL_PROPERTY": 1
      },
      "changesDetected": 1,
      "noChanges": 1,
      "accepted": 1,
      "rejected": 1
    },
    "projects": [
      {
        "id": "text",
        "name": "text"
      }
    ]
  }
}