GET /v1/UsageRecords

twilio.com:twilio_supersim_v1

Summary:
Operation ID: ListUsageRecord
Auth: unknown
Description

List UsageRecords

Parameters (11)

EndTime (string, query, optional)

Only include usage that occurred before this time (exclusive), specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.

Fleet (string, query, optional)

SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred.

Granularity (string, query, optional)

Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.

Group (string, query, optional)

Dimension over which to aggregate usage records. Can be: `sim`, `fleet`, `network`, `isoCountry`. Default is to not aggregate across any of these dimensions, UsageRecords will be aggregated into the time buckets described by the `Granularity` parameter.

IsoCountry (string, query, optional)

Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country.

Network (string, query, optional)

SID of a Network resource. Only show UsageRecords representing usage on this network.

Constraints: {'minLength': 34, 'maxLength': 34, 'pattern': '^HW[0-9a-fA-F]{32}$'}

Page (integer, query, optional)

The page index. This value is simply for client state.

Constraints: {'minimum': 0}

PageSize (integer, query, optional)

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Constraints: {'minimum': 1, 'maximum': 1000}

PageToken (string, query, optional)

The page token. This is provided by the API.

Sim (string, query, optional)

SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.

StartTime (string, query, optional)

Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.

No probe data for this endpoint yet.