Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Content Analysis – Phrase Trends API

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

Content Analysis – Phrase Trends API

​

The summary metrics for a keyword, repeated per time period. Each entry carries a date plus 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. date_from, date_to and date_group (day, week, month) set the range and granularity. Use this to see whether mentions of a phrase are rising or falling; for a single point in time use post_dataforseo_content_summary_live. To track a whole product category rather than one phrase, use post_dataforseo_content_category_trends_live.

Body
required
application/json
  • Type: array object[]
    • date_from
      Type: string
      required

      starting date of the time range required field date format: "yyyy-mm-dd" example: "2019-01-15"

    • keyword
      Type: string
      required

      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

    • date_group
      Type: string

      time range which will be used to group the results optional field default value: month possible values: day, week, month

    • date_to
      Type: string

      ending date of the time range optional field if you don’t specify this field, today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15"

    • initial_dataset_filters
      Type: array

      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.

    • internal_list_limit
      Type: integer

      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

    • keyword_fields
      Type: object

      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" }

      • main_title
        Type: string
      • previous_title
        Type: string
      • snippet
        Type: string
      • title
        Type: string
    • page_type
      Type: array string[]

      target page types optional field use this parameter to filter the dataset by page types possible values: "ecommerce", "news", "blogs", "message-boards", "organization"

    • rank_scale
      Type: string

      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

    • search_mode
      Type: string

      results grouping type optional field possible grouping types: as_is – returns data on all citations for the target keyword one_per_domain – returns data on one citation of the keyword per domain default value: as_is

    • tag
      Type: string

      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

Responses
  • 200
    Type: object

    Successful response

    • cost
      Type: number

      total tasks cost, USD

    • status_code
      Type: integer

      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_message
      Type: string

      general informational message you can find the full list of general informational messages here

    • tasks
      Type: array string[]

      array of tasks

    • tasks_count
      Type: integer

      the number of tasks in the tasks array

    • tasks_error
      Type: integer

      the number of tasks in the tasks array returned with an error

    • tasks.cost
      Type: number

      cost of the task, USD

    • tasks.data
      Type: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Type: string

      task identifier unique task identifier in our system in the UUID format

    • tasks.path
      Type: array string[]

      URL path

    • tasks.result
      Type: array string[]

      array of results

    • tasks.result_count
      Type: integer

      number of elements in the result array

    • tasks.result.connotation_types
      Type: object

      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"

    • tasks.result.countries
      Type: object

      countries contains countries and citation count in each country to obtain a full list of available countries, refer to the Locations endpoint

    • tasks.result.date
      Type: string

      date for which the data is provided

    • tasks.result.languages
      Type: object

      languages contains languages and citation count in each language to obtain a full list of available languages, refer to the Languages endpoint

    • tasks.result.page_categories
      Type: array string[]

      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

    • tasks.result.page_types
      Type: object

      page types contains page types and citation count per each page type

    • tasks.result.rank
      Type: integer

      rank of all URLs citing the keyword normalized sum of ranks of all URLs citing the target keyword for the given date

    • tasks.result.sentiment_connotations
      Type: object

      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"

    • tasks.result.text_categories
      Type: array string[]

      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

    • tasks.result.top_domains
      Type: array string[]

      top domains citing the target keyword contains objects with top domains citing the target keyword and citation count per each domain

    • tasks.result.total_count
      Type: integer

      total number of results in our database relevant to your request

    • tasks.result.type
      Type: string

      type of element = ‘content_analysis_trends’

    • tasks.status_code
      Type: integer

      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

    • tasks.status_message
      Type: string

      informational message of the task you can find the full list of general informational messages here

    • tasks.time
      Type: string

      execution time, seconds

    • time
      Type: string

      execution time, seconds

    • version
      Type: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/content_analysis/phrase_trends/live
curl https://openapi.felo.ai/v1/beta/dataforseo/content_analysis/phrase_trends/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keyword": "",
    "keyword_fields": {
      "title": "",
      "main_title": "",
      "previous_title": "",
      "snippet": ""
    },
    "page_type": [
      ""
    ],
    "search_mode": "",
    "internal_list_limit": 1,
    "date_from": "",
    "date_to": "",
    "date_group": "",
    "initial_dataset_filters": [],
    "rank_scale": "",
    "tag": ""
  }
]'

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.type": "string",
  "tasks.result.date": "string",
  "tasks.result.total_count": 1,
  "tasks.result.rank": 1,
  "tasks.result.top_domains": [
    "string"
  ],
  "tasks.result.sentiment_connotations": {},
  "tasks.result.connotation_types": {},
  "tasks.result.text_categories": [
    "string"
  ],
  "tasks.result.page_categories": [
    "string"
  ],
  "tasks.result.page_types": {},
  "tasks.result.countries": {},
  "tasks.result.languages": {}
}

Successful response

Content Analysis – Phrase Trends API