GET
/
v1
/
entities
/
{entityId}
/
aggregations
curl --request GET \
  --url https://platform.realto.io/api/v1/entities/{entityId}/aggregations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "data": {
        "negativeActiveEnergy": {
          "t1": 123,
          "t2": 123,
          "t3": 123,
          "t4": 123,
          "total": 123,
          "unit": "<string>"
        },
        "negativeGasVolume": {
          "unit": "<string>",
          "value": 123
        },
        "positiveActiveEnergy": {
          "t1": 123,
          "t2": 123,
          "t3": 123,
          "t4": 123,
          "total": 123,
          "unit": "<string>"
        },
        "positiveGasVolume": {
          "unit": "<string>",
          "value": 123
        }
      },
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timeframe": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "links": {
    "next": "<string>"
  },
  "meta": {
    "continuationToken": "<string>",
    "pageSize": 123
  }
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
entityId
string
required

The id of the Entity

Query Parameters

​
start
string
required

The start of the overall time frame

​
resolution
string
required

The granularity or level of detail at which data points are combined or summarized. It determines the size of the time intervals over which data is aggregated.

         Provided as a time interval.
         
         Valid examples: '15 minutes', '30 minutes', '1 hour(s)', '2 day(s)', '2 weeks', '5 years'
         Invalid examples: '1 month 3 days', '2 month 3 weeks'
        
         Intervals are aligned
         - to midnight on January 3, 2000, for intervals that don't include a month or year
         - to midnight on January 1, 2000, for month, year intervals
​
end
string

The end of the overall time frame

​
pageSize
integer
default:
25

The number of Aggregations per page

​
continuationToken
string

The token used to retrieve the next page

Response

200
application/json
OK

A page of aggregations.

​
data
object[] | null

The data for the paged response

​
links
object

The links for a paged response

​
meta
object

Represents meta data for a paged response

Was this page helpful?

Retrieve the last ReadingGenerate a total aggregation