Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"keyword": "logitech",
"page_type": [
"ecommerce",
"news",
"blogs",
"message-boards",
"organization"
],
"internal_list_limit": 8,
"positive_connotation_threshold": 0.5
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"internal_list_limit": 8,
"keyword": "logitech",
"page_type": [
"ecommerce",
"news",
"blogs",
"message-boards",
"organization"
],
"positive_connotation_threshold": 0.5
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live"
payload = [
{
"internal_list_limit": 8,
"keyword": "logitech",
"page_type": ["ecommerce", "news", "blogs", "message-boards", "organization"],
"positive_connotation_threshold": 0.5
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
internal_list_limit: 8,
keyword: 'logitech',
page_type: ['ecommerce', 'news', 'blogs', 'message-boards', 'organization'],
positive_connotation_threshold: 0.5
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'internal_list_limit' => 8,
'keyword' => 'logitech',
'page_type' => [
'ecommerce',
'news',
'blogs',
'message-boards',
'organization'
],
'positive_connotation_threshold' => 0.5
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live"
payload := strings.NewReader("[\n {\n \"internal_list_limit\": 8,\n \"keyword\": \"logitech\",\n \"page_type\": [\n \"ecommerce\",\n \"news\",\n \"blogs\",\n \"message-boards\",\n \"organization\"\n ],\n \"positive_connotation_threshold\": 0.5\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"internal_list_limit\": 8,\n \"keyword\": \"logitech\",\n \"page_type\": [\n \"ecommerce\",\n \"news\",\n \"blogs\",\n \"message-boards\",\n \"organization\"\n ],\n \"positive_connotation_threshold\": 0.5\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"internal_list_limit\": 8,\n \"keyword\": \"logitech\",\n \"page_type\": [\n \"ecommerce\",\n \"news\",\n \"blogs\",\n \"message-boards\",\n \"organization\"\n ],\n \"positive_connotation_threshold\": 0.5\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"connotation_types": {},
"countries": {},
"languages": {},
"page_categories": [
{
"category": [
123
],
"count": 123
}
],
"page_types": {},
"rank": 123,
"sentiment_connotations": {},
"text_categories": [
{
"category": [
123
],
"count": 123
}
],
"top_domains": [
{
"count": 123,
"domain": "<string>"
}
],
"total_count": 123,
"type": "<string>"
}
]
}
]
}Content Analysis
Content Analysis – Summary API
Aggregate view of every citation of a keyword across the web index.
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
content_analysis
/
summary
/
live
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"keyword": "logitech",
"page_type": [
"ecommerce",
"news",
"blogs",
"message-boards",
"organization"
],
"internal_list_limit": 8,
"positive_connotation_threshold": 0.5
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"internal_list_limit": 8,
"keyword": "logitech",
"page_type": [
"ecommerce",
"news",
"blogs",
"message-boards",
"organization"
],
"positive_connotation_threshold": 0.5
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live"
payload = [
{
"internal_list_limit": 8,
"keyword": "logitech",
"page_type": ["ecommerce", "news", "blogs", "message-boards", "organization"],
"positive_connotation_threshold": 0.5
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
internal_list_limit: 8,
keyword: 'logitech',
page_type: ['ecommerce', 'news', 'blogs', 'message-boards', 'organization'],
positive_connotation_threshold: 0.5
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'internal_list_limit' => 8,
'keyword' => 'logitech',
'page_type' => [
'ecommerce',
'news',
'blogs',
'message-boards',
'organization'
],
'positive_connotation_threshold' => 0.5
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live"
payload := strings.NewReader("[\n {\n \"internal_list_limit\": 8,\n \"keyword\": \"logitech\",\n \"page_type\": [\n \"ecommerce\",\n \"news\",\n \"blogs\",\n \"message-boards\",\n \"organization\"\n ],\n \"positive_connotation_threshold\": 0.5\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"internal_list_limit\": 8,\n \"keyword\": \"logitech\",\n \"page_type\": [\n \"ecommerce\",\n \"news\",\n \"blogs\",\n \"message-boards\",\n \"organization\"\n ],\n \"positive_connotation_threshold\": 0.5\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"internal_list_limit\": 8,\n \"keyword\": \"logitech\",\n \"page_type\": [\n \"ecommerce\",\n \"news\",\n \"blogs\",\n \"message-boards\",\n \"organization\"\n ],\n \"positive_connotation_threshold\": 0.5\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"connotation_types": {},
"countries": {},
"languages": {},
"page_categories": [
{
"category": [
123
],
"count": 123
}
],
"page_types": {},
"rank": 123,
"sentiment_connotations": {},
"text_categories": [
{
"category": [
123
],
"count": 123
}
],
"top_domains": [
{
"count": 123,
"domain": "<string>"
}
],
"total_count": 123,
"type": "<string>"
}
]
}
]
}Aggregate view of every citation of a keyword across the web index. Returns
Set this endpoint up in your agent →
total_count, rank, top_domains (each domain and count), sentiment_connotations (anger, happiness, love, sadness, share, fun), connotation_types (positive, negative, neutral), text_categories, page_categories, page_types, countries and languages. Measured at 1.1 KB for one keyword. Every response wraps its payload in DataForSEO’s envelope - tasks[0].result holds the data. This is the hub of the content family: post_dataforseo_content_sentiment_analysis_live returns only the two connotation blocks already included here, so call this one instead unless you specifically want the smaller payload. For the individual citing pages rather than the totals use post_dataforseo_content_search_live; for the same aggregate over time, post_dataforseo_content_phrase_trends_live.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"keyword": "...", "keyword_fields": "...", "page_type": "..."}]'
// Copy this whole block into Claude Code, Codex, Cursor or any coding agent.
// It carries everything needed to connect, authorize and run this example —
// no key to paste, one click of Allow in the browser.
{
"calls": [
{
"call_id": "1",
"tool": "post_dataforseo_content_summary_live",
"arguments": {}
}
]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
// name aisa
// endpoint https://mcp.aisa.one/mcp
// transport streamable-http
// auth OAuth. The server publishes RFC 9728 metadata, so open a
// browser and the user clicks Allow once — nothing to paste.
// If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
// Codex codex mcp add aisa --url https://mcp.aisa.one/mcp
// Claude Code claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
// Cursor / VS Code a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
// https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-content-analysis-summary-live.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
First time? Point any MCP client at
https://mcp.aisa.one/mcp — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: search,
list_categories, get_details and batch_quote are free, batch_use is
billed per call. Setup per client is in
Connect via MCP; the live tool list and what each call
costs are on aisa.one/mcp.Request contract
- Method and path: POST /apis/v1/dataforseo/content_analysis/summary/live
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/dataforseo/content_analysis/summary/live - Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_content_summary_live",
"method": "POST",
"path": "/apis/v1/dataforseo/content_analysis/summary/live",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"internal_list_limit": 8,
"keyword": "logitech",
"page_type": [
"ecommerce",
"news",
"blogs",
"message-boards",
"organization"
],
"positive_connotation_threshold": 0.5
}
],
"items": {
"oneOf": [
{
"properties": {
"initial_dataset_filters": {
"description": "<em>initial dataset filtering parameters</em><br>optional field<br>initial filtering parameters that apply to fields in the <a href=\"/v3/content_analysis/search/live/?bash\" target=\"_blank\">Search endpoint</a><br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>,<code>not_like</code>, <code>has</code>, <code>has_not</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>[\"domain\",\"<>\", \"logitech.com\"]</code><p><code>[[\"domain\",\"<>\",\"logitech.com\"],\"and\",[\"content_info.connotation_types.negative\",\">\",1000]]</code><p><code>[[\"domain\",\"<>\",\"logitech.com\"]],<br>\"and\",<br>[[\"content_info.connotation_types.negative\",\">\",1000],<br>\"or\",<p>[\"content_info.text_category\",\"has\",10994]]]</code><br>for more information about filters, please refer to <a href=\"/v3/content_analysis/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Content Analysis API - Filters</a><br>learn more about the initial dataset filters in <a href=\"https://dataforseo.com/help-center/what-are-the-initial-dataset-filters-and-how-do-they-work\" rel=\"noopener noreferrer\" target=\"_blank\">this help center article.</a>",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"internal_list_limit": {
"description": "<em>maximum number of elements within internal arrays</em><br>optional field<br>you can use this field to limit the number of elements within the following arrays:<br><code>top_domains</code><br><code>text_categories</code><br><code>page_categories</code><br><code>countries</code><br><code>languages</code><br>default value: <code>1</code><br>maximum value: <code>20</code>",
"type": [
"integer",
"null"
]
},
"keyword": {
"description": "<em>target keyword</em><br><strong>required field</strong><br>UTF-8 encoding<br>the keywords will be converted to a lowercase format;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example: <br><code>\"keyword\": \"\\\"tesla palo alto\\\"\"</code><p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
"type": "string"
},
"keyword_fields": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "<em>target keyword fields and target keywords</em><br>optional field<br>use this parameter to filter the dataset by keywords that certain fields should contain;<br>fields you can specify: <code>title</code>, <code>main_title</code>, <code>previous_title</code>, <code>snippet</code><br>you can indicate several fields;<br><strong>Note</strong>: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes; <br>example:<br><code>\"keyword_fields\": {<br>\"snippet\": \"\\\"logitech mouse\\\"\",<br>\"main_title\": \"sale\"<br>}</code>",
"type": [
"object",
"null"
]
},
"page_type": {
"description": "<em>target page types</em><br>optional field<br>use this parameter to filter the dataset by page types<br>possible values: <br><code>\"ecommerce\"</code>, <code>\"news\"</code>, <code>\"blogs\"</code>, <code>\"message-boards\"</code>, <code>\"organization\"</code>",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"positive_connotation_threshold": {
"description": "<em>positive connotation threshold</em><br>optional field<br>specified as the probability index threshold for positive sentiment related to the citation content<br>if you specify this field, <code>connotation_types</code> object in the response will only contain data on citations with <code>positive</code> sentiment probability more than or equal to the specified value<br>possible values: from <code>0</code> to <code>1</code><br>default value: <code>0.4</code>",
"type": [
"number",
"null"
]
},
"rank_scale": {
"description": "<em>defines the scale used for calculating and displaying the <code>rank</code> values</em><br>optional field<p>you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale<p>possible values:<br><code>one_hundred</code> — rank values are displayed on a 0–100 scale<br><code>one_thousand</code> — rank values are displayed on a 0–1000 scale<p>default value: <code>one_thousand</code><p>learn more about how this parameter works in <a href=\"https://dataforseo.com/help-center/using-the-rank_scale-parameter-in-content-analysis-api\">this Help Center article</a>",
"type": [
"string",
"null"
]
},
"sentiments_connotation_threshold": {
"description": "<em>sentiment connotation threshold</em><br>optional field<br>specified as the probability index threshold for sentiment connotations related to the citation content<br>if you specify this field, <code>sentiment_connotations</code> object in the response will only contain data on citations where the <br>probability per each sentiment is more than or equal to the specified value<br>possible values: from <code>0</code> to <code>1</code><br>default value: <code>0.4</code>",
"type": [
"number",
"null"
]
},
"tag": {
"description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.0276,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"components": {
"schemas": {
"ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/ProviderF3207D84Cc07_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
}
},
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.0276 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.0276
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
initial dataset filtering parameters
optional field
initial filtering parameters that apply to fields in the Search endpoint
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like,not_like, has, has_not
you can use the % operator with like and not_like to match any string of zero or more characters
example:["domain","<>", "logitech.com"]
[["domain","<>","logitech.com"],"and",["content_info.connotation_types.negative",">",1000]]
[["domain","<>","logitech.com"]],"and",[["content_info.connotation_types.negative",">",1000],"or",
["content_info.text_category","has",10994]]]
for more information about filters, please refer to Content Analysis API - Filters
learn more about the initial dataset filters in this help center article.
JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator.
maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the following arrays:top_domainstext_categoriespage_categoriescountrieslanguages
default value: 1
maximum value: 20
target keyword
required field
UTF-8 encoding
the keywords will be converted to a lowercase format;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example: "keyword": ""tesla palo alto""
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
target keyword fields and target keywords
optional field
use this parameter to filter the dataset by keywords that certain fields should contain;
fields you can specify: title, main_title, previous_title, snippet
you can indicate several fields;
Note: to match an exact phrase instead of a stand-alone keyword, use double quotes and backslashes;
example:"keyword_fields": {"snippet": ""logitech mouse"","main_title": "sale"}
Show child attributes
Show child attributes
target page types
optional field
use this parameter to filter the dataset by page types
possible values: "ecommerce", "news", "blogs", "message-boards", "organization"
positive connotation threshold
optional field
specified as the probability index threshold for positive sentiment related to the citation content
if you specify this field, connotation_types object in the response will only contain data on citations with positive sentiment probability more than or equal to the specified value
possible values: from 0 to 1
default value: 0.4
defines the scale used for calculating and displaying the rank values
optional field
you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale
possible values:one_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scale
default value: one_thousand
learn more about how this parameter works in this Help Center article
sentiment connotation threshold
optional field
specified as the probability index threshold for sentiment connotations related to the citation content
if you specify this field, sentiment_connotations object in the response will only contain data on citations where the
probability per each sentiment is more than or equal to the specified value
possible values: from 0 to 1
default value: 0.4
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 object of the response
Example:
[
{
"internal_list_limit": 8,
"keyword": "logitech",
"page_type": [
"ecommerce",
"news",
"blogs",
"message-boards",
"organization"
],
"positive_connotation_threshold": 0.5
}
]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes