資料 API / DataForSEO / Content Analysis
Content Analysis – Rating Distribution API
Splits a keyword's citations into rating buckets and reports the full metric set for each. Returns one entry per bucket with min, max and a metrics object holding 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. rank_scale chooses the bucketing. For the same metrics un-bucketed use post_dataforseo_content_summary_live; for sentiment alone, post_dataforseo_content_sentiment_analysis_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"
internal_list_limitinteger選填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_domains text_categories page_categories countries languages default value: 1 maximum value: 20
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
positive_connotation_thresholdnumber選填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
sentiments_connotation_thresholdnumber選填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
initial_dataset_filtersarray選填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, match, not_match 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.
rank_scalestring選填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 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/rating_distribution/live" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "<string>",
"keyword_fields": {},
"page_type": [
"<string>"
],
"internal_list_limit": 0,
"search_mode": "<string>",
"positive_connotation_threshold": 0,
"sentiments_connotation_threshold": 0,
"initial_dataset_filters": "<string>"
}'回應
回應欄位
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
typestring選填type of element = ‘content_analysis_rating_distribution’
minnumber選填min rating on a distribution scale
maxnumber選填max rating on a distribution scale
metricsobject選填contains rating distribution metrics
typestring選填type of element = ‘content_analysis_summary’
total_countinteger選填total amount of results in our database relevant to your request
rankinteger選填rank of all URLs citing the keyword normalized sum of ranks of all URLs citing the target keyword
top_domainsstring[]選填top domains citing the target keyword contains objects with top domains citing the target keyword and citation count per each domain
sentiment_connotationsobject選填sentiment connotations contains sentiments (emotional reactions) related to the target keyword citation and the number of citations per each sentiment; possible connotations: "anger", "happiness", "love", "sadness", "share", "fun"
connotation_typesobject選填connotation types contains types of sentiments (sentiment polarity) related to the keyword citation and citation count per each sentiment type; possible connotation types: "positive", "negative", "neutral"
text_categoriesstring[]選填text categories contains objects with text categories and citation count in each text category to obtain a full list of available categories, refer to the Categories endpoint
page_categoriesstring[]選填page categories contains objects with page categories and citation count in each page category to obtain a full list of available categories, refer to the Categories endpoint
page_typesobject選填page types contains page types and citation count per each page type
countriesobject選填countries contains countries and citation count in each country to obtain a full list of available countries, refer to the Locations endpoint
languagesobject選填languages contains languages and citation count in each language to obtain a full list of available languages, refer to the Languages endpoint