Get API Monitoring Job Execution Status API

This page describes the API used to get the Synthetic API monitoring job execution status.

Resource URL

GET /v1/synthetic/api/schedule/<id>/sessions

Example request:

{{eum_api}}/v1/synthetic/api/schedule/a9bd504a-8588-4ce0-be4a-6e214a36afe9/sessions?max=2&startTime=1649245800

CODE

Response Body

The response contains a list of sessions after the startTime that have timestamp and status details.

Example response:

{
  "_next": "1648620679523",
  "items": [
    {
      "status": "OK",
      "startTimeMS": 1648620679152,
      "sessionError": "None"
    },
    {
      "status": "422",
      "startTimeMS": 1648620679523,
      "sessionError": "None"
    }
  ]
}

CODE

If the _next parameter in the response is not null, it signifies that the result is paginated and there could be more results.

To retrieve further results, use the value of _next as the startTime of the next request. Repeat this step until the value of the _next parameter is null.

Request Parameters

Parameter Name	Parameter Type	Value	Description	Mandatory Request
`id`	Path	Path of the unique identifier of a synthetic job	Unique identifier of a synthetic job	Yes
`max`	Query	Must be between 1 - 20	Pagination parameter	Yes
`startTime`	Query	Epoch time in seconds, starting time from where you need to get the sessions	Pagination parameter	Yes
`endTime`	Query	Epoch time in seconds, the time till when we want to get the session.	If this value is not specified, the current timestamp is used. This provides the details of the sessions from `startTime` to the current time.	No

You can use this tool to convert GMT/IST times to epoch times.

Response Status Code

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