Run Internals

List Run Events

Changed on

Returns one page of the run's stream (PaginatedRunStreamList): one ordered delivery of Petri's own RunEvents and Fabro's platform records in the RunStreamItem envelope, in stream_seq order. The cursor is after: the last stream_seq the client saw, exclusive; the first page is after=0. A client that reconnects resumes from its last stream_seq and deduplicates by each item's id; every item is delivered once, in order, with no gap.

get/api/v1/runs/{id}/events

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or API key in cookie __fabro_session

Path parameters

idstring required

Unique run identifier (ULID).

Query parameters

limitinteger

Maximum number of events to return.

afterinteger

Run stream cursor for a Petri run: the last stream_seq the client saw, exclusive. 0 starts at the first item.

Response

One page of the run's stream

event_contract_versioninteger required

Example response

{
  "event_contract_version": 3
}

Changes

  • efc644ab09d4Revision changes
    • breaking

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

    • warning

      deleted the query request parameter before_seq

    • warning

      deleted the query request parameter order

    • warning

      deleted the query request parameter since_seq

    • info

      added the new optional query request parameter after

    • info

      removed the non-success response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the required property to the response with the status

  • 148f0a9eb912Revision changes
    • breaking

      added subschema #2 to the ////// response property oneOf list for the response status

    • breaking

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