The maximum number of runs to return in a single response.
The service may return fewer than this value.
If unspecified or 0, at most 10 runs will be returned.
The maximum value is 1000; values above 1000 will be coerced to 1000.
If negative, an INVALID_ARGUMENT error will be returned.
page_tokenstringOptional
A page token received from a previous ListRuns call.
Provide this to retrieve the subsequent page of results.
When paginating, all other parameters provided to ListRuns must match
the call that provided the page token.
filterstringOptional
Filter expression for filtering runs.
Follows the structured syntax defined in AIP-160.
Supported fields for filtering:
create_time: The timestamp when the run was created (google.protobuf.Timestamp)
Supported operators:
Comparison: =, !=, <, >, <=, >=
Logical: AND, OR, NOT, -
Examples:
Filter runs created after a specific date (start_date):
"create_time >= "2024-01-01T00:00:00Z""
Filter runs created before a specific date (end_date):
"create_time <= "2024-12-31T23:59:59Z""
Filter runs within a date range (start_date and end_date):
"create_time >= "2024-01-01T00:00:00Z" AND create_time <= "2024-12-31T23:59:59Z""
Complex filter with multiple date ranges:
"(create_time >= "2024-01-01T00:00:00Z" AND create_time <= "2024-06-30T23:59:59Z") OR create_time >= "2024-07-01T00:00:00Z""
Timestamps must be in RFC-3339 format (e.g., "2024-01-01T00:00:00Z").
If an invalid filter expression is provided, the API will return INVALID_ARGUMENT.
Year of the date. Must be from 1 to 9999, or 0 to specify a date without
a year.
start_date.monthinteger · int32Optional
Month of a year. Must be from 1 to 12, or 0 to specify a year without a
month and day.
start_date.dayinteger · int32Optional
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
to specify a year by itself or a year and month where the day isn't
significant.
end_date.yearinteger · int32Optional
Year of the date. Must be from 1 to 9999, or 0 to specify a date without
a year.
end_date.monthinteger · int32Optional
Month of a year. Must be from 1 to 12, or 0 to specify a year without a
month and day.
end_date.dayinteger · int32Optional
Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
to specify a year by itself or a year and month where the day isn't
significant.
time_zonestringRequired
Time zone for date aggregation.
Format: IANA timezone identifier (e.g., "America/New_York", "UTC", "Europe/London")
filterstringOptional
Filter expression for filtering runs included in the aggregation.
Follows the structured syntax defined in AIP-160.
Supported fields for filtering:
automation_id: The unique identifier of the automation (string)
Supported operators:
Comparison: =
Logical: OR
Examples:
Filter by specific automation:
"automation_id = "789""
Filter by multiple automations:
"automation_id = "789" OR automation_id = "790""
If an invalid filter expression is provided, the API will return INVALID_ARGUMENT.
This RPC retrieves a paginated list of all events that occurred during a specific automation run. Events are returned in the order they were generated, providing a complete timeline of the run's execution.
Use the filter parameter to narrow results by specific criteria such as node_kind for execution journal events.
The response includes both high-level run state changes (starts, completions, failures) and detailed execution steps (node executions, execution patches, detailed data flows in each expression, etc).
Authorizations
AuthorizationstringRequired
Personal Access Token.
Path parameters
organization_idstringRequired
workspace_idstringRequired
automation_idstringRequired
run_idstringRequired
Query parameters
page_sizeinteger · int32Optional
Maximum number of run events to return in a single response.
The service may return fewer events than requested, but will never
return more. This can happen when:
The run has fewer total events than requested
Internal chunking limits are reached
The remaining events don't fit in the response size limit
Valid range: 1-1000 events
Default: 100 events if unspecified
Values above 1000 are automatically capped at 1000
Negative values result in an INVALID_ARGUMENT error
page_tokenstringOptional
Pagination token from a previous ListRunEvents response.
Provide the next_page_token value from a previous response to
continue retrieving the next set of events. Leave empty or unset
for the first page of results.
The token is opaque and should not be parsed or modified by clients.
filterstringOptional
Filter expression to narrow down which events are returned.
node_kind: Filter execution journal events by the kind/type of node.
Only execution journal events with matching node_kind are returned.
Example: node_kind = "FunctionCall"
When empty or unset, all events for the specified run are returned.
Example filters:
node_kind = "FunctionCall"
node_kind = "Assignment"
