Apify icon

Apify

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

Overview

This node integrates with the Apify platform, enabling users to interact with Apify's web scraping, data extraction, and automation tools. Specifically, the "Actor Run" resource with the "Get User Runs List" operation allows users to retrieve a list of runs executed by their Apify actors (automated tasks). This is useful for monitoring actor executions, analyzing run statuses, or fetching metadata about past runs.

Practical examples include:

  • Fetching recent successful runs to analyze output data.
  • Retrieving failed or timed-out runs to trigger alerts or retries.
  • Paginating through runs using offset and limit parameters for detailed reporting.

Properties

Name Meaning
Offset Number of array elements to skip at the start of the results. Default is 0. Useful for pagination.
Limit Maximum number of results to return. Minimum value is 1. Defaults to 50.
Desc Boolean indicating if results are sorted by startedAt in descending order (true) or ascending order (false). Defaults to true.
Status Filter runs by terminal status. Options: SUCCEEDED, FAILED, TIMED-OUT, ABORTED. Defaults to SUCCEEDED.
Authentication Choose authentication method: API Key or OAuth2.

Output

The node outputs an array of JSON objects representing the actor runs matching the query parameters. Each object typically contains metadata about a run such as its ID, status, start time, end time, and other relevant details provided by the Apify API.

If binary data were involved (e.g., files or logs), it would be indicated here, but this operation focuses on JSON metadata only.

Dependencies

  • Requires access to the Apify platform via either an API key credential or OAuth2 authentication.
  • The user must configure one of these authentication methods in n8n before executing the node.
  • Network connectivity to Apify's API endpoints is necessary.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Requesting too large a limit may result in API errors or slow responses.
    • Using an unsupported status filter value will lead to no results or errors.
  • Error messages:
    • Authentication errors: Verify that the API key or OAuth2 token is correctly configured and has sufficient permissions.
    • Rate limiting or quota exceeded: Consider reducing request frequency or limit parameter.
    • Invalid parameter errors: Check that offset and limit are numbers within allowed ranges and that status is one of the supported options.

Links and References

Discussion