/api/admin/client-errors/statsAdminClient error statistics
Summary statistics of the client errors matching the filters (the same since, client_app_id, fingerprint and q as GET /api/admin/client-errors): totals (errors, distinct groups, apps and reported users, and the error count of the preceding window of the same length when since is given), a timeline of error counts from since (or the oldest match) to now in at most 90 buckets, the 20 busiest error groups, apps, SDK versions and operations, and (unfiltered) the intake's settings and storage use.
get_api_admin_client_errors_statsAdministrationAuthentication & permissionsAdmin
Platform administrators only
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Platform administrators only
Query parameters
| Name | Type | Description |
|---|---|---|
| since | string | Only errors received at or after this instant (a non-negative integer Unix epoch in milliseconds). |
| client_app_id | string | Only errors of this client app |
| fingerprint | string | Only errors of this group (32 lowercase hex characters) |
| q | string | Only errors whose name, message or operation contains this text (case-insensitive) |
Responses
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| data* | AdminClientErrorStats | |
| window* | object | |
| from* | integer | Start of the timeline minimum: 0 |
| to* | integer | End of the timeline (the time of the request) minimum: 0 |
| bucket_ms* | integer | Width of one timeline bucket exclusiveMinimum: 0 |
| totals* | object | |
| errors* | integer | minimum: 0 |
| groups* | integer | Distinct fingerprints minimum: 0 |
| apps* | integer | minimum: 0 |
| users* | integer | Distinct reported users minimum: 0 |
| first_seen* | integer | null | null | Oldest matching report minimum: 0 |
| last_seen* | integer | null | null | Newest matching report minimum: 0 |
| previous_period_errors* | integer | null | null | Matching errors in the window of the same length right before minimum: 0 |
| timeline* | object[] | |
| start* | integer | Bucket start minimum: 0 |
| count* | integer | minimum: 0 |
| top_groups* | object[] | |
| fingerprint* | string | |
| name* | string | |
| message* | string | Message of the group's most recent error |
| operation* | string | null | null | |
| latest_client_error_id* | string (uuid) | |
| count* | integer | minimum: 0 |
| apps* | integer | minimum: 0 |
| users* | integer | minimum: 0 |
| first_seen* | integer | Oldest report of the group minimum: 0 |
| last_seen* | integer | Newest report of the group minimum: 0 |
| by_app* | object[] | |
| client_app_id* | string | |
| count* | integer | minimum: 0 |
| groups* | integer | minimum: 0 |
| last_seen* | integer | Newest report of the app minimum: 0 |
| by_sdk_version* | object[] | |
| sdk_name* | string | null | null | |
| sdk_version* | string | null | null | |
| count* | integer | minimum: 0 |
| by_operation* | object[] | |
| operation* | string | null | null | |
| count* | integer | minimum: 0 |
| storage* | AdminClientErrorStorage | The intake's settings and storage use (not filtered) |
| accepting_reports* | boolean | The |
| used_bytes* | integer | Total size of the stored reports minimum: 0 |
| max_bytes* | integer | The exclusiveMinimum: 0 |
| retention_days* | integer | The minimum: 0 |
Example request
curl -X GET 'https://auth.schemavaults.com/api/admin/client-errors/stats' \
-b 'refresh_token_<auth_server_app_id>=<value>'