v1

latestOpenAPI 3.0.02026-07-142351,1971.3 MB

Synthetics

Get a mobile test

Get the detailed configuration associated with a Synthetic mobile test.

get/api/v1/synthetics/tests/mobile/{public_id}

Path parameters

public_idstring required

The public ID of the test to get details from.

Response

device_idsSyntheticsDeviceID[]

Array with the different device IDs used to run the test.

messagestring required

Notification message associated with the test.

monitor_idinteger

The associated monitor ID.

namestring required

Name of the test.

public_idstring

The public ID of the test.

status'live' | 'paused'

Define whether you want to start (live) or pause (paused) a Synthetic test.

tagsstring[]

Array of tags attached to the test.

type'mobile' required

Type of the Synthetic test, mobile.

Example response

{
  "config": {
    "variables": [
      {
        "name": "VARIABLE_NAME",
        "type": "text"
      }
    ]
  },
  "device_ids": [
    "chrome.laptop_large"
  ],
  "message": "Notification message",
  "monitor_id": 12345678,
  "name": "Example test name",
  "options": {
    "ci": {
      "executionRule": "blocking"
    },
    "device_ids": [
      "synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16"
    ],
    "mobileApplication": {
      "applicationId": "00000000-0000-0000-0000-aaaaaaaaaaaa",
      "referenceId": "00000000-0000-0000-0000-aaaaaaaaaaab",
      "referenceType": "latest"
    },
    "restricted_roles": [
      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    ],
    "scheduling": {
      "timeframes": [
        {
          "day": 1,
          "from": "07:00",
          "to": "16:00"
        },
        {
          "day": 3,
          "from": "07:00",
          "to": "16:00"
        }
      ],
      "timezone": "America/New_York"
    },
    "tick_every": 300
  },
  "public_id": "123-abc-456",
  "status": "live",
  "steps": [
    {
      "params": {
        "variable": {
          "name": "VAR_NAME"
        }
      },
      "publicId": "pub-lic-id0",
      "type": "assertElementContent"
    }
  ],
  "tags": [
    "env:production"
  ],
  "type": "mobile"
}