POST

/profilingGroups/{profilingGroupName}/frames/-/metrics

http://codeguru-profiler.{region}.amazonaws.com/profilingGroups/{profilingGroupName}/frames/-/metrics

Returns the time series of values for a requested list of frame metrics from a time period.

Access Token Required: API Key

Path Parameters

profilingGroupNamestringrequired

The name of the profiling group associated with the the frame metrics used to return the time series values.

Query Params

endTimestring

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

periodstring

The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (<code>PT24H</code> or <code>P1D</code>).

startTimestring

The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

targetResolutionstring

The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values. <ul> <li> <code>P1D</code> — 1 day </li> <li> <code>PT1H</code> — 1 hour </li> <li> <code>PT5M</code> — 5 minutes </li> </ul>

Allowed:

Body Params

frameMetricsarray

The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://codeguru-profiler.{region}.amazonaws.com/profilingGroups/{profilingGroupName}/frames/-/metrics' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request POST \ 2 --url 'http://codeguru-profiler.{region}.amazonaws.com/profilingGroups/{profilingGroupName}/frames/-/metrics' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'