RunCollectionClient

apify_client.clients.RunCollectionClient

Sub-client for listing actor runs.

Index

Methods

• list

Methods

list

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

• 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

  • limit: Optional[int] = Noneoptionalkeyword-only

    How many runs to retrieve

  • offset: Optional[int] = Noneoptionalkeyword-only

    What run to include as first when retrieving the list

  • desc: Optional[bool] = Noneoptionalkeyword-only

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

  • status: Optional[ActorJobStatus] = Noneoptionalkeyword-only

    Retrieve only runs with the provided status

  Returns ListPage[Dict]

  The retrieved actor runs