Felo API PlatformFelo API Platform

数据 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