HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.
Query Parameters
limit
integer
Maximum number of results to return
before
integer
Return records with ID less than this value (cursor-based pagination)
after
integer
Return records with ID greater than this value (cursor-based pagination)
simcardid
integer
Filter by SIM card ID
simcardids
string
Comma-separated list of SIM card IDs
timestart
integer
Unix timestamp; return records from this time onward
timeend
integer
Unix timestamp; return records up to this time
aggregate
enum<string>
Return counts per SIM/profile and aggregation period; omit for individual messages
Available options:
month,
day,
hour,
billing
startafter
integer
Return results with record ID less than this value (non-aggregate mode only)
maxperiodsback
integer
Maximum billing periods to look back (billing aggregate mode only)
tagid
integer
Filter by device tag ID
tagname
string
Filter by device tag name
usagetype
enum<string>
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.
Available options:
persim,
perprofile,
simtotal
Response
OK
success
boolean
Indicates whether the request was successful.
Example:
true
limit
integer
Maximum number of records returned per page
size
integer
Number of records in this response
continues
boolean
True if more records are available
lastid
integer
record_id of the last record returned; pass as startafter to fetch the next page