Device Inspector

Get Historian Messages

Get a list of historic messages for devices based on the optional filter parameters.

get/v1/inspect/devices/history

Request

  • Base URL
    https://api.1nce.com/management-api
  • Auth
    HTTP bearer

Query parameters

deviceIdstring
Example:<device_id>

The unique device ID which identifies each 1NCE SIM. Can be obtained from the Get All Devices API query. For 1NCE SIMS the device ID is equal to its iccid.

iccidstring
Example:8988280666000000000

ICCID of a SIM device, used to identifiy each 1NCE SIM.

startDateTimestring
Example:2022-03-07T08:51:29.015Z

Timestamp from where onwards the historic data messages should be queried.

endDateTimestring
Example:2022-03-07T09:51:29.015Z

Timestamp until when the historic data messages should be queried.

pageSizeinteger
Example:10

Parameter for specifying the queried items per page.

protocolstring
Example:COAP

Filter out data for specific protocols: <ul><li>LWM2M</li><li>UDP</li><li>COAP</li></ul>

nextTokenstring
Example:<next_token>

This API query uses token-based pagination. Each queried page will include a nextToken for accessing the next page for pagination. Please use the returned token in the nextToken query parameters to obtain the next page.

Response

OK

nextTokenstring

This API query uses token-based pagination. A queried page will include a nextToken for accessing the next page for pagination if a further page is available. Please use the returned token in the nextToken query parameters to obtain the next page.

firstTokenstring

When no nextToken is passed as part of the query parameters, the firstToken is provided as reference to the first page of the queried pages.

Example response

{
  "items": [
    {
      "iccid": "8988280666000000000",
      "time": "2022-03-07T08:51:29.015Z",
      "payload": "<custom_payload>",
      "protocol": "COAP",
      "deviceId": "<device_id>"
    }
  ],
  "nextToken": "<next_token>",
  "firstToken": "<first_token>"
}

Changes

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