QUquinyx
Forecast Event Effects

Calculate event effects for a customer

Changed on
post/v2/forecast-calculation/customer/{customerId}/events

Request

Path parameters

customerIdinteger required

Request body

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

Example request

{
  "startTime": "2024-01-15T08:00:00Z",
  "endTime": "2024-01-15T18:00:00Z",
  "externalConfigurationId": "config-123",
  "externalVariableId": "var-456",
  "externalUnitId": "unit-789",
  "externalSectionId": "section-001"
}

Response

OK

idstring
startTimestring date-time
endTimestring date-time
eventCategoryIdstring
groupIdinteger
commentstring
activeboolean
hierarchyEnabledboolean

Example response

[
  {
    "id": "evt-7f3c2a1b",
    "startTime": "2024-01-15T08:00:00Z",
    "endTime": "2024-01-15T18:00:00Z",
    "eventCategoryId": "cat-001",
    "groupId": 42,
    "eventEffects": [
      {
        "id": "eff-7f3c2a1b",
        "eventId": "evt-7f3c2a1b",
        "forecastConfigurationId": 1,
        "type": "RELATIVE",
        "value": 1.25
      }
    ],
    "comment": "Marketing campaign launch",
    "active": true
  }
]

Changes