API Reference

Retrieve Performance Simulation Status

Retrieve the status of a performance simulation job.


📘

This endpoint is not provisioned by default in all tenants. For availability, please contact your Aurora account team.

Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.

You will need the job_id from the response body of a POST to the Run Performance Simulation endpoint, or from the parameters of a performance_simulation_job_completed webhook call. Note that the webhook fires for both jobs initiated from the API and from the UI.

Path Params
uuid
required

The ID of the tenant to which the design belongs.

uuid
required

The ID of the design for which to retrieve the performance simulation job.

Query Params
string
required

The ID of the performance simulation job.

Responses

Response body
object
performance_simulation_job
object
string

Unique ID identifying the performance simulation job.

uuid

Unique ID identifying the design that the job was run for.

string

The timestamp of when the job was initiated, formatted as "YYYY-MM-DD HH:MM:SS UTC"

string

The timestamp of when the job was completed, formatted as "YYYY-MM-DD HH:MM:SS UTC"

string

Status of the job.

in-progress succeeded failed

string

Source of the job. "app" if triggered by a user in the Aurora app. "api" if triggered via API.

app api

error
object

Detailed errors. Only populated for failed jobs.

Language
Credentials