Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Dashboard

Get upcoming scheduled runs

Retrieve list of upcoming scheduled simulation runs with scenario name, next run time, and frequency information.

get/dashboard/upcoming-scheduled-runs

Query parameters

projectIdstring required

Project identifier

scenarioIdsstring[]

Filter by scenario/simulation reference IDs (comma-separated or array). If not provided, includes all scenarios.

limitinteger

Maximum number of upcoming scheduled runs to return

Response

Upcoming scheduled runs retrieved successfully

Example response

{
  "data": [
    {
      "simulationReference": "sim-ref-123",
      "simulationName": "Customer Support Flow Test",
      "nextRun": "2024-01-20T10:00:00Z",
      "frequency": "Daily",
      "frequencyValue": "0 10 * * *",
      "batchId": "batch-id-456",
      "batchName": "Daily Customer Support Test",
      "status": "IN_PROGRESS"
    }
  ]
}