API Reference

Aggregation endpoint

get
https://customer-api.prod.paren.app/metadata/v1/aggregations/

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
string
enum
required

Aggregation type

Allowed:
Query Params
number

Defaults to current year (weekly/monthly only)

number

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

number

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

string
enum

Required for daily aggregations: period of daily records to return

Allowed:
string

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

integer
1 to 5000

Limits the number of locations that are returned. For daily: defaults to 1000 for daily aggregations and 5000 otherwise.

integer
≥ 0

Indicates the number of items to skip

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

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?