Retrieves SenML messages

GET 
https://apis.<domain>/iot/reader/channels/:chanId/messages

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Retrieves a list of messages sent to a specific channel.

Authorization Action:

core:channels:subscribe

Request

Path Parameters

chanId uuidrequired

Unique channel identifier.

Query Parameters

limit integer

Possible values: >= 1 and <= 1500

Default value: 10

Size of the subset to retrieve.

offset integer

Number of items to skip during retrieval.

publisher uuid

Unique thing identifier.

format string

Possible values: [messages, params, infos]

Default value: messages

Message type.

subtopic string

Message subtopic.

name string

SenML message name.

v string

SenML message value.

vb boolean

SenML message bool value.

vs string

SenML message string value.

vd string

SenML message data value.

from number

SenML message time in nanoseconds (integer part represents seconds).

to number

SenML message time in nanoseconds (integer part represents seconds).

ds string

Data decimation granularity. Format: {number}{s|m|h|d|w|M|y}

dsf string

Possible values: [max, min, avg, sum, stddev, variance]

Data decimation algorithm.

dsv string

Possible values: [v, vb]

Data decimation type. v: number, vb: boolean

Responses

200

Data retrieved.

application/json

Schema

Schema

total number

Total number of items that are present on the system.

offset number

Number of items that were skipped during retrieval.

limit number

Size of the subset that was retrieved.

messages object[]
Array [
channel integer
Unique channel id.
publisher integer
Unique publisher id.
protocol string
Protocol name.
name string
Measured parameter name.
unit string
Value unit.
value number
Measured value in number.
stringValue string
Measured value in string format.
boolValue boolean
Measured value in boolean format.
dataValue string
Measured value in binary format.
valueSum number
Sum value.
time number
Time of measurement.
updateTime number
Time of updating measurement.
]

Example (from schema)

{
  "total": 0,
  "offset": 0,
  "limit": 0,
  "messages": [
    {
      "channel": 0,
      "publisher": 0,
      "protocol": "string",
      "name": "string",
      "unit": "string",
      "value": 0,
      "stringValue": "string",
      "boolValue": true,
      "dataValue": "string",
      "valueSum": 0,
      "time": 0,
      "updateTime": 0
    }
  ]
}

400

Bad request.

401

Unauthorized.

500

Unexpected server error.

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://apis.<domain>/iot/reader/channels/:chanId/messages' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://apis.<domain>

Auth

Bearer Token

Parameters

chanId — pathrequired

limit — query

offset — query

publisher — query

format — query

---messagesparamsinfos

subtopic — query

name — query

v — query

vb — query

---truefalse

vs — query

vd — query

from — query

to — query

ds — query

dsf — query

---maxminavgsumstddevvariance

dsv — query

---vvb