Get measurement data

GET

/edgeDevices/{edgeDeviceId}/measurementData

Allows to retrieve measurement data from a specific edge-device. Specify a specific time frame, granularity, and returned fields with the query parameters. If no 'from' and 'to' parameters are specified, only the most recent data point is returned.

Path Parameters

edgeDeviceIdstringrequired
Description
ID of the edge-device, e.g. a sensor_id

Query Parameters

granularitystringrequired
Example
t
Description
Specify the time granularity. Must be one of ["t", "m", "q", "h", "d"] for ten-second, minute, quarter-hour, hour or day values.
fromstring
Example
2023-01-01T00:00:00Z
Description
Specify a time frame starting point.
tostring
Example
2023-01-02T00:00:00Z
Description
Specify a time frame ending point.
fields[]string
Example
p
Description
Specify the returned fields. Must be in ["p", "e", "q", "s", "u", "i"]. Multiple fields can be specified by setting this parameter multiple times.
$skipnumber
Example
4320
Description
Used for pagination. Specify a number of returned elements to skip to the next page.

Header Parameters

Authorizationstringrequired
Example
```
{
  "Authorization": "Bearer {jwt token}"
}
```
Description
Auth header

Responses

200OK

object
- totalnumber
  Description
  total number of elements
- limitnumber
  Description
  limit of max returned elements
- skipnumber
  Description
  number of skipped elements
- dataobject[]
  - timestring
    Example
    2023-01-01T00:00:00.000Z
    Description
    timestamp
  - l1_pnumber
    Description
    real power phase 1
  - l2_pnumber
    Description
    real power phase 2
  - l3_pnumber
    Description
    real power phase 3
  - l1_qnumber
    Description
    reactive power phase 1
  - l2_qnumber
    Description
    reactive power phase 2
  - l3_qnumber
    Description
    reactive power phase 3
  - l1_snumber
    Description
    apparent power phase 1
  - l2_snumber
    Description
    apparent power phase 2
  - l3_snumber
    Description
    apparent power phase 3
  - l1_unumber
    Description
    voltage phase 1
  - l2_unumber
    Description
    voltage phase 2
  - l3_unumber
    Description
    voltage phase 3
  - l1_inumber
    Description
    current phase 1
  - l2_inumber
    Description
    current phase 2
  - l3_inumber
    Description
    current phase 3
  - l1_energynumber
    Description
    energy phase 1
  - l2_energynumber
    Description
    energy phase 2
  - l3_energynumber
    Description
    energy phase 3

400Bad Request

object
- namestring
  Example
  BadRequest
  Description
  Error name
- messagestring
  Example
  Data does not match schema
  Description
  Error message
- codenumber
  Example
  400
  Description
  HTTP status code
- classNamestring
  Example
  bad-request
  Description
  Error class name
- datastring
  Description
  Error data
- errorsobject[]
  Example
```
[
  "detailed description of error"
]
```
  Description
  Description of errors

401Unauthorized

object
- namestring
  Example
  NotAuthenticated
  Description
  Error name
- messagestring
  Example
  Not authenticated
  Description
  Error message
- codenumber
  Example
  401
  Description
  HTTP status code
- classNamestring
  Example
  not-authenticated
  Description
  Error class name
- errorsobject
  Description
  Description of errors

403Forbidden

object
- namestring
  Example
  Forbidden
  Description
  Error name
- messagestring
  Example
  Access Forbidden
  Description
  Error message
- codenumber
  Example
  403
  Description
  HTTP status code
- classNamestring
  Example
  forbidden
  Description
  Error class name
- errorsobject
  Description
  Description of errors

curl

curl --request GET \
     --url '/edgeDevices/{edgeDeviceId}/measurementData?granularity=t' \
     --header 'accept: application/json' \
     --header 'authorization: {"Authorization":"Bearer {jwt token}"}'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("authorization", "{\"Authorization\":\"Bearer {jwt token}\"}");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/edgeDevices/{edgeDeviceId}/measurementData?granularity=t", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/edgeDevices/{edgeDeviceId}/measurementData?granularity=t")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["authorization"] = "{\"Authorization\":\"Bearer {jwt token}\"}"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/edgeDevices/{edgeDeviceId}/measurementData?granularity=t"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'authorization': '{"Authorization":"Bearer {jwt token}"}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "total": 0,
  "limit": 0,
  "skip": 0,
  "data": [
    {
      "time": "2023-01-01T00:00:00.000Z",
      "l1_p": 0,
      "l2_p": 0,
      "l3_p": 0,
      "l1_q": 0,
      "l2_q": 0,
      "l3_q": 0,
      "l1_s": 0,
      "l2_s": 0,
      "l3_s": 0,
      "l1_u": 0,
      "l2_u": 0,
      "l3_u": 0,
      "l1_i": 0,
      "l2_i": 0,
      "l3_i": 0,
      "l1_energy": 0,
      "l2_energy": 0,
      "l3_energy": 0
    }
  ]
}

400

// Bad Request
{
  "name": "BadRequest",
  "message": "Data does not match schema",
  "code": 400,
  "className": "bad-request",
  "data": "",
  "errors": [
    {}
  ]
}

401

// Unauthorized
{
  "name": "NotAuthenticated",
  "message": "Not authenticated",
  "code": 401,
  "className": "not-authenticated",
  "errors": {}
}

403

// Forbidden
{
  "name": "Forbidden",
  "message": "Access Forbidden",
  "code": 403,
  "className": "forbidden",
  "errors": {}
}