v1

latestOpenAPI 3.0.12026-07-23122654.9 KB
SupersimV1UsageRecord

List UsageRecords

get/v1/UsageRecords

Query parameters

Simstring

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

Fleetstring

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.

Networkstring

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

IsoCountrystring iso-country-code

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

Group'sim' | 'fleet' | 'network' | 'isoCountry'

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.

Granularity'hour' | 'day' | 'all'

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.

StartTimestring date-time

Only include usage that occurred at or after this time, specified in ISO 8601 format. Default is one month before the end_time.

EndTimestring date-time

Only include usage that occurred before this time (exclusive), specified in ISO 8601 format. Default is the current time.

PageSizeinteger

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

Pageinteger

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

PageTokenstring

The page token. This is provided by the API.

Response

OK