Felo API PlatformFelo API Platform

データ 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