Documentation menu
Analytics

Read error analytics

GET /api/v1/projects/{projectId}/environments/{environmentId}/analytics/errors

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Read error analytics.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Read error analytics.

query

NameTypeRequiredDescription
fromstringrequiredSets the inclusive start of the Analytics time window. Applies to Read error analytics.
tostringrequiredSets the exclusive end of the Analytics time window. Applies to Read error analytics.
granularity"day" | "hour"optionalSelects the UTC day or hour bucket size for Analytics series. Applies to Read error analytics.
agentIdstringoptionalSelects the Project Agent by its stable identifier. Applies to Read error analytics.
releaseIdstringoptionalFilters results to the specified immutable Project Release. Applies to Read error analytics.
deploymentIdstringoptionalFilters results to the specified Project Deployment. Applies to Read error analytics.
activationIdstringoptionalFilters results to the specified Project Environment activation. Applies to Read error analytics.
limitintegeroptionalSets the maximum number of resources returned in this page. Applies to Read error analytics.
cursorstringoptionalOpaque cursor returned by the previous page; omit it to read the first page. Applies to Read error analytics.

Responses

StatusDescriptionBody
200Response for status 200application/json — object — summary: object (required); breakdown: array<object> (required); series: array<object> (required); retainedFrom: string (required); pagination: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)