APapitraffic
Metrics

Returns the request throughput information for an account, can be further filtered.

get/v1/accounts/{accountSid}/metrics/throughput

Request

Path parameters

accountSidstring required

accountSid

Query parameters

startTimestring required

The start date/time for the data that should be returned.

Example:1970-01-01T00:00:00.000Z
endTimestring required

The end date/time for the data that should be returned.

Example:1970-01-01T00:00:00.000Z
environmentSidstring required

Sid of the environment

bucketSidstring

A BucketSid to filter the data by.

apiSidstring

An ApiSid to filter the data by.

pathSidstring

A PathSid to filter the data by.

resolution'1min' | '10min' | '1hr' | '2hr' | '1d' | '1mo'

The resolution that the data should be grouped and returned in.

units'rps' | 'rpm'

Return metric as requests per second (rps) or requests per minute (rpm).

Response

The data structure that throuput data be reported back with.

Example response

{
  "summary": {
    "startTime": "1970-01-01T00:00:00.000Z",
    "endTime": "1970-01-01T00:00:00.000Z"
  },
  "periods": [
    {
      "startTime": "1970-01-01T00:00:00.000Z",
      "endTime": "1970-01-01T00:00:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.