Skip to content

Get the metrics for an environment

GET
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/metrics
curl --request GET \
--url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/metrics \
--header 'Authorization: Bearer <token>'

Retrieves CloudWatch metrics for the specified environment with optional filtering by time range, container, and metric configuration.

organisation
required
string

The organisation ID

Example
test-org
application
required
string

The application ID

Example
test-app
environment
required
string

The environment ID

Example
test-env
startTime
integer

Start time for metrics retrieval (Unix timestamp in milliseconds)

endTime
integer

End time for metrics retrieval (Unix timestamp in milliseconds)

period
integer

Period in seconds for metric aggregation (e.g., 60 for 1 minute, 300 for 5 minutes)

statistics
string

Comma-separated list of CloudWatch statistics (e.g., Average, Maximum, Minimum, Sum, SampleCount)

containerName
string

Filter metrics by specific container name

The metrics

Media typeapplication/json

CloudWatch metrics data

object
Examplegenerated
{}

The environment not found

Validation error