Apify icon

Apify

Access Apify tools for web scraping, data extraction, and automation.

Overview

This node integrates with the Apify platform to retrieve runs of a specified Actor. It is designed to fetch detailed information about executions (runs) of an Actor, which are instances where the Actor performed its task such as web scraping or automation.

Common scenarios include:

  • Monitoring recent or historical runs of an Actor to analyze performance or results.
  • Filtering runs by status to identify failed or successful executions.
  • Paginating through runs using offset and limit parameters for large datasets.

Practical example:

  • A user wants to get the last 50 successful runs of a specific Actor to review output data or logs.
  • Another use case is fetching all currently running executions to monitor progress in real-time.

Properties

Name Meaning
Actor The Actor to query runs for. Can be selected from a list, provided as an Actor URL, or directly by Actor ID.
Offset Number of runs to skip from the start of the list. Useful for pagination. Default is 0.
Limit Maximum number of runs to return. Minimum value is 1. Default is 50.
Desc Whether to sort runs by their start time in descending order (true) or ascending order (false). Default is true.
Status Filter runs by their status. Options include: ABORTED, ABORTING, FAILED, READY, RUNNING, SUCCEEDED, TIMED-OUT, TIMING-OUT, or All (no filter).
Authentication Choose the authentication method to connect to Apify: either an API key credential or OAuth2.

Output

The node outputs an array of run objects in the json field. Each object represents a single run of the specified Actor and contains details such as:

  • Run ID
  • Status (e.g., SUCCEEDED, FAILED)
  • Start and end timestamps
  • Input and output data references
  • Metadata about the execution environment

If the Actor run produces binary data, it would typically be referenced via URLs or metadata rather than embedded directly.

Dependencies

  • Requires access to the Apify platform.
  • Needs valid authentication credentials configured in n8n, either an API key or OAuth2 token.
  • Network connectivity to Apify's API endpoints.

Troubleshooting

  • Invalid Actor ID or URL: Ensure the Actor identifier is correct and matches the expected format. The node validates URLs and IDs with regex patterns.
  • Authentication errors: Verify that the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
  • Empty results: Check if the Actor has any runs matching the specified filters (status, offset, limit).
  • Rate limiting or API errors: If many requests are made in a short time, Apify may throttle responses. Implement retries or reduce request frequency.

Links and References

Discussion