Aggregation endpoint

get

https://customer-api.prod.paren.app/metadata/v1/aggregations/{aggregationType}

Returns aggregate data. This data includes Paren specific features such as
station utilization, reliability score, success and failure counts, and other extra information.

Path Params

aggregationType

string

enum

required

Aggregation type

Allowed:

Query Params

year

number

Defaults to current year (weekly/monthly only)

week_nb

number

Required for weekly aggregations, and daily aggregations with time_range=week: Week number between 1 and 53

month_nb

number

Required for monthly aggregations, and daily aggregations with time_range=month: Month number between 1 and 12

time_range

string

enum

Required for daily aggregations: period of daily records to return

Allowed:

date

string

Required for daily aggregations with time_range=day: a date (YYYY-MM-DD) within the desired period

limit

integer

1 to 5000

Limits the number of items (locations, or chargers when paginate_by=charging_station) that are returned. Defaults to 5000.

offset

integer

≥ 0

Indicates the number of items (locations, or chargers when paginate_by=charging_station) to skip

paginate_by

string

enum

Defaults to location

Unit that limit/offset (and total_count) apply to. Defaults to location, which returns every charging station for each location in the page. charging_station paginates over individual charging stations instead, so a single location's charging pool may be split across multiple pages; pagination and total_count only consider charging_stations that have aggregation data for the period, so (except possibly the last page) a page always contains exactly the limit of charging_stations.

Allowed:

include

array of strings

Extra data that can be requested

include

Allowed:

countries

array of strings

Defaults to all

Filter on countries

countries

Allowed:

states

array of strings

Defaults to all

Filter on states or provinces of the location

states

location_ids

array of integers

Filter on IDs of the locations

location_ids

Responses

200OK

400Bad Request

500Internal Server Error