Synthetic monitor executions API v2 - POST batch execution

Request body objects

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

jsoncopydownload
{
  "processingMode": "EXECUTIONS_DETAILS_ONLY",
  "failOnPerformanceIssue": false,
  "failOnSslWarning": true,
  "stopOnProblem": true,
  "takeScreenshotsOnSuccess": true,
  "monitors": [
    {
      "monitorId": "HTTP_CHECK-6349B98E1CD87352",
      "executionCount": 3,
      "repeatMode": "SEQUENTIAL",
      "locations": [
        "SYNTHETIC_LOCATION-9BB04DAEBA71B8CA",
        "SYNTHETIC_LOCATION-ACCA399FAA1194DD"
      ],
      "customizedScript": {
        "requests": [
          {
            "url": "https://www.somepage.org",
            "preProcessingScript": "if (response.getResponseBody().includes(\"error\")) {api.fail(\"HTTP failing monitor.\");}"
          },
          {
            "sequenceId": "3",
            "validation": {
              "rules": [
                {
                  "value": "=201",
                  "passIfFound": "true"
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "group": {
    "applications": [
      "APPLICATION-CD4BEF05FA9DD044"
    ],
    "services": [
      "SERVICE-01C6C1282960638B",
      "SERVICE-B18840B4E3115C1A"
    ],
    "tags": [
      "tag-production",
      "another-tag"
    ]
  },
  "metadata": {
    "key": "value",
    "version": "1.255.20221022"
  }
}

Response codes

Response body objects

Response body JSON model

jsoncopydownload
{
  "batchId": "22396514015719218",
  "triggeringProblemsCount": 4,
  "triggeringProblemsDetails": [
    {
      "entityId": "HTTP_CHECK-6349B98E1CD87352",
      "locationId": "SYNTHETIC_LOCAT-9BB04DAEBA71B8CA",
      "cause": "Location not found"
    },
    {
      "entityId": "HTTP_CHECK-6349B98E1CD85432",
      "cause": "Monitor not found"
    },
    {
      "entityId": "HTTP_HACK-AAAAAAA",
      "cause": "Incorrect monitor identifier format"
    },
    {
      "entityId": "APPLICATION-WRONG",
      "cause": "Incorrect application identifier format"
    }
  ],
  "triggeredCount": 1,
  "triggered": [
    {
      "monitorId": "HTTP_CHECK-69A9B98E1CD87352",
      "executions": [
        {
          "executionId": "1069999568093682590",
          "locationId": "SYNTHETIC_LOCATION-9BB04DAE11123122"
        }
      ]
    }
  ]
}