API reference · DataForSEO
dataforseo/v3/dataforseo_labs/google/ranked_keywords/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/ranked_keywords/live01
Input Schema
15 parameters · 1 required · 14 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
target | string | Required | domain name or page url required field the domain name of the target website, subdomain or URL of the target webpage; the domain name must be specified without https:// or www.; the subdomain must be ... |
tag | string | Optional | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data ob... |
limit | integer | Optional | the maximum number of returned keywords optional field default value: 100 maximum value: 1000 |
offset | integer | Optional | offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided ... |
filters | array | Optional | array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators ar... |
order_by | array | Optional | results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc R... |
item_types | array | Optional | display results by item type optional field indicates the type of search results included in the response Note: if the item_types array contains item types that are different from organic, the results... |
language_code | string | Optional | language code optional field if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the... |
language_name | string | Optional | full name of the language optional field if you use this field, you don't need to specify language_code you can receive the list of available languages with their language_name by making a separate re... |
location_code | integer | Optional | location code optional field if you use this field, you don't need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the... |
location_name | string | Optional | full name of the location optional field if you use this field, you don't need to specify location_code you can receive the list of available locations with their location_name by making a separate re... |
ignore_synonyms | boolean | Optional | ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false |
load_rank_absolute | boolean | Optional | return rankings distribution by rank_absolute optional field default value: false if set to true, we will return the field metrics_absolute containing rankings distribution by the rank_absolute parame... |
historical_serp_mode | string | Optional | data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return keywords for which the specified target currently has ranking results in SE... |
include_clickstream_data | boolean | Optional | include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, clickstream_etv, clickstream_gender_dist... |
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/ranked_keywords/live",
"prompt": "a beautiful sunset over mountains"
}'