Skip to main content

RunCollectionClient

Sub-client for listing Actor runs.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, root_client, http_client, resource_id, resource_path, params): None

  • Initialize a new instance.

    Parameters

    • keyword-onlybase_url: str

      Base URL of the API server.

    • keyword-onlyroot_client: ApifyClient

      The ApifyClient instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClient

      The HTTPClient instance to be used in this client.

    • optionalkeyword-onlyresource_id: str | None = None

      ID of the manipulated resource, in case of a single-resource client.

    • keyword-onlyresource_path: str

      Path to the resource's endpoint on the API server.

    • optionalkeyword-onlyparams: dict | None = None

      Parameters to include in all requests from this client.

    Returns None

list

  • list(*, limit, offset, desc, status, started_before, started_after): ListPage[dict]

  • List all Actor runs.

    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: int | None = None

      How many runs to retrieve.

    • optionalkeyword-onlyoffset: int | None = None

      What run to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

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

    • optionalkeyword-onlystatus: (ActorJobStatus | list[ActorJobStatus]) | None = None

      Retrieve only runs with the provided statuses.

    • optionalkeyword-onlystarted_before: (str | datetime) | None = None

      Only return runs started before this date (inclusive).

    • optionalkeyword-onlystarted_after: (str | datetime) | None = None

      Only return runs started after this date (inclusive).

    Returns ListPage[dict]

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str
Page Options