List usage record

GET /v1/Sims/{SimSid}/UsageRecords

Usage information for SIMs

Path parameters

Query parameters

  • End string(date-time)

    Only include usage that occurred on or before this date, specified in ISO 8601. The default is the current time.

  • Start string(date-time)

    Only include usage that has occurred on or after this date, specified in ISO 8601. The default is one month before the end parameter value.

  • Granularity string

    How to summarize the usage by time. Can be: daily, hourly, or all. The default is all. A value of all returns one Usage Record that describes the usage for the entire period.

    Values are hourly, daily, or all.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • meta object
      Hide meta attributes Show meta attributes object
    • usage_records array[object]
      Hide usage_records attributes Show usage_records attributes array[object]
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • commands

        An object that describes the SIM's usage of Commands during the specified period

      • data

        An object that describes the SIM's data usage during the specified period

      • period

        The time period for which the usage is reported

      • sim_sid string | null

        The SID of the Sim resource that this Usage Record is for
GET /v1/Sims/{SimSid}/UsageRecords 
curl \
 -X GET https://wireless.twilio.com/v1/Sims/{SimSid}/UsageRecords \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "usage_records": [
    {
      "account_sid": "string",
      "sim_sid": "string"
    }
  ]
}
Response examples (200) 
{
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  },
  "usage_records": [
    {
      "account_sid": "string",
      "sim_sid": "string"
    }
  ]
}