Skip to main content
POST
Run simulation

Authorizations

X-API-KEY
string
header
default:pk_live_YOUR_KEY
required

Prometheus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as Authorization: Bearer pk_live_....

Body

application/json
nodeId
string
required

Graph node to shock.

Maximum string length: 64
magnitudePct
number
required
Required range: -100 <= x <= 100
includeClaimedEdges
boolean
default:false

Also traverse edges that are claimed but not yet validated.

horizonQuarters
integer
default:4
Required range: 1 <= x <= 8

Response

OK

The response is of type object.