Returns aggregated instance metrics across the filtered fleet.

get

https://api.cast.ai/reporting/v1beta/organizations/{organizationId}/instances-summary

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

organizationId

string

required

Organization ID.

Query Params

startTime

date-time

Start time of the reporting period (inclusive).

endTime

date-time

End time of the reporting period (exclusive).

timeZone

string

Optional time zone in IANA format, e.g., 'Europe/Madrid'.
Default is Etc/UTC.

regions

array of strings

Filter by regions (e.g., "us-east-1").

regions

availabilityZones

array of strings

Filter by availability zones (e.g., "us-east-1a").

availabilityZones

instanceTypes

array of strings

Filter by instance types (e.g., "m5.xlarge").

instanceTypes

instanceIds

array of strings

Filter by instance IDs.

instanceIds

spot

boolean

Filter by spot or on-demand lifecycle.

metrics

array of strings

Metrics to include in the response. If empty, all metrics are returned.

metrics

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response