Get All Synthetic API Monitoring Jobs API

This page describes the API used to get configuration data for all Synthetic API monitoring jobs.

Search an API Monitoring Job

Searches an API monitoring job with the specified JSON payload.

Resource URL

GET /v1/synthetic/api/schedule

Response Format

JSON

Example

{
  "_next": "52852985-fsdfdsg-23593259",
  "_items": [
    {
      "_id": "job_id",
      "version": 2,
      "scheduleRunConfigs": [
        {
          "rate": {
            "value": 15,
            "unit": "MINUTES"
          },
          "daysOfWeek": [
            "SUN",
            "WED",
            "FRI",
            "MON",
            "THUR",
            "SAT",
            "TUES"
          ],
          "timezone": "UTC"
        }
      ],
      "userEnabled": true,
      "systemEnabled": true,
      "type": "ALL_BROWSERS",
      "rate": {
        "value": 15,
        "unit": "MINUTES"
      },
      "daysOfWeek": [
        "SUN",
        "WED",
        "FRI",
        "MON",
        "THUR",
        "SAT",
        "TUES"
      ],
      "timezone": "UTC",
      "description": "appd1",
      "appKey": "appKey",
      "scheduleMode": "NONE",
      "script": {
        "contentType": "INLINE_PYTHON_3",
        "script": "pageUrl = \"http://www.appdynamics.com\"\ndriver.get(pageUrl)\nassert \"AppDynamics\" in driver.title, \"Title should contain AppDynamics\""
      },
      "browserCodes": [
        "Chrome"
      ],
      "chromeVersions": [
        "86"
      ],
      "locationCodes": [
        "M50"
      ],
      "failOnPageError": true,
      "captureVisualMetrics": true,
      "simulateMobileBrowser": false,
      "networkProfile": {
        "name": "Native",
        "description": "",
        "downloadKbps": 5000,
        "uploadKbps": 1000,
        "roundtripTimeMillis": 28,
        "packetLossPercent": 0,
        "isDefault": false
      },
      "timeoutSeconds": 30,
      "state": {
        "lastFireTime": "2022-04-01T04:49:46.544Z"
      },
      "projectedUsage": {
        "projectedDailyRuns": 96,
        "projectedMonthlyRuns": 2880
      },
      "performanceCriteria": {
        "retestOnWarning": false,
        "retestOnCritical": false,
        "criterion": []
      },
      "composableConfig": {
        "numBeforeConfirmedError": 0,
        "resourceErrorDetection": {
          "ignoreWhen": {
            "resourceUrlContains": [],
            "resourceMimeType": []
          },
          "onlyWhen": {
            "resourceUrlContains": [],
            "resourceMimeType": []
          }
        }
      },
      "created": "2022-04-01T04:49:46.538Z",
      "updated": "2022-04-01T04:50:13.325Z"
    }
  ]
}

JSON

Request Parameters

Parameter Name	Parameter Type	Value	Description	Mandatory Request
`appKey`	Query	Application key	Retrieve the API monitoring jobs of a particular application.	No
`description`	Query	Job name	Search jobs using the job name. This parameter retrieves all jobs if: the job name is equal to the string Or, the job name contains a substring equal to the string All string matching operations are case-insensitive.	No
`location`	Query	Synthetic internal location codes of each agent location	Retrieve the web monitoring jobs scheduled only for the specified locations. You can specify this parameter multiple times to filter jobs for multiple locations.	No
`max`	Query	An integer between 1 and 100	You can use this parameter to view the result in a paginated format. The maximum number of results displayed on a page is equal to the value of this parameter. If there are further results, a `_next` cursor is present in the response. Use this value used to retrieve the next set of results.	No
`cursor`	Query	The value of the `_next` parameter returned in the previous response	You can use this parameter only if the `max` parameter is used. If you view the result in a paginated format, and if the results exceed a single page, then the value of the `_next` parameter in the previous response is used in the next request.	No

Response Status Codes

Code	Description
200	Success
401	Unauthorized
429	Throttled
500	Internal server error