Skip to main content
GET
/
v1
/
apps
/
{app_id}
/
traffic
Get Traffic
curl --request GET \
  --url https://api.apitally.io/v1/apps/{app_id}/traffic \
  --header 'Api-Key: <api-key>'
{
  "data": [
    {
      "period_start": "2023-11-07T05:31:56Z",
      "period_end": "2023-11-07T05:31:56Z",
      "requests": 123,
      "bytes_received": 123,
      "bytes_sent": 123
    }
  ],
  "has_more": true,
  "next_token": "<string>"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
app_id
integer
required

App ID

Required range: x >= 1

Query Parameters

​
app_env_id
integer | null

Filter to environment ID, if provided.

Required range: x >= 1
​
consumer_id
integer | null

Filter to consumer ID, if provided.

Required range: x >= 1
​
start
string<date-time> | null

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

Examples:

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

​
end
string<date-time> | null

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

Examples:

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

​
intervals
enum<string>
default:hours

Whether to group by day or by hour.

Available options:
hours,
days
​
timezone
string | null

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

Examples:

"America/New_York"

​
limit
integer
default:100

Maximum number of records to return per page

Required range: 1 <= x <= 1000
​
next_token
string | null

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

Maximum length: 1024

Response

Successful Response

​
data
TrafficItem · object[]
required

List of traffic data.

​
has_more
boolean
required

Whether there are more records to fetch.

​
next_token
string | null
required

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