Skip to navigation
EndpointList endpoint data usage per coverage area

List endpoint data usage per coverage area

Required permissions Beta Learn more

Endpoint.Stats + Get +3 endpoints

Roles: Administrator User Observer

Returns the data usage of each endpoint in your organization per coverage area, with endpoints ranked by total volume. Use it to find the endpoints that caused the data usage in a coverage area. In the API, coverage areas are rate zones, so the fields are named ratezone and ratezone_id.

Only endpoints with data usage in the requested period are returned. Volumes are in MB and include zero-rated traffic. The zero-rated portion is reported separately, so the billable volume is volume minus volume_zero_rated.

When q filters by ratezone_id, the totals and the ranking cover only those coverage areas.

Date range

start_date and end_date are inclusive UTC days:

  • Neither set: the current month up to today.
  • Only start_date: from start_date up to today. If that period is longer than 31 days, also set end_date.
  • Only end_date: from the first day of the month of end_date up to end_date.
  • Both set: the period as given. It can be at most 31 days long, and start_date can’t be after end_date.

start_date can’t be earlier than the first day of the month 6 months before the current month. For example, on October 26, 2026, the earliest start_date is 2026-04-01.

Usage data comes from daily usage records, which can lag behind live traffic by up to 3 days.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Query parameters

start_datestringOptionalformat: "date"

First day of the period, in YYYY-MM-DD format (UTC, inclusive). See the endpoint description for the date range rules.

end_datestringOptionalformat: "date"

Last day of the period, in YYYY-MM-DD format (UTC, inclusive). See the endpoint description for the date range rules.

qstringOptionalformat: "(endpoint_id|ratezone_id):.+"

Filters endpoints by field value. Use <field>:<criteria> format. Combine filters on different fields with commas, and separate multiple values for one field with || (for example, ratezone_id:3398||3515).

Fields:

  • endpoint_id - Endpoint ID
  • ratezone_id - Coverage area ID. Restricts the totals and the ranking to these coverage areas.
sortstringOptionalformat: "^[+-]?volume$"

Sorts endpoints by total volume. Use -volume for descending or volume for ascending order. Defaults to -volume. Endpoints with identical values are sorted by ascending endpoint_id.

pageintegerOptional>=1Defaults to 1
Page number to retrieve. Starts at 1.
per_pageintegerOptional1-100Defaults to 25
Number of endpoints to return per page. Values above 100 are treated as 100.

Response headers

X-Count-Per-PageintegerOptional
Number of endpoints per page.
X-Current-PageintegerOptional
Current page number.
X-Total-CountintegerOptional
Total number of endpoints matching the query.
X-Total-PagesintegerOptional
Total number of pages.
X-FilterstringOptional

Applied filter criteria from the q parameter. Only present when q is set.

X-SortstringOptional

Value of the sort parameter, or id when sort isn’t set. The applied default order is still -volume.

Response

Returns an array of endpoints ranked by total volume. Pagination metadata is included in the response headers.
endpoint_idinteger
Endpoint ID.
volumedouble

Total volume in MB in the requested period, summed across the coverage areas in ratezone. Includes zero-rated traffic.

volume_zero_rateddouble

Zero-rated (not billed) portion of volume, in MB.

ratezonelist of objects
Volume per coverage area, ordered by volume descending.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error