REST API Enumeration

The following values are utilized in Catchpoint’s REST API and Alerts Webhook to filter tests by their test and monitor type IDs with their corresponding test and monitor names.

Test Type Values:

${DisplayTestTypeId}

Gives the Display Test Type id as below:

The monitor type determines exactly how a test is executed. Certain test types have multiple monitors available, such as Web tests which have Object, Emulated, Mobile, and Chrome. Other test types have only one monitor; for example FTP tests have only FTP. Some monitors may not be visible in the Catchpoint interface.

Simulator type and IDs

Usage & Examples:

When using the REST API, the GET request here:

https://io.catchpoint.com/ui/Help/Detail/GET-api-vversion-tests_divisionId_productId_parentFolderId_statusId_name_typeId_monitorId_url_alertsPaused_pageNumber_pageSize

...with the {testId} and {monitorId} macros can be used to filter and retrieve tests by test and monitor types. The below example will pull all DNS tests within the client level:

api/v1/tests?testId={5}

We can also get the active and inactive test's information using "statusId" parameter in the REST API URI. The value could be 0, 1 or -1 for "statusId" parameter.

statusId=0 will pull all the active test information from a specific account, division, or folder.

statusId=1 will pull all inactive test information from a specific account, division, or folder.

statusId=-1 will give you both active and inactive test's information.

Example URI

GET api/v{version}/tests?divisionId={divisionId}&productId={productId}&parentFolderId={parentFolderId}&statusId={statusId}

When using the Alerts Webhook, the ${MonitorTypeId} macros can be used with a ${switch} macro to report the monitor names instead of the ID values. Examples of setting up the MonitorType macros in a template can be found below:

MonitorType: ${switch(${MonitorTypeId},'0','IE Browser','2','Object','3','Emulated')}

This XML (https://docs.catchpoint.com/docs/alert-webhook-xml-result) and JSON (https://docs.catchpoint.com/docs/Alert-Webhook-JSON-Result) examples demonstrate what the results look like when using the macros without a ${switch} macro in the XML and JSON files.

Note: The Status field seen in the Alerts Rest API call is different from the StatusID shown above. In the case of Alerts API: GET /api/v{version}/alerts, The Status field is optional and it represents the Incidents state.

Please reach out to Catchpoint Support (support@catchpoint.com) if you have any queries.