# The API endpoint retrieves Water consumption data 

The API endpoint retrieves Water consumption data in (m³) from water meters.   The endpoint utilizes the underlying data from the meters to calculate and return the water consumed by a customer during a given time period. To use the API endpoint, the user will need to provide the necessary information, such as the date range for which they wish to retrieve data, the device id or space id to which a group of devices belong, and any other relevant parameters.  The endpoint will then gather underlying stores of meter readings and calculate the total water consumed by the customer during the specified time period such as  15 minutes, 2 hours, 1 day etc.   The water consumption data will be returned in m³, which is the standard unit of measurement for water consumption and the time units are in UTC.   This API endpoint can be useful for a variety of applications, such as tracking water usage for billing purposes, identifying consumption saving opportunities, and monitoring usage for sustainability initiatives. 

Endpoint: GET /energy/water
Version: v1
Security: ApplicationKey

## Query parameters:

  - `space.id` (string)
    Id of Space

  - `device.id` (string)
    Id of Device

  - `since` (any)
    Retrieve from this timestamp onwards

  - `until` (any)
    Retrieve until this timestamp

  - `continuationToken` (string)
    The continuation token to retrieve the next set of data.

  - `timezone` (string)
    The timezone to use for the data retrieval.
If not specified, the timezone will be set to Space timezone offset to UTC.
    Example: "Europe/London"

  - `interval` (string)
    Interval for the data aggregation in the format number unit,
where unit can be 'minute', 'hour', 'day', 'week', or 'month'.
    Example: "2 hours"

  - `breakdown` (string)
    The breakdown of the data to retrieve. If not specified,
the data will be retrieved for the entire organisation.
    Enum: "device", "country"

  - `current` (string)
    The current time period to retrieve data for.
When specified, the return timestamps
will be aligned to time period for each timezone in UTC.
    Enum: "hour", "day", "week", "month", "year"

  - `previous` (string)
    The previous time period to retrieve data for.
When specified, the return timestamps
will be aligned to time period for each timezone in UTC.
    Enum: "hour", "day", "week", "month", "year"

## Response 200 fields (application/json):

  - `id` (string)
    Example: "1234-abcd-5678-efgh"

  - `name` (string)
    Example: "Test Event"

  - `data` (object)
    Example: {"test":true}

  - `timestamp` (integer)
    Example: 1631707200000