Sign in

v1

latestOpenAPI 3.1.02026-07-1371926.0 KB
Metrics

Get Traffic

Get API traffic data for an app. Grouped by hour or by day. With pagination. Traffic to endpoints that have been excluded in the dashboard is excluded here as well.

get/v1/apps/{app_id}/traffic

Path parameters

app_idinteger required

App ID

App ID

Query parameters

app_env_idinteger nullable

Filter to environment ID, if provided.

Filter to environment ID, if provided.

consumer_idinteger nullable

Filter to consumer ID, if provided.

Filter to consumer ID, if provided.

startstring date-time nullable

Start date and time in ISO 8601 format. Defaults to 24 hours ago if interval is "hour", or 30 days ago if interval is "day". Will be rounded down to the beginning of the interval (hour or day).

Example:2025-05-14T00:00:00Z

Start date and time in ISO 8601 format. Defaults to 24 hours ago if interval is "hour", or 30 days ago if interval is "day". Will be rounded down to the beginning of the interval (hour or day).

endstring date-time nullable

End date and time in ISO 8601 format. Defaults to now.

Example:2025-05-15T00:00:00Z

End date and time in ISO 8601 format. Defaults to now.

interval'hour' | 'day' nullable

Whether to group by day or by hour.

Whether to group by day or by hour.

timezonestring nullable

Timezone to use for intervals and to interpret start and end if given without offset. Defaults to UTC.

Example:America/New_York

Timezone to use for intervals and to interpret start and end if given without offset. Defaults to UTC.

limitinteger

Maximum number of records to return per page

Maximum number of records to return per page

next_tokenstring nullable

Token to fetch the next page of records, as returned by a previous request.

Token to fetch the next page of records, as returned by a previous request.

Response

Successful Response

has_moreboolean required

Whether there are more records to fetch.

next_tokenstring nullable required

Token to fetch the next page of records, if there are more.

Example response

{
  "data": [
    {
      "requests": 123
    }
  ]
}