Skip to content

Get the metrics for an environment

GET
/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/metrics

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

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation ID

application
required
string

The application ID

environment
required
string

The environment ID

Query Parameters

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

Responses

200

The metrics

CloudWatch metrics data

object

404

The environment not found

422

Validation error