Skip to main content

PaginatedResponse[Site]

data object[]required
  • Array [
  • _idId (string)
    Default value: 68c92c7bdd74ec71cce47fcd
    Example: 5eb7cf5a86d9755df3a6c593
    partner_idPartner Id (string)required

    Possible values: Value must match regular expression ^[a-zA-Z0-9_-]{1,64}$

    site_idSite Id (string)required

    Possible values: Value must match regular expression ^[a-zA-Z0-9_-]{1,64}$

    nameName (string)required
    location objectrequired
    nameName (string)required
    coordinatesarrayrequired

    Possible values: >= 3, <= 3

    countryCountry (string)required
    activeActive (boolean)
    Default value: false
    validation_status object
    anyOf
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    site_configuration_status object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    configuration_added object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    configuration_complete object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    missing_assetsstring[]
    Default value: []
    valid_for_optimization object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    validation_errors object
    anyOf
    string
    optimization_configuration_status object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    ingress_status object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    receiving_measurement_data object
    statusValidationStatusEnum (string)

    Possible values: [ERROR, WARNING, OK, UNKNOWN]

    Default value: UNKNOWN
    not_receiving_data_fromstring[]
    Default value: []
    last_validationstring<date-time>
    Default value: 2025-09-16T09:23:07.855625Z
    configurations object
    anyOf
    site_configuration object
    anyOf
    device_list object[]required
  • Array [
  • oneOf
    nameName (string)required

    The name of the device itself. This value will be used as the asset ID in the rest of the API.

    collectorCollector (string)required

    The name of the collector to which this device is connected.

    typeType (string)
    Constant value: charging_pole_3phase
    Default value: charging_pole_3phase
    line_currentLine Current (integer)required

    The line current in Ampere.

    pin_to_phase_mapping objectrequired

    Defines how charging pole pins map to the collectors' phases. For more information see the 'Key Concepts - Site configuration' section in the documentation.

    pin_liststring[]required

    Possible values: [pin1, pin2, pin3]

    phase_liststring[]required

    Possible values: [L1, L2, L3]

  • ]
  • collector_list object[]required
  • Array [
  • nameName (string)required
    children object

    The children of this collector. This is used to create a tree structure.

    anyOf
  • Array [
  • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
  • ]
  • phase_permutations object

    If the phase naming conventions (L1, L2, L3) are not consistent between parent and child, specify the phase mapping between them.

    anyOf
    parentstring[]required
    childstring[]required
    line_currentLine Current (integer)required

    The line current in Ampere.

    line_voltage objectdeprecated

    Deprecated: use phase_voltage instead.

    anyOf
    integer
    phase_voltage object

    The phase voltage in Volt.

    anyOf
    integer
    commodityCommodity (string)
    Default value: electricity
    1P_3PCollectorType (string)required

    Specifies whether the collector is single-phase (1P) or three-phase (3P).

    Possible values: [1P, 3P]

  • ]
  • optimization_configuration object
    anyOf
    peak_minimization object
    anyOf
    active object

    Boolean field that indicates if the peak minimization is activated or not.

    anyOf
    boolean
    peak_limit object

    Specifies a line under which the peak_price does not apply. The value specified will be applied to all the phases of the collector separately. By default the peak_limit is set to 0.

    anyOf
    integer
    peak_pricePeak Price (integer)required
    cost_minimization object
    anyOf
    activeActive (boolean)
    Default value: false
    day_ahead_price object
    anyOf
    boolean
    day_ahead_bidding_zone object
    anyOf
    string

    Possible values: [DE_50HZ, AL, DE_AMPRION, AT, BY, BE, BA, BG, CZ_DE_SK, HR, CWE, CY, CZ, DE_AT_LU, DE_LU, DK, DK_1, DK_1_NO_1, DK_2, DK_CA, EE, FI, MK, FR, DE, GR, HU, IS, IE_SEM, IE, IT, IT_SACO_AC, IT_CALA, IT_SACO_DC, IT_BRNN, IT_CNOR, IT_CSUD, IT_FOGN, IT_GR, IT_MACRO_NORTH, IT_MACRO_SOUTH, IT_MALTA, IT_NORD, IT_NORD_AT, IT_NORD_CH, IT_NORD_FR, IT_NORD_SI, IT_PRGP, IT_ROSN, IT_SARD, IT_SICI, IT_SUD, RU_KGD, LV, LT, LU, LU_BZN, MT, ME, GB, GE, GB_IFA, GB_IFA2, GB_ELECLINK, UK, NL, NO_1, NO_1A, NO_2, NO_2_NSL, NO_2A, NO_3, NO_4, NO_5, NO, PL_CZ, PL, PT, MD, RO, RU, SE_1, SE_2, SE_3, SE_4, RS, SK, SI, GB_NIR, ES, SE, CH, DE_TENNET, DE_TRANSNET, TR, UA, UA_DOBTPP, UA_BEI, UA_IPS, XK, DE_AMP_LU]

    fixed_offtake_price object

    The offtake price in Mega Watt per hour. This is the price electricity is taken from the grid.

    anyOf
    number
    injection_price object

    Price at which electricity can be injected back into to grid in Mega Watt per hour.

    anyOf
    integer
    planning_frequencyPlanning Frequency (string)

    The planned frequency at which a site will be optimized. Should follow the python timedelta notation. Currently this field is disabled as we only support 15 minutes long optimization configuration. Notation is in Pandas Timedelta notation.

    Constant value: PT15M
    Default value: PT15M
    planning_horizonPlanning Horizon (string)

    The planning horizon for which the optimization will be done. Should follow the python timedelta notation. We only allow 1 day, 2 days or 3 days for now

    Possible values: [P1D, P2D, P3D]

    Default value: P1D
    forecasting_configuration objectrequired
    forecasted_devices object[]required
  • Array [
  • device_idDevice Id (string)required
    parent_collector_idParent Collector Id (string)required
    train_windowTrain Window (number)
    Default value: 90
    sample_sizeSample Size (number)
    Default value: 900
    time_fieldTime Field (string)required
    forecasted_fieldForecasted Field (string)required
    training_interval object
    anyOf
    string

    Possible values: Value must match regular expression ^P(T?\d+.*)$

    activeActive (boolean)
    Default value: true
    forecast_typeDeviceForecastType (string)

    Possible values: [pv, load, calculated_ucl]

    Default value: pv
  • ]
  • ucl_calculation_activeUcl Calculation Active (boolean)required
    connections objectrequired
    anyOf
    mqtt objectrequired
    clusterCluster (string)
    Default value: mqtt.pleevi.ai
    energy_measurement_topicEnergy Measurement Topic (string)required
    transaction_topicTransaction Topic (string)required
    advice_topicAdvice Topic (string)required
    notification_topicNotification Topic (string)required
  • ]
  • page_sizePage Size (integer)required
    end_cursor object

    Cursor to retrieve the next page of results.

    anyOf
    string

    Possible values: non-empty

    has_next_pageHas Next Page (boolean)
    Default value: false
    PaginatedResponse[Site]
    {
    "data": [
    {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "partner_id": "string",
    "site_id": "string",
    "name": "string",
    "location": {
    "name": "string",
    "coordinates": [
    null
    ]
    },
    "country": "string",
    "active": false,
    "validation_status": {
    "status": "UNKNOWN",
    "site_configuration_status": {
    "status": "UNKNOWN",
    "configuration_added": {
    "status": "UNKNOWN"
    },
    "configuration_complete": {
    "status": "UNKNOWN",
    "missing_assets": [
    "string"
    ]
    },
    "valid_for_optimization": {
    "status": "UNKNOWN",
    "validation_errors": "string"
    }
    },
    "optimization_configuration_status": {
    "status": "UNKNOWN"
    },
    "ingress_status": {
    "status": "UNKNOWN",
    "receiving_measurement_data": {
    "status": "UNKNOWN",
    "not_receiving_data_from": [
    "string"
    ]
    }
    },
    "last_validation": "2025-09-16T09:23:07.855625Z"
    },
    "configurations": {
    "site_configuration": {
    "device_list": [
    {
    "name": "LR34_001",
    "collector": "main_collector",
    "type": "charging_pole_3phase",
    "line_current": 0,
    "pin_to_phase_mapping": {
    "pin_list": [
    "pin1"
    ],
    "phase_list": [
    "L1"
    ]
    }
    },
    {
    "name": "LR34_001",
    "collector": "main_collector",
    "type": "dc_charging_pole",
    "max_power": 250000
    },
    {
    "name": "LR34_001",
    "collector": "main_collector",
    "type": "forecasted_series_3phase",
    "line_current": 0,
    "forecast_type": "pv"
    }
    ],
    "collector_list": [
    {
    "name": "string",
    "children": [
    null
    ],
    "phase_permutations": {
    "parent": [
    "string"
    ],
    "child": [
    "string"
    ]
    },
    "line_current": 0,
    "phase_voltage": 0,
    "commodity": "electricity",
    "1P_3P": "1P"
    }
    ]
    },
    "optimization_configuration": {
    "peak_minimization": {
    "active": true,
    "peak_limit": 0,
    "peak_price": 0
    },
    "cost_minimization": {
    "active": false,
    "day_ahead_price": true,
    "day_ahead_bidding_zone": "DE_50HZ",
    "fixed_offtake_price": 0,
    "injection_price": 0
    },
    "planning_frequency": "PT15M",
    "planning_horizon": "P1D"
    },
    "forecasting_configuration": {
    "forecasted_devices": [
    {
    "device_id": "string",
    "parent_collector_id": "string",
    "train_window": 90,
    "sample_size": 900,
    "time_field": "string",
    "forecasted_field": "string",
    "training_interval": "string",
    "active": true,
    "forecast_type": "pv"
    }
    ]
    },
    "ucl_calculation_active": true
    },
    "connections": {
    "mqtt": {
    "cluster": "mqtt.pleevi.ai",
    "energy_measurement_topic": "string",
    "transaction_topic": "string",
    "advice_topic": "string",
    "notification_topic": "string"
    }
    }
    }
    ],
    "page_size": 0,
    "end_cursor": "string",
    "has_next_page": false
    }