{
    "usage": [
        {
            "arrangement_id": "arr678",
            "basic_read": {
                "quality": "ACTUAL",
                "value": 550
            },
            "controlled_load": true,
            "fiskil_id": "energy_usage_abcder123",
            "institution_id": "154",
            "interval_read": {
                "aggregate_value": 549.84,
                "interval_reads": [],
                "readQualities": [
                    {
                        "end_interval": 5,
                        "quality": "SUBSTITUTE",
                        "start_interval": 1
                    }
                ],
                "read_interval_length": 5
            },
            "meter_id": "EFS12341",
            "read_end_date": "2024-09-17",
            "read_start_date": "2024-06-17",
            "read_u_type": "intervalRead",
            "register_id": "11",
            "register_suffix": "11",
            "service_point_id": "826e5be8-5790-49b1-9a8d-1080b2e7d4e7",
            "unit_of_measure": "KWH"
        }
    ],
    "links": {
        "next": "https://api.fiskil.com/v1/accounts?page[after]=x",
        "prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
    }
}

GET

/v1/energy/usage

Retrieve Usage

Returns usage data for all service points associated with the customer.

Parameters

end_user_idstringrequired

A unique identifier for the End User object.

service_point_idstring

A unique identifier for the Service Point object.

read_start_date.oldeststring

The start date, in yyyy-mm-dd format, from which the usage data is requested.

read_start_date.neweststring

The end date, in yyyy-mm-dd format, up to which the usage data is requested.

page[before]string

When the page[before] is specified, backwards pagination is achieved

page[after]string

When the page[after] is specified, forwards pagination is achieved

page[size]integer

When the page[size] is specified, no more than page[size] resources will be included in the response's data field. This parameter is set to a sensible default, which varies depending on the endpoint.

Request

GET/v1/energy/usage

curl --request GET \
     --url https://api.fiskil.com/v1/v1/energy/usage?end_user_id={end_user_id}&service_point_id={service_point_id}&read_start_date.oldest={read_start_date.oldest}&read_start_date.newest={read_start_date.newest}&page[before]={page[before]}&page[after]={page[after]}&page[size]={page[size]} \
     --header 'Authorization: Bearer {access_token}' \
     --header 'accept: application/json; charset=UTF-8' \
     --header 'content-type: application/json; charset=UTF-8'

Response

{
    "usage": [
        {
            "arrangement_id": "arr678",
            "basic_read": {
                "quality": "ACTUAL",
                "value": 550
            },
            "controlled_load": true,
            "fiskil_id": "energy_usage_abcder123",
            "institution_id": "154",
            "interval_read": {
                "aggregate_value": 549.84,
                "interval_reads": [],
                "readQualities": [
                    {
                        "end_interval": 5,
                        "quality": "SUBSTITUTE",
                        "start_interval": 1
                    }
                ],
                "read_interval_length": 5
            },
            "meter_id": "EFS12341",
            "read_end_date": "2024-09-17",
            "read_start_date": "2024-06-17",
            "read_u_type": "intervalRead",
            "register_id": "11",
            "register_suffix": "11",
            "service_point_id": "826e5be8-5790-49b1-9a8d-1080b2e7d4e7",
            "unit_of_measure": "KWH"
        }
    ],
    "links": {
        "next": "https://api.fiskil.com/v1/accounts?page[after]=x",
        "prev": "https://api.fiskil.com/v1/accounts?page[before]=x"
    }
}

Was this page helpful?