Get upcoming scheduled runs - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Get upcoming scheduled runs

Request

GET /dashboard/upcoming-scheduled-runs

Example cURL request

curl --request GET \
  --url 'https://api-trial.cognigy.ai/testing/dashboard/upcoming-scheduled-runs?limit=20' \
  --header 'Authorization: Bearer <token>'

Example Python request

import requests

url = "https://api-trial.cognigy.ai/testing/dashboard/upcoming-scheduled-runs?limit=20"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Example JavaScript (fetch) request

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-trial.cognigy.ai/testing/dashboard/upcoming-scheduled-runs?limit=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Example PHP request

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/testing/dashboard/upcoming-scheduled-runs?limit=20",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Example Go request

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api-trial.cognigy.ai/testing/dashboard/upcoming-scheduled-runs?limit=20"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Response Status Codes

Response Structure

Success Response

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

Error Responses

{
  "error": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

Authorizations

Authorization

Query Parameters