Retrieve daily usage statistics for an endpoint

GET

https://smartsim.telecom.li/api/v1/endpoint/:endpoint_id/stats/daily

GET

/api/v1/endpoint/:endpoint_id/stats/daily

curl https://smartsim.telecom.li/api/v1/endpoint/123/stats/daily \
     -H "Authorization: Bearer <token>"

[
  {
    "date": "2019-03-26",
    "data": {
      "volume": "0",
      "volume_tx": "0",
      "volume_rx": "0",
      "cost": "0"
    },
    "sms": {
      "volume": "0",
      "volume_tx": "0",
      "volume_rx": "0",
      "cost": "0"
    }
  },
  {
    "date": "2019-03-25",
    "data": {
      "volume": "0.632622",
      "volume_tx": "0.184861",
      "volume_rx": "0.447761",
      "traffic_type": {
        "id": 5,
        "description": "Data",
        "unit": "MB"
      },
      "cost": "0.1265244000"
    },
    "sms": {
      "volume": "0",
      "volume_tx": "0",
      "volume_rx": "0",
      "cost": "0"
    }
  }
]

Returns daily usage statistics for a specific endpoint, including cellular data and SMS volumes.

By default, returns statistics for the current month. Use start_date and end_date query parameters to specify a custom date range.

Historical data is available for up to 13 months.

Data traffic cost statistics (cost field in the data object) have been deprecated.

Returns daily usage statistics for a specific endpoint, including cellular data and SMS volumes. By default, returns statistics for the current month. Use `start_date` and `end_date` query parameters to specify a custom date range. <Note> Historical data is available for up to **13 months**. </Note> <Warning> Data traffic cost statistics (`cost` field in the `data` object) have been deprecated. </Warning>

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

endpoint_idintegerRequired

Numeric ID of an endpoint

Query parameters

start_datestringOptionalformat: "date"

Filters by start date, provided in a YYYY-MM-DD format.

If you don’t define an end date, the response will include 6 months of data, beginning on the current date.

Filters by start date, provided in a `YYYY-MM-DD` format. <Info> If you don't define an end date, the response will include 6 months of data, beginning on the current date. </Info>

end_datestringOptionalformat: "date"

Filters by end date, provided in an YYYY-MM-DD format.

If you don’t define a start date, the response will only return data from the month indicated in your end date.

Filters by end date, provided in an `YYYY-MM-DD` format. <Info> If you don't define a start date, the response will only return data from the month indicated in your end date. </Info>

Response

Successfully returned the daily endpoint statistics.

Each day’s entry contains:

date: The date in YYYY-MM-DD format
data: Cellular data usage (volume in MB)
sms: SMS usage (volume as message count)
sat_geo_data: Satellite data usage, if applicable
sat_geo_sms: Satellite SMS usage, if applicable

Volume fields include volume (total), volume_tx (transmitted), and volume_rx (received).

Successfully returned the daily endpoint statistics. Each day's entry contains: - `date`: The date in YYYY-MM-DD format - `data`: Cellular data usage (volume in MB) - `sms`: SMS usage (volume as message count) - `sat_geo_data`: Satellite data usage, if applicable - `sat_geo_sms`: Satellite SMS usage, if applicable Volume fields include `volume` (total), `volume_tx` (transmitted), and `volume_rx` (received).

datestringOptionalformat: "date"

The date for this statistics entry (YYYY-MM-DD format).

dataobjectOptional

Cellular data usage for this day.

smsobjectOptional

SMS usage for this day.

sat_geo_dataobjectOptional

Satellite data usage for this day (if applicable).

sat_geo_smsobjectOptional

Satellite SMS usage for this day (if applicable).

Errors

403

Forbidden Error