This page describes how to configure an API monitoring job.

You can configure these details for an API monitoring job:

• Schedule when, where, and how often a job runs.
• Set timeouts.
• Set performance thresholds to trigger warning and critical events.

Create a Job

1. On the Controller UI, click User Experience > API Monitoring.
2. Click Add Collection and specify a collection name.
3. Click Add.
4. Select the newly created collection and add a job.

A new job configuration page appears; proceed with the following steps:

Configure API Requests

Specify a name for the API job, and then you can configure API requests through one of the following options:

• GUI
• JavaScript
• Import API Collection

GUI

If you do not want to manually create JavaScripts for configuring jobs, the GUI option provides an easy way to configure jobs. 

Click GUI and configure an API request:

The API Requests pane on the left displays the API request that you configure. The API request that you create is named Request 1, you can edit the name later from the API requests list view.

1. Select an HTTP method from the right pane. The supported methods are GET, POST, PUT, and DELETE.
2. Specify the URL to which you want to make the API call.
3. Specify the following details based on the method type:

   
   

   Tabs	Description
   Header	Enter a header name and value as key-value pair.
   Body	XML and JSON body types are supported. Select a body type and enter the details. For example: { title: "foo" body: "bar", userId: 100, }
   Params	Enter the parameter that you want to query along with the value.
   Authentication	The following authentication types are supported: Basic Auth: Specify the username and password. Token: Specify the bearer token. No Auth: No value is required. You can also store your secrets in the Synthetic Credential Vault.
   Response Validation	You can validate the response by adding assertions. For example, when you select Status Code, =, and enter the value as 200, then the job will be successful only when the status code is 200. Similarly, you can add multiple assertions, such as response content, and response time.
   Initialise	You can create initial variables. Specify a variable name and a value. Then you can use it using the following syntax: {{<variable-name>}}
   Settings	Select the Follow Redirects option if the API redirects to another API. When you enable Follow Redirects, you can specify the maximum number under Follow Redirects count. This indicates the number of redirects that are checked for the particular URL.

Create JavaScript

Create a JavaScript for your job and enter it in the Script Editor.

For sample JavaScripts for API Monitoring, see JavaScript.

Import API Collection from Postman

You can import the API collections of Postman to the API monitoring jobs.

Instead of manually creating the API collections again on Controller, you can import the existing API collections of Postman. 

You must first export the API collection as a JSON file from Postman, and then import the JSON file to API Monitoring jobs. Choose the recommended Collection v2.1 while exporting. Exporting the file as Collection v2 is not supported.

Perform the following steps to import the Postman collections:

1. Click Import > Choose File, and then select the API collection JSON file that you exported from Postman.
   
   
2. Click Import.

3. When you get the success message, review the script on the Script Editor tab.

   Any string enclosed with double curly brackets {{ }} is a variable. You must replace the variable manually with an appropriate value.

You can verify if the collections are imported by navigating to User Experience > API Monitoring.

Select Locations

You can select one or more locations in which the job runs. You can configure the job to test all of the locations every time or one location each time the job runs. For a complete list of Synthetic Agent locations, see Synthetic Agent Locations. 

Use the hosted agents to monitor public API endpoints. You can use hosted agents to monitor the API jobs from locations where the real API traffic or request is generated.

Use the private agents to monitor the private APIs. For example, APIs used within a customer network.

Set a Schedule

You can define the job schedule when you create or edit your job.

You can create multiple schedules for the same job. Each schedule can have its own time zone, frequency, and execution interval. This allows you to execute the job in different frequencies:

Click Add Schedule to configure another schedule for the same job. You must create at least one schedule.  

Set Timeout Period

You can configure timeout to make the jobs fail if the time taken to execute the jobs exceeds a certain duration. By default, the API jobs timeout if the job execution does not complete within 5 minutes.

Configure Performance Thresholds

This is an optional step. You can configure performance thresholds that will trigger warning or critical synthetic events when the thresholds are exceeded. 

Availability Configuration 

API jobs failure irrespective of the reason, namely, invalid status code, response content validation, response size validation, and so on, are configured to be reported as an availability event by default. To avoid false positives, you can configure to re-test the jobs a specific number of times before triggering the events.

Performance Events

You can configure API jobs to trigger warning or critical error events based on the response time of the API jobs. To avoid false positives, you can configure to re-test the jobs a specific number of times before triggering the events.