get_action_metadata

fireopal.get_action_metadata(limit=1, offset=0, status=None)

Fetch metadata from previously submitted Fire Opal actions.

Use this function to programmatically inspect the history of submitted jobs. For example to check completion status, retrieve action IDs for downstream processing, or build custom monitoring dashboards.

Parameters

  • limit (int , optional) – The number of actions to fetch. Cannot exceed 50. Defaults to 1.
  • offset (int , optional) – The number of recent actions to skip before starting to fetch, enabling pagination through results. Defaults to 0.
  • status (str or None , optional) – The filter for action status (e.g. "SUCCESS", "FAILURE", "IN_PROGRESS"). If None, fetches actions of all statuses. Defaults to None.

Returns

list[ActionMetadata] – A list of ActionMetadata dataclass instances ordered from most recent to least recent, each containing:

  • name: The client function that submitted the action (e.g. "execute", "validate").
  • status: The current status of the action.
  • created_at: Creation timestamp formatted as "YYYY-MM-DD HH:MM:SS" in UTC.
  • updated_at: Last-updated timestamp formatted as "YYYY-MM-DD HH:MM:SS" in UTC.
  • model_id: The unique identifier for the action.

Raises

QctrlArgumentsValueError – If limit exceeds 50.

Was this useful?