Serpstat icon

Serpstat

Consume the Serpstat API to get organic competitors

Overview

This node integrates with the Serpstat API to retrieve organic competitors for a specified domain. It is useful for SEO professionals, digital marketers, and analysts who want to analyze competitive domains in organic search results. By providing a domain and selecting a search engine, users can obtain a list of competitor domains that appear organically in search results related to the input domain.

Practical examples include:

  • Identifying competitors for a business website to inform marketing strategies.
  • Monitoring changes in competitor landscape over time.
  • Gathering data for SEO audits or market research.

Properties

Name Meaning
Domain The domain name to get competitors for. Example: allo.ua.
Search Engine The search engine to use for the query. Options include many country-specific Google engines (e.g., g_us, g_uk, g_de) and Bing US (bing_us).
Additional Fields Optional parameters to customize the request:
- Page Page number in response (integer >= 1). Default is 1.
- Size Number of results per page (integer between 10 and 500). Default is 100.
- Sort Field Field to sort results by, e.g., relevance, common, all, visibility, missing.
- Sort Order Sort order direction: Ascending or Descending.

Output

The node outputs an array of JSON objects representing the organic competitors for the specified domain. Each object corresponds to one competitor entry as returned by the Serpstat API's getOrganicCompetitorsPage method. The exact structure depends on the API response but typically includes details about competitor domains and their metrics.

If the API returns an error or no data, the node either throws an error or outputs an error message in the JSON output if "Continue On Fail" is enabled.

No binary data output is produced by this node.

Dependencies

  • Requires access to the Serpstat API via an API token credential.
  • The node makes HTTP POST requests to https://api.serpstat.com/v4/.
  • Users must configure the node with a valid Serpstat API authentication token.
  • Network connectivity to the Serpstat API endpoint is required.

Troubleshooting

  • Common issues:

    • Invalid or missing API token will cause authentication errors.
    • Providing an invalid domain or unsupported search engine code may result in empty or error responses.
    • Exceeding API rate limits or quota may cause errors from the Serpstat API.
    • Incorrect pagination or size parameters might lead to unexpected results or errors.
  • Error messages:

    • "Serpstat API error: <message>": Indicates an error returned by the Serpstat API. Check the API token validity, request parameters, and API status.
    • "Serpstat API response did not contain result.data": Means the expected data was not present in the API response. Verify the domain and parameters are correct.
    • Network or HTTP errors will be thrown by the underlying HTTP request helper.
  • Resolution tips:

    • Ensure the API token is correctly set up and has sufficient permissions.
    • Validate input parameters before running the node.
    • Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion