Skip to main content
GET
/
analytics
/
gateways
/
time_series
Time Interval Gateway Analytics
curl --request GET \
  --url https://api.pinata.cloud/v3/analytics/gateways/time_series \
  --header 'Authorization: Bearer <token>'
{}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

gateway_domain
string
required

Gateway domain to filter by

start_date
string
required

Start date of aggregation in the format YYYY-MM-DD

end_date
string
required

End date of aggregation in the format YYYY-MM-DD

date_interval
enum<string>
required

Date interval to view gateway usage by. Must be either day or week.

Available options:
day,
week
sort_by
enum<string>

Sort data by either requests or bandwidth

Available options:
requests,
bandwidth
cid
string

Filter by CID

file_name
string

Filter by file name

user_agent
string

Filter by user agent

country
string

Filter by country

region
string

Filter by region

referer
string

Filter by referer

http_status_code
enum<string>

Filter results by HTTP status code

Available options:
200,
206,
301,
302,
304,
307,
308,
404,
499
limit
integer

Limit the number of results returned, default is 100

sort_order
string

Sort results by either asc or desc

Response

200 - application/json

OK

The response is of type object.