List agent analytics
GET /api/v1/projects/{projectId}/environments/{environmentId}/analytics/agents
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to List agent analytics. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to List agent analytics. |
query
| Name | Type | Required | Description |
|---|---|---|---|
from | string | required | Sets the inclusive start of the Analytics time window. Applies to List agent analytics. |
to | string | required | Sets the exclusive end of the Analytics time window. Applies to List agent analytics. |
granularity | "day" | "hour" | optional | Selects the UTC day or hour bucket size for Analytics series. Applies to List agent analytics. |
agentId | string | optional | Selects the Project Agent by its stable identifier. Applies to List agent analytics. |
releaseId | string | optional | Filters results to the specified immutable Project Release. Applies to List agent analytics. |
deploymentId | string | optional | Filters results to the specified Project Deployment. Applies to List agent analytics. |
activationId | string | optional | Filters results to the specified Project Environment activation. Applies to List agent analytics. |
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List agent analytics. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List agent analytics. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — agents: array<object> (required); retainedFrom: string (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |