API reference · DataForSEO
dataforseo/v3/dataforseo_labs/google/serp_competitors/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/serp_competitors/live01
Input Schema
12 parameters · 1 required · 11 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
keywords | array | Required | keywords arrayrequired fieldthe results will be based on the keywords you specify in this arrayUTF-8 encoding;the keywords will be converted to lowercase format;you can specify the maximum of 200 keyw... |
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 domains in the results array will be omitted and the data will be provided for t... |
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 | search results typeindicates type of search results included in the responseoptional fieldpossible values: ["organic", "paid", "featured_snippet", "local_pack"]default value: ["organic", "paid"] |
language_code | string | Optional | unique language identifierrequired 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 the... |
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 | unique location identifierrequired 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 the... |
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 loca... |
include_subdomains | boolean | Optional | indicates if the subdomains will be included in the searchoptional fieldif set to false, the subdomains will be ignoreddefault value: true |
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/serp_competitors/live",
"prompt": "a beautiful sunset over mountains"
}'
