Retrieve Simulation Results

Retrieve Simulation Results

Changed on

Retrieve the results of a simulation run.

Returns the simulation run details and one page of its results, oldest first.

get/v1/retrieve-simulation-results/{simulation_run_id}

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/retrieve-simulation-results/{simulation_run_id}
  • Auth
    HTTPBearer (a scheme the document does not define)

Path parameters

simulation_run_idstring required

Query parameters

limitinteger

How many results to return.

offsetinteger

How many results to skip.

issue_idsstring[] nullable

Keep results linked to any of these simulation issue IDs

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

statusstring

Status of the response

Changes

  • 54d5bd5ab0bcRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property / to the response with the status

  • 1087dc5f5b7bRevision changes
    • info

      added the new optional query request parameter issue_ids