Generate a total aggregation for an Entity

Returns a single total Aggregation for an Entity between specific dates

GET /v1/entities/{entityId}/aggregations/total

Retrieve the total Aggregation

cURL

curl --request GET \
  --url https://api.traxes.io/connect/v1/entities/{entityId}/aggregations/total \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {},
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization · string · header · required

Access Token Authentication

Path Parameters

entityId · string<uuid> · required

The id of the Entity

Query Parameters

start · string<date-time> · required

The start of the time frame

end · string<date-time> · required

The end of the time frame

Response

200

application/json

OK

An aggregation.

data · object

The data of an aggregation.

Show child attributes

entityId · string<uuid>

The id of the Entity

id · string<uuid>

The id of the aggregation.

timeframe · object

Show child attributes