DataForSEO icon

DataForSEO

DataForSEO

Overview

This node integrates with the DataForSEO API to retrieve aggregated category data for business listings. Specifically, the "Get Business Listings Categories Aggregation" operation allows users to query and aggregate business listing categories based on various filters such as categories, location, claim status, and more.

Common scenarios where this node is beneficial include:

  • Market research to understand the distribution of business categories in a specific geographic area.
  • Competitive analysis by aggregating business categories within a radius around a location.
  • Filtering business listings by specific attributes like whether they are claimed or match certain dataset filters.

Practical example:

  • A marketing analyst wants to find out how many businesses fall under certain categories (e.g., restaurants, gyms) within a 10 km radius of a city center, filtering only those that are claimed and limiting results to 500 entries.

Properties

Name Meaning
Categories You can specify up to 10 categories to filter the aggregation. Each category is a string value representing a business category.
Description Optional text description (up to 200 characters). Can be used to add context or notes about the request.
Title Optional title (up to 200 characters). Can be used to label or identify the aggregation request.
Is Claimed Boolean flag to filter businesses by their claimed status. true means only claimed businesses, false means unclaimed, and null means no filter applied.
Location Coordinate Geographic filter specified as "latitude,longitude,radius" (e.g., 53.476225,-2.243572,200). Latitude and longitude support up to 7 decimal places. Radius is in meters, minimum 1, maximum 100000.
Internal Dataset Filters JSON string representing an array of additional filtering parameters supported by DataForSEO. These allow advanced filtering beyond basic properties. See DataForSEO documentation for details.
Internal List Limit Number to limit internal list size (advanced usage).
Limit (up to 1000) Maximum number of results to return. Must be between 1 and 1000. Defaults to 100.
Offset Number of results to skip before starting to collect the output. Useful for pagination. Minimum 0.

Output

The node outputs a JSON array where each element corresponds to an aggregated category result from the DataForSEO API. The exact structure depends on the API response but typically includes fields such as:

  • Category name or identifier
  • Count or metrics related to the category aggregation
  • Possibly other metadata depending on the filters applied

No binary data output is expected from this operation.

Dependencies

  • Requires an active DataForSEO API key credential configured in n8n.
  • The node makes HTTP POST requests to the DataForSEO v3 API endpoint (https://api.dataforseo.com/v3).
  • No additional external dependencies beyond the API key and internet connectivity.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication errors.
    • Incorrectly formatted location_coordinate (not matching "latitude,longitude,radius") may lead to request failures.
    • Exceeding the maximum allowed limit (over 1000) will cause validation errors.
    • Providing invalid JSON in Internal Dataset Filters will cause parsing errors.
  • Error messages:

    • "Something went wrong": Generic error wrapper indicating failure during execution; check underlying API response or network issues.
    • Credential-related errors: Ensure the API key is valid and has sufficient permissions.
    • Validation errors: Check property values against allowed formats and ranges.
  • Resolution tips:

    • Validate all input parameters carefully before running the node.
    • Use the DataForSEO documentation to verify filter syntax and supported values.
    • Test with minimal parameters first, then incrementally add filters.

Links and References

Discussion