Usage

Retrieve All Usage

get

Retrieves all usage associated to all SIMs which are connected to an account/organization.

Using parameters will focus the records returned in the response.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
next_pagestringOptional

Used for pagination of records.

Example: MDAyNDY0OTk5
limitstringOptional

The max number of records returned. Limit can be between 1 and 1000 records. Default is 1000 records.

Example: 10
offsetintegerOptional

Number of records to skip (for pagination)

Default: 0Example: 0
groupstringOptional

Used for grouping the records by hours or not

Example: hours
filterone ofOptional

Filter usage based on various criteria. Can be provided as a single filter or multiple filters.

Single filter format: filter=key:value

Multiple filters format: filter[]=key:value&filter[]=key2:value2

Supported filter types:

time - Filter usage by time

  • Format: time:2020-01-30 or time:2020-01 or time:2020

sim_id - Filter usage by SIM id

  • Format: sim_id:000000001

country_code - Filter usage by country code

  • Format: country_code:dk
Example: filter[]=time:2020-01-30&filter[]=sim_id:000000001&filter[]=country_code:dk
stringOptional
or
string[]Optional
Responses
200

OK

application/json
Responseobject
get
/usage
200

OK

Retrieve Usage of specific SIM

get

Retrieves usage associated to a specific SIM connected to an account/organization.

Using parameters will focus the records returned in the response.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
sim_idstringRequiredExample: 000000001
Query parameters
next_pagestringOptional

Used for pagination of records.

Example: MDAyNDY0OTk5
limitstringOptional

The max number of records returned. Limit can be between 1 and 1000 records. Default is 1000 records.

Example: 10
offsetintegerOptional

Number of records to skip (for pagination)

Default: 0Example: 0
groupstringOptional

Used for grouping the records by hours or not

Example: hours
filterone ofOptional

Filter usage based on various criteria. Can be provided as a single filter or multiple filters.

Single filter format: filter=key:value

Multiple filters format: filter[]=key:value&filter[]=key2:value2

Supported filter types:

time - Filter usage by time

  • Format: time:2020-01-30 or time:2020-01 or time:2020

country_code - Filter usage by country code

  • Format: country_code:dk
Example: filter[]=time:2020-01-30&filter[]=country_code:dk
stringOptional
or
string[]Optional
Responses
200

OK

application/json
Responseobject
get
/usage/{sim_id}
200

OK

Retrieve total usage by Tag

get

Retrieves all usage associated to all SIMs connected to an account/organization.

Using parameters will focus the records returned in the response.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tag_idstringRequiredExample: 036eb4b3-4f6a-4a9a-b10c-6306ac5088a3
Responses
200

OK

application/json
Responseobject
get
/usage/tag-total/{tag_id}
200

OK

PreviousConnectorsNextTags

Last updated