HOhologram
SIMs (Devices)

List monthly aggregated data usage

get/usage/data/monthly

Request

Query parameters

limitinteger

Maximum number of results to return (max 5000)

beforeinteger

Return records with ID less than this value (cursor-based pagination)

afterinteger

Return records with ID greater than this value (cursor-based pagination)

linkidinteger

Filter by a specific cellular link (SIM profile) ID

linkidsstring

Comma-separated list of link (SIM profile) IDs to filter by

tagidsstring

Comma-separated list of device tag IDs to filter by

timestartinteger

Unix timestamp; return records from this time onward

timeendinteger

Unix timestamp; return records up to this time

isliveboolean

When true, include only live (non-paused) devices

aggregateallboolean

When true, aggregate usage across all matching records into a single row

startatstring

Return results with record ID less than this value

tagidinteger

Filter by device tag ID

tagnamestring

Filter by device tag name

Response

OK

successboolean

Indicates whether the request was successful.

limitinteger

Maximum number of records returned per page

sizeinteger

Number of records in this response

continuesboolean

True if more records are available

lastidstring

record_id of the last record returned; pass as startat to fetch the next page

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.