GET
/
v4
/
data
/
network
/
{network_code}
{
  "version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "success": true,
  "error": "<string>",
  "data": [],
  "total_records": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
network_code
string
required

Query Parameters

​
metrics
enum<string>[]
required

The metrics to get data for

​
interval
enum<string>

The time interval to aggregate data by

Available options:
5m,
1h,
1d,
7d,
1M,
3M,
season,
1y,
fy
​
date_start
string<date-time> | null

Start time for the query

​
date_end
string<date-time> | null

End time for the query

​
network_region
string | null

Network region to get data for

​
fueltech
string[] | null

Fueltechs to get data for

​
fueltech_group
string[] | null

Fueltech groups to get data for

​
primary_grouping
enum<string>

Primary grouping to apply

Available options:
network,
network_region
​
secondary_grouping
enum<string> | null

Optional secondary grouping to apply Secondary grouping types for time series data.

These groupings can be applied on top of the primary grouping to provide additional dimensionality to the data.

Attributes: FUELTECH: Group by individual fuel technologies FUELTECH_GROUP: Group by fuel technology groups (e.g., coal, gas, solar) STATUS: Group by facility status (e.g., operating, retired) RENEWABLE: Group by renewable vs non-renewable

Available options:
fueltech,
fueltech_group,
status,
renewable
​
with_clerk
boolean
default:true

Response

Successful Response

​
version
string
​
created_at
string<date-time>
​
success
boolean
default:true
​
error
string | null
​
data
any[]
​
total_records
integer | null