RunCollectionClient

Sub-client for listing actor runs.

Hierarchy

• ResourceCollectionClient
  • RunCollectionClient

Index

Methods

• __init__
• list

Methods

__init__

• __init__(args, kwargs): None

• Overrides ResourceCollectionClient.__init__

  Initialize the RunCollectionClient.

  ---

  Parameters

  • args: Any

  • kwargs: Any

  Returns None

list

• list(*, limit, offset, desc, status): ListPage

• List all actor runs (either of a single actor, or all user's actors, depending on where this client was initialized from).

  https://docs.apify.com/api/v2#/reference/actors/run-collection/get-list-of-runs https://docs.apify.com/api/v2#/reference/actor-runs/run-collection/get-user-runs-list

  ---

  Parameters

  • optionalkeyword-onlylimit: Optional[int] = None

    How many runs to retrieve

  • optionalkeyword-onlyoffset: Optional[int] = None

    What run to include as first when retrieving the list

  • optionalkeyword-onlydesc: Optional[bool] = None

    Whether to sort the runs in descending order based on their start date

  • optionalkeyword-onlystatus: Optional[ActorJobStatus] = None

    Retrieve only runs with the provided status

  Returns ListPage

  ListPage: The retrieved actor runs