List profiles of a meter - Enectiva REST API

This action allows to list profiles of a single meter. Values are in the default unit of corresponding energy. The values can be sorted, the default order is chronological.

The number of returned records is by default limited to 1000, see Limit & pagination for details. If more records satisfy your temporal filter, you can either keep the filter and paginate over the result set using the page parameter, or narrow down the filter with each request.

If you do not specify a unit, the values will be returned in the unit configured in Enectiva. You can request values in an alternative unit. The available units depend on the energy measured and match the units in the application. Supplying an invalid unit returns an error and lists the applicable units.

The required scope is profiles.

By default only active meters are accessible. To query only for profiles of a deactivated meter include param deactivated=true.

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Bodyapplication/json

Examples

With dataEmpty

{
    "data": [
        {
            "type": "profiles",
            "id": "123",
            "attributes": {
                "from": "2019-10-01T00:00:00Z",
                "to": "2019-10-02T00:00:00Z",
                "value": 15,
                "unit": "kWh"
            }
        },
        {
            "type": "profiles",
            "id": "124",
            "attributes": {
                "from": "2019-10-02T00:00:00Z",
                "to": "2019-10-03T00:00:00Z",
                "value": 18,
                "unit": "kWh"
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠406Not Acceptable

🟠429Too Many Requests

🔴500Server Error