v1

latestOpenAPI 3.0.02026-07-2661281.2 KB
Gateway Analytics

Top Gateway Analytics

org:analytics:read

get/analytics/gateways/top

Query parameters

gateway_domainstring required

Gateway domain to filter by

start_datestring required

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

end_datestring required

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

by'cid' | 'country' | 'region' | 'user_agent' | 'referrer' | 'file_name' required

Attribute to aggregaate results by, must be cid, country, region, user_agent, referer, or file_name.

sort_by'requests' | 'bandwidth' required

Sort data by either requests or bandwidth

cidstring

Filter by CID

file_namestring

Filter by file name

user_agentstring

Filter by user agent

countrystring

Filter by country

regionstring

Filter by region

refererstring

Filter by referer

http_status_code'200' | '206' | '301' | '302' | '304' | '307' | '308' | '404' | '499'

Filter results by HTTP status code

limitinteger

Limit the number of results returned, default is 100

sort_order'asc' | 'desc'

Sort results by either asc or desc

Response

OK

object required