Sign in

v1

latestOpenAPI 3.1.02026-08-06118124285.7 KB
Forecast Events

List forecast events for group and its ancestors

post/v2/forecast-events/groups/{groupId}/events

Path parameters

groupIdinteger required

Request body

externalVariableIdstring required
externalConfigurationIdstring required
startTimestring date-time required
endTimestring date-time required

Example request

{
  "externalVariableId": "external-var-123",
  "externalConfigurationId": "external-config-456",
  "startTime": "2026-05-04T08:00:00Z",
  "endTime": "2026-05-04T18:00:00Z"
}

Response

OK

idstring
startTimestring date-time required
endTimestring date-time required
eventCategoryIdstring required
groupIdinteger
eventEffectValuenumber double
commentstring
activeboolean
hierarchyEnabledboolean

Example response

[
  {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "startTime": "2026-05-04T08:00:00Z",
    "endTime": "2026-05-04T18:00:00Z",
    "eventCategoryId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "parentEvent": {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "startTime": "2026-05-04T08:00:00Z",
      "endTime": "2026-05-04T18:00:00Z",
      "eventCategoryId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "groupId": 12345,
      "eventEffects": [
        {
          "forecastConfigurationId": 42,
          "type": "RELATIVE",
          "value": 1.25
        }
      ],
      "eventEffectValue": 1.25,
      "comment": "Local football match",
      "active": true,
      "hierarchyEnabled": true
    },
    "groupId": 12345,
    "eventEffects": [
      {
        "forecastConfigurationId": 42,
        "type": "RELATIVE",
        "value": 1.25
      }
    ],
    "eventEffectValue": 1.25,
    "comment": "Local football match",
    "active": true,
    "hierarchyEnabled": true
  }
]