SIMs (Devices)

List SMS usage records

get/usage/sms/

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/usage/sms/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Maximum number of results to return

beforeinteger

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

afterinteger

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

simcardidinteger

Filter by SIM card ID

simcardidsstring

Comma-separated list of SIM card IDs

timestartinteger

Unix timestamp; return records from this time onward

timeendinteger

Unix timestamp; return records up to this time

aggregate'month' | 'day' | 'hour' | 'billing'

Return counts per SIM/profile and aggregation period; omit for individual messages

startafterinteger

Return results with record ID less than this value (non-aggregate mode only)

maxperiodsbackinteger

Maximum billing periods to look back (billing aggregate mode only)

tagidinteger

Filter by device tag ID

tagnamestring

Filter by device tag name

usagetype'persim' | 'perprofile' | 'simtotal'

Result grouping: "persim" (default), "perprofile", or "simtotal". With aggregation, simtotal returns one row per SIM per period; without aggregation, individual messages. Neither simtotal mode duplicates rows per profile.

Response

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

lastidinteger

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

Example response

{
  "success": true
}

Changes

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