PApaddlehq
Simulation runs

List runs for a simulation

Changed on

Returns a paginated list of simulation runs. Use the query parameters to page through results.

Use the include parameter to include related entities in the response.

get/simulations/{simulation_id}/runs

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

simulation_idstring required

Paddle ID of the simulation entity to work with.

Query parameters

idstring[]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

includeSimulationsRunIncludeEnum[]

Include related entities in the response.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "ntfsimrun_01ghbkd0frb9k95cnhwd1bxpvk",
      "created_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z",
      "events": [
        {
          "id": "ntfsimevt_01hvg8ykjrcdr4jvv9rqcbkhfa",
          "created_at": "2024-10-12T07:20:50.52Z",
          "updated_at": "2024-10-13T07:20:50.52Z"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

  • v1e1ac347eb3c5Revision changes
    • info

      api tag Simulations removed

    • info

      added the new optional header request parameter Skip-Count

  • v19ba8be0f2006Revision changes
    • breaking

      added the new path request parameter simulation_id

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api tag Simulations added

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed from the / response property oneOf list for the response status