List runs for a simulation
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.
Path Parameters
Paddle ID of the simulation entity to work with.
Query Parameters
Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.
Include related entities in the response.
Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].
Valid fields for ordering: id.
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.
Return only the IDs specified. Use a comma-separated list to get multiple entities.
Response
Represents a simulation run entity.
Unique Paddle ID for this simulation run, prefixed with ntfsimrun_.
Status of this simulation run.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Single event sent for this simulation, in the format entity.event_type.
Events associated with this simulation run. Paddle creates a list of events for each simulation runs. Returned when the include parameter is used with the events value.
Unique Paddle ID for this simulation event, prefixed with ntfsimevt_.
Status of this simulation run log.
Type of event sent by Paddle, in the format entity.event_type.
Simulation payload. Pass a JSON object that matches the schema for an event type to simulate a custom payload. If omitted, Paddle populates with a demo example.
Information about the request. Sent by Paddle as part of the simulation.
Information about the response. Sent by the responding server for the notification setting.
RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
Information about this response.
Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
Keys used for working with paginated results.