1. Documentation
2. API
3. Intervals
4. List

Listing Intervals

Get a list of Intervals, ordered by latest_first. Use at least one Meter or Authorization filter parameter. Unfortunately, getting a list of all intervals for every Meter is usually too resource intensive, so we return an error if you try to request intervals without an authorizations or meters query parameter.

HTTP Request

GET https://utilityapi.com/api/v2/intervals

Examples

# Get a list of all a meter's intervals
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/intervals?meters=123'

# Get a year's worth of intervals for all meters under an authorization
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/intervals?authorizations=222&start=2015-01-01&end=2015-12-31'

# Get the latest intervals for a meter
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/intervals?meters=222&limit=1&order=latest_first'

Query Parameters

Use at least one Meter or Authorization filter parameter. Unfortunately, getting a list of all intervals for every Meter is usually too resource intensive, so we return an error if you try to request intervals without an authorizations or meters query parameter.

Response

Returns a IntervalListing object containing a list of Interval objects. If the number of results is over 1000, a next parameter will have the link to the next in the series of lists.

// Example result
{
    "intervals": [
        {"uid": "12837438", "created": ...},
        {"uid": "12837438", "created": ...},
        ...
    ],
    "next": null,
    "is_incomplete": false,
}

IntervalListing

This is the object that contains the Interval results for the request. We don't just return a straight list of results so that we can paginate results if needed. Currently, the maximum results per request is set at 1000.

// Example IntervalListing
{
    "intervals": [...],
    "next": null,
}

HTTP Response Codes