endpoint

Endpoint usage and cost statistics

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Endpoint.Stats + Get <span className="permission-callout__also">+1 endpoint</span>

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info> <Warning> You can only retrieve data traffic costs for organizations without multi-inclusive volumes. </Warning>

Retrieves endpoint usage and cost statistics for a given ID. Usage statistics are sorted by data and sms.

Returns statistics from the following periods:

  • last_month: Previous billing month, from the first to last day (for example, April 1-30, 2023, when you send the request sometime in May 2023).
  • current_month: Current month, with statistics calculated up to and including the date requested (for example, May 1-8, 2023, when you sent the request on May 8, 2023).
  • last_hour: Previous 60 minutes, accumulated per minute and organized by data or SMS received by the device (rx) and transmitted by the device (tx).
<Info> `last_month` and `current_month` are only included in the responses if traffic exists. </Info>
get/api/v1/endpoint/{endpoint_id}/stats

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpoint_id}/stats
  • Auth: HTTP bearer

Path parameters

endpoint_idinteger required

Numeric ID of an endpoint

Response

Successfully returned the endpoint statistics associated with the provided id.

last_monthApiV1EndpointEndpointIdStatsGetResponsesContentApplicationJsonSchemaLastMonth
current_monthApiV1EndpointEndpointIdStatsGetResponsesContentApplicationJsonSchemaCurrentMonth
last_hourApiV1EndpointEndpointIdStatsGetResponsesContentApplicationJsonSchemaLastHour

Changes

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