List Sites

GET

/v0/entities/{entity_id}/sites

List all sites of a given entity

Authorizations

• APIKeyHeader

Parameters

Path Parameters

entity_id

required

string

Responses

200

Successful Response

object

entity_id

required

string

sites

required

Array<object>

object

created_at

required

string format: date-time

created_by

required

string

updated_at

Any of:

string

string format: date-time

null

null

updated_by

Any of:

string

string

null

null

_id

Any of:

string

string

null

null

name

required

string

description

required

string

main_entity

required

string

data_sources

required

Array<string>

grafana_org_id

Any of:

integer

integer

null

null

location

Any of:

SiteLocation

object

lat

Any of:

number

number

null

null

lon

Any of:

number

number

null

null

geo_address

Any of:

string

string

null

null

alias

Any of:

string

string

null

null

null

null

settings

required

object

sub_entities_can_edit

boolean

system_properties

object

pv

object

peak_power

Any of:

number

number

null

null

module_count

Any of:

integer

integer

null

null

module_efficiency

Any of:

number

number

null

null

azimuth_degrees

Any of:

number

number

null

null

tilt_degrees

Any of:

number

number

null

null

albedo

Any of:

number

number

null

null

mounting

Any of:

string

string

null

null

inverter_efficiency

Any of:

number

number

null

null

soiling_loss

Any of:

number

number

null

null

shading_loss

Any of:

number

number

null

null

mismatch_loss

Any of:

number

number

null

null

dc_wiring_loss

Any of:

number

number

null

null

ac_wiring_loss

Any of:

number

number

null

null

availability_loss

Any of:

number

number

null

null

nameplate_loss

Any of:

number

number

null

null

temperature_coefficient

Any of:

number

number

null

null

controllability

Any of:

unknown

Allowed values: not-possible binary continuous

null

null

grid

object

import_power

Any of:

number

number

null

null

export_power

Any of:

number

number

null

null

battery

object

capacity_kwh

Any of:

number

number

null

null

economics

object

currency

Any of:

string

string

null

null

grid_selling_price_per_kwh

Any of:

number

number

null

null

grid_buying_price_per_kwh

Any of:

number

number

null

null

genset_buying_price_per_kwh

Any of:

number

number

null

null

grid_energy_price_per_kwh

Any of:

number

number

null

null

grid_demand_price_per_kw

Any of:

number

number

null

null

grid_fixed_price_components

Any of:

number

number

null

null

gas_price_per_kwh

Any of:

number

number

null

null

water_price_per_m3

Any of:

number

number

null

null

system_investment_cost

Any of:

number

number

null

null

annual_maintenance_cost

Any of:

number

number

null

null

environmental

object

co2_per_kwh

Any of:

number

number

null

null

trees_saved_per_kwh

Any of:

number

number

null

null

co2_factor_grid_per_kwh

Any of:

number

number

null

null

co2_factor_genset_per_kwh

Any of:

number

number

null

null

commissioning

object

commissioning_date

Any of:

string

string format: date-time

null

null

installation_company

Any of:

string

string

null

null

customer_info

Any of:

string

string

null

null

services

object

pv_forecast

object

enabled

boolean

preferred_model

string

default: auto

Allowed values: auto pv_lstm pv_physics baseline

load_forecast

object

enabled

boolean

preferred_model

string

default: load_lstm

Allowed values: auto load_lstm load_baseline

dashboard_template

required

object

_id

Any of:

string

string

null

null

created_at

Any of:

string

string format: date-time

null

null

created_by

Any of:

string

string

null

null

updated_at

Any of:

string

string format: date-time

null

null

updated_by

Any of:

string

string

null

null

name

Any of:

string

string

null

null

description

Any of:

string

string

null

null

dashboard_category

Any of:

string

string

Allowed values: site data-source data-analyzer

null

null

dashboard_type

Any of:

string

string

null

null

labels

Any of:

object

object

key

additional properties

string

null

null

instances

Any of:

Array<string>

Array<string>

null

null

main_entities

Any of:

Array<string>

Array<string>

null

null

languages

Any of:

object

object

key

additional properties

object

name

Any of:

string

string

null

null

description

Any of:

string

string

null

null

null

null

dashboard_template_schema

Any of:

integer

integer

null

null

labels

required

object

key

additional properties

string

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string