Get an entity's metrics

post

https://monitor-api.linode.com/{apiVersion}/monitor/services/{serviceType}/metrics

Limited availability Returns metrics information for the individual entities within a specific service type. This operation also requires an authorization: Bearer token you've created for this serviceType.

📘

This operation uses a different URL and version from standard Linode API operations. Verify you're using the URL with the monitor-api.linode.com hostname and include v2 (or v2beta) as the version in the URL.

For more details on the metrics available for each service, see the Metrics reference.

Path Params

serviceType

string

required

The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate service_type.

apiVersion

string

enum

required

Enum For this specific operation, you can call either the v2 URL, or v2beta.

Allowed:

Body Params

Settings used for data queries.

entity_region

string

required

The slug value for the Akamai Cloud Computing region, where the target Object Storage buckets live. You can run the List regions operation to view all slugs and their full region name.

📘
If the bearer token you created for this operation includes entity_ids for specific buckets, and any of those buckets exist outside of this entity_region, they're not included in the metrics.

filters

array of objects

Individual objects that define dimension filters for the query.

filters

group_by

array of strings

Categorizes response data based on the specified fields:

entity_id. Include this field by name to group the response data using the entity_id values included in the request.
dimension_label. This represents the desired dimension from a monitoring metric. To get a dimension_label, run the List metrics for a service type operation, review the available dimensions, and store the applicable dimension_label values.

You can group these fields using these combinations:

Group by entity_id values and one or more dimensions_label values. For example, [entity_id, node_type] groups response data based on values set for the entity_id parameter and the node_type dimension that's available for a service_type of dbaas.
Group by only the entity_id values. For example, ["entity_id"] exclusively groups response data based on values set for the entity_id parameter.
Group by one or more dimension_label values. For example, ["node_type"] groups response data based on the node_type dimension that's available for a service_type of dbaas.

If you leave this out of a request, data is aggregated across all series.

group_by

metrics

array of objects

required

length ≥ 1

A list of metric objects, each specifying a metric name and its corresponding aggregation function.

metrics*

aggregate_function

string

enum

The aggregation function applied to the metric. Available values are min, max, avg, and sum.

Allowed:

name

string

The metric to query. Run the List metrics for a service type to see the metrics available for a specific serviceType.

200Metrics returned.

defaultSee Errors for the range of possible error response codes.