API reference · DataForSEO
dataforseo/v3/dataforseo_labs/google/competitors_domain/live
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
dataforseo/v3/dataforseo_labs/google/competitors_domain/live01
Input Schema
17 parameters · 1 required · 16 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
target | string | Required | domainrequired fieldthe domain name of the target websitethe domain should be specified without https:// and www.you can specify page URL, but the results will be specific to the domain in the specifi... |
tag | string | Optional | user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object... |
limit | integer | Optional | the maximum number of returned domainsoptional fielddefault value: 100maximum value: 1000 |
offset | integer | Optional | offset in the results array of returned domainsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for ... |
filters | array | Optional | array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are su... |
order_by | array | Optional | results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will ... |
item_types | array | Optional | display results by item typeoptional fieldindicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results wi... |
language_code | string | Optional | language coderequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_c... |
language_name | string | Optional | full name of the languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with thei... |
location_code | integer | Optional | location coderequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_c... |
location_name | string | Optional | full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with thei... |
max_rank_group | integer | Optional | maximum rank up to which competitors will be consideredoptional fielddefault value: 100if you specify 10 here, we will extract competitors from the top 10 Google search results only |
exclude_domains | array | Optional | exclude domains from the resultsoptional fielduse this parameter to exclude specific domains from the resultsNote: you can specify up to 1000 domains in this arrayexample:"exclude_domains": ["reddit.c... |
ignore_synonyms | boolean | Optional | ignore highly similar keywordsoptional fieldif set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen |
exclude_top_domains | boolean | Optional | indicates whether to exclude world's largest websitesoptional fielddefault value: falseset to true if you want to get highly-relevant competitors excluding the websites listed below:wikipedia.orgpinte... |
intersecting_domains | array | Optional | additional domains for improving results accuracyoptional fieldto improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs;if you use this array... |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to_true, you will receive clickstream_etv, clickstream_genderdistribution, andclickstream_age_... |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
03
Code Examples
Ready-to-run snippets
curl -X POST https://api.sandbase.ai/v1/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "dataforseo/v3/dataforseo_labs/google/competitors_domain/live",
"prompt": "a beautiful sunset over mountains"
}'