Skip to main content
POST
Simulate a monitor

Authorizations

X-API-KEY
string
header
required

API key created in the Bigdata Developer Platform.

Path Parameters

monitor_id
string<uuid>
required

Unique identifier for the monitor.

Query Parameters

end_timestamp
string<date-time>
required

When the historical test should end, in UTC. This time must be at least five minutes in the past.

number_of_runs
integer
default:1

Number of consecutive periods to test. The length of each period matches the monitor's frequency, and the periods count backward from end_timestamp.

Required range: x >= 1

Response

Simulation accepted for asynchronous processing.

data
object
required
metadata
object
required