Documentation menu
Analytics

List agent analytics

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

Parameters

path

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

query

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

Responses

StatusDescriptionBody
200Response for status 200application/json — object — agents: 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)