Data API / DataForSEO / Content Analysis

Content Analysis – Search API

Lists the individual pages citing a keyword, rather than the totals. Each item carries url, domain, main_domain, url_rank, domain_rank, spam_score, fetch_time, country, language, score and page_category, alongside total_count and items_count. filters accepts the fields listed by get_dataforseo_content_available_filters. For counts and distributions instead of pages, use post_dataforseo_content_summary_live.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

keywordstringНеобязательный
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
keyword_fieldsobjectНеобязательный
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" }
titlestringНеобязательный
main_titlestringНеобязательный
previous_titlestringНеобязательный
snippetstringНеобязательный
page_typestring[]Необязательный
target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization"
search_modestringНеобязательный
results grouping type optional field possible grouping types: as_is – returns all citations for the target keyword one_per_domain – returns one citation of the keyword per domain default value: as_is
limitintegerНеобязательный
the maximum number of returned citations optional field default value: 100 maximum value: 1000
filtersarrayНеобязательный
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 are supported: regex, not_regex, , , >, >=, =, , in, not_in, like,not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["country","=", "US"] [["domain_rank",">",800],"and",["content_info.connotation_types.negative",">",0.9]] [["domain_rank",">",800], "and", [["page_types","has","ecommerce"], "or", ["content_info.text_category","has",10994]]] for more information about filters, please refer to Content Analysis API – Filters
order_bystring[]Необязательный
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 – results will be sorted in the descending order you should use a comma to set up a sorting type example: ["content_info.sentiment_connotations.anger,desc"] default rule: ["content_info.sentiment_connotations.anger,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["content_info.sentiment_connotations.anger,desc","keyword_data.keyword_info.cpc,desc"]
offsetintegerНеобязательный
offset in the results array of returned citations optional field default value: 0 if you specify the 10 value, the first ten citations in the results array will be omitted and the data will be provided for the successive citations Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead.
offset_tokenstringНеобязательный
offset token for subsequent requests optional field provided in the identical field of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task learn more about this parameter on our Help Center
rank_scalestringНеобязательный
defines the scale used for calculating and displaying the domain_rank, and url_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 scale one_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
tagstringНеобязательный
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

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/content_analysis/search/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "keyword": "<string>",
  "keyword_fields": {},
  "page_type": [
    "<string>"
  ],
  "search_mode": "<string>",
  "limit": 0,
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "offset": 0
}'

Ответ

Поля ответа

versionstringНеобязательный
the current version of the API
status_codeintegerНеобязательный
general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_messagestringНеобязательный
general informational message you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
total tasks cost, USD
tasks_countintegerНеобязательный
the number of tasks in the tasks array
tasks_errorintegerНеобязательный
the number of tasks in the tasks array returned with an error
tasksstring[]Необязательный
array of tasks
idstringНеобязательный
task identifier unique task identifier in our system in the UUID format
status_codeintegerНеобязательный
status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
status_messagestringНеобязательный
informational message of the task you can find the full list of general informational messages here
timestringНеобязательный
execution time, seconds
costnumberНеобязательный
cost of the task, USD
result_countintegerНеобязательный
number of elements in the result array
pathstring[]Необязательный
URL path
dataobjectНеобязательный
contains the same parameters that you specified in the POST request
resultstring[]Необязательный
array of results
offset_tokenstringНеобязательный
offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task
total_countintegerНеобязательный
total amount of results in our database relevant to your request
items_countintegerНеобязательный
the number of results returned in the items array
itemsstring[]Необязательный
contains citations and related data
typestringНеобязательный
type of element = ‘content_analysis_search’
urlstringНеобязательный
URL where the citation was found
domainstringНеобязательный
domain name
main_domainstringНеобязательный
main domain
url_rankintegerНеобязательный
rank of the url this value is based on backlink data for the given URL from DataForSEO Backlink Index; url_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article
spam_scorestringНеобязательный
backlink spam score of the url this value is based on backlink data for the given URL from DataForSEO Backlink Index; learn more about how the metric is calculated on this help center page
domain_rankstringНеобязательный
rank of the domain this value is based on backlink data for the given domain from DataForSEO Backlink Index; domain_rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm learn more about the metric and how it is calculated in this help center article
fetch_timestringНеобязательный
date and time when our crawler visited the page in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00
countrystringНеобязательный
country code of the domain registration to obtain a full list of available countries, refer to the Locations endpoint
languagestringНеобязательный
main language of the domain to obtain a full list of available languages, refer to the Languages endpoint
scorestringНеобязательный
citation prominence score this value is based on url_rank, domain_rank, keyword presence in title, main_title, url, snippet the higher the score, the more value the related citation has
page_categorystring[]Необязательный
contains all relevant page categories product and service categories relevant for the page to obtain a full list of available categories, refer to the Categories endpoint
page_typesstring[]Необязательный
page types
ratingsstring[]Необязательный
ratings found on the page all ratings found on the page based on microdata
social_metricsstring[]Необязательный
social media engagement metrics data on social media interactions associated with the content based on website embeds developed and supported by social media platforms
content_infoobjectНеобязательный
contains data on citations from the given url
content_typestringНеобязательный
type of content example: page_content, comment
titlestringНеобязательный
title of the result
main_titlestringНеобязательный
page title
previous_titlestringНеобязательный
title of the previous content block
levelintegerНеобязательный
title heading level indicates h-tag level from 1 (top) to 6 (bottom)
authorstringНеобязательный
author of the content
snippetstringНеобязательный
content snippet
snippet_lengthintegerНеобязательный
character length of the snippet
social_metricsstring[]Необязательный
social media engagement metrics data on social media interactions associated with the content based on website embeds developed and supported by social media platforms
highlighted_textstringНеобязательный
highlighted text from the snippet
languagestringНеобязательный
content language to obtain a full list of available languages, refer to the Languages endpoint
sentiment_connotationsobjectНеобязательный
sentiment connotations contains sentiments (emotional reactions) related to the given citation and probability index per each sentiment possible sentiment connotations: anger, happiness, love, sadness, share, fun
connotation_typesobjectНеобязательный
connotation types contains types of sentiments (sentiment polarity) related to the given citation and probability index per each sentiment type possible sentiment connotation types: positive, negative, neutral
text_categorystring[]Необязательный
text category to obtain a full list of available categories, refer to the Categories endpoint
date_publishedstringНеобязательный
date and time when the content was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00
content_quality_scoreintegerНеобязательный
content quality score this value is calculated based on the number of words, sentences and characters the content contains
semantic_locationstringНеобязательный
semantic location indicates semantic element in HTML where the target keyword citation is located example: article, header
ratingobjectНеобязательный
content rating rating related to content_info
namestringНеобязательный
rating name here you can find the following elements: Max5, Percents, CustomMax
rating_valueintegerНеобязательный
the value of the rating
max_rating_valueintegerНеобязательный
maximum value for the rating name
rating_countintegerНеобязательный
number of votes
relative_ratingnumberНеобязательный
relative rating
group_datestringНеобязательный
citation group date and time indicates content publication date or date and time when our crawler visited the page for the first time; this field can be used to group citations by date and display citation trends; date and time are provided in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2017-01-24 13:20:59 +00:00