Apify icon

Apify

Apify API

Overview

This node interacts with the Apify API to retrieve a list of task runs for a specified Actor Task. It is useful for monitoring and managing the execution history of tasks within the Apify platform. For example, users can fetch recent runs of a particular task to analyze performance, check statuses, or debug issues.

Use Case Examples

  1. Fetch the last 100 successful runs of a specific Actor Task to review execution details.
  2. Retrieve task runs starting from a specific offset to paginate through historical data.

Properties

Name Meaning
Actor Task ID Specifies the ID or a tilde-separated owner's username and task's name to identify the Actor Task whose runs are to be listed.
Offset Number of task runs to skip from the start, useful for pagination.
Limit Maximum number of task runs to return, with a default and maximum of 1000.
Desc Determines if the task runs are sorted by start time in descending order (true) or ascending order (false).
Status Filters task runs by their status, such as SUCCEEDED, to return only runs matching the specified lifecycle state.
Use Custom Body Option to use a custom request body instead of default query parameters when fetching task runs.

Output

JSON

  • runs - Array of task run objects containing details about each run such as status, start time, and results.

Dependencies

  • Requires Apify API access with an API key credential for authentication.

Troubleshooting

  • Ensure the Actor Task ID is valid and correctly formatted; invalid IDs or URLs will cause errors.
  • Check API credentials and permissions if authentication errors occur.
  • If no runs are returned, verify the status filter and offset parameters to ensure they match existing runs.

Links

Discussion