Skip to main content
GET
/
usage
/
sms
/
List SMS usage records
curl --request GET \
  --url https://dashboard.hologram.io/api/1/usage/sms/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "lastid": 123,
  "links": {
    "path": "<string>",
    "base": "<string>",
    "next": "<string>"
  },
  "data": [
    {
      "linkid": 123,
      "record_id": 123,
      "timestamp": "<string>",
      "direction": "<string>",
      "other_number": "<string>",
      "bootstrap_id": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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)

​
timestart
integer

Unix timestamp; return records from this time onward

​
timeend
integer

Unix timestamp; return records up to this time

​
aggregate
boolean

When true, returns aggregated counts rather than individual records

​
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
string

Result grouping: "persim" (default) or "perprofile"

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

​
links
object
​
data
object[]