v0.1.0-beta

OpenAPI 3.1.0

Setting Live ‘DataForSEO Trends Explore’ Tasks

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клиентские библиотеки

Shell Curl

DataForSEO

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

DataForSEO Операции

post/v1/beta/dataforseo/keywords_data/dataforseo_trends/explore/live

Setting Live ‘DataForSEO Trends Explore’ Tasks

Interest over time for up to five keywords, the Google Trends curve. Returns keywords, type, location_code, language_code, datetime, items_count and items. type selects web, news, images, youtube or shopping, and date_from/date_to set the window. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. Trends gives relative interest, not absolute volume; for counts use post_dataforseo_keywords_gads_search_volume_live.

Тело

обязательно

application/json

Тип: array object[]
- keywords
  Тип: array string[]
  обязательно
  
  keywords required field the maximum number of keywords you can specify: 5 learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
- date_from
  Тип: string
  
  starting date of the time range optional field if you don’t specify this field, the current day and month of the preceding year will be used by default minimal value for the web type: 2004-01-01 minimal value for other types: 2008-01-01 date format: "yyyy-mm-dd" example: "2019-01-15"
- date_to
  Тип: string
  
  ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: "yyyy-mm-dd" example: "2019-01-15"
- location_code
  Тип: integer
  
  search engine location code optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engines with their location_code by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations note that the data will be provided for the country the specified location_code belongs to; example: 2840
- location_name
  Тип: string
  
  full name of search engine location optional field if you don’t use this field, you will recieve global results if you use this field, you don’t need to specify location_code you can receive the list of available locations of the search engine with their location_name by making a separate request to https://api.dataforseo.com/v3/keywords_data/dataforseo_trends/locations note that the data will be provided for the country the specified location_name belongs to; example: United Kingdom
- tag
  Тип: 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
- time_range
  Тип: string
  
  preset time ranges optional field if you specify date_from or date_to parameters, this field will be ignored when setting a task possible values for all type parameters: past_4_hours, past_day, past_7_days, past_30_days, past_90_days, past_12_months, past_5_years
- type
  Тип: string
  
  dataforseo trends type optional field if you don’t specify this field, the web type will be used by default possible values: web, news, ecommerce

Ответы

200
Тип: object

Successful response
cost
Тип: number

total tasks cost, USD

status_code
Тип: 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
Тип: string

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

tasks
Тип: array string[]

array of tasks

tasks_count
Тип: integer

the number of tasks in the tasks array

tasks_error
Тип: integer

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

tasks.cost
Тип: number

cost of the task, USD

tasks.data
Тип: object

contains the same parameters that you specified in the POST request

tasks.id
Тип: string

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

tasks.path
Тип: array string[]

URL path

tasks.result
Тип: array string[]

array of results

tasks.result_count
Тип: integer

number of elements in the result array

tasks.result.datetime
Тип: string

date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00

tasks.result.items
Тип: array string[]

contains keyword popularity and related data

tasks.result.items_count
Тип: integer

the number of results returned in the items array

tasks.result.items.averages
Тип: array string[]

keyword popularity values averaged over the whole time range

tasks.result.items.data
Тип: array string[]

DataForSEO Trends data for the specified parameters

tasks.result.items.data.date_from
Тип: string

start date of the corresponding time range in the UTC format: “yyyy-mm-dd”

tasks.result.items.data.date_to
Тип: string

end date of the corresponding time range in the UTC format: “yyyy-mm-dd”

tasks.result.items.data.timestamp
Тип: integer

a point in time in the Unix time format

tasks.result.items.data.values
Тип: array string[]

relative keyword popularity rate at a specific timestamp represents the keyword popularity rate over the given time range if you specify more than one keyword, the values will be averaged to the highest value across all specified keywords a value of 100 is the peak popularity for the term. A value of 50 means that the term is half as popular. A score of 0 means there was not enough data for this term

tasks.result.items.keywords
Тип: array string[]

relevant keywords the data included in the dataforseo_trends_graph element is based on the keywords listed in this array

tasks.result.items.position
Тип: integer

the alignment of the element can take the following values: 1, 2, 3, 4, etc.

tasks.result.items.type
Тип: string

type of element = ‘dataforseo_trends_graph’

tasks.result.keywords
Тип: array string[]

keywords in a POST array

tasks.result.language_code
Тип: string

language code in a POST array if there is no data, then the value is null

tasks.result.location_code
Тип: integer

location code in a POST array if there is no data, then the value is null

tasks.result.type
Тип: array string[]

search engine type in a POST array

tasks.status_code
Тип: integer

status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of response codes here

tasks.status_message
Тип: string

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

tasks.time
Тип: string

execution time, seconds

time
Тип: string

execution time, seconds

version
Тип: 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.

post/v1/beta/dataforseo/keywords_data/dataforseo_trends/explore/live

curl https://openapi.felo.ai/v1/beta/dataforseo/keywords_data/dataforseo_trends/explore/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "keywords": [
      ""
    ],
    "location_name": "",
    "location_code": 1,
    "type": "",
    "date_from": "",
    "date_to": "",
    "time_range": "",
    "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.keywords": [
    "string"
  ],
  "tasks.result.type": [
    "string"
  ],
  "tasks.result.location_code": 1,
  "tasks.result.language_code": "string",
  "tasks.result.datetime": "string",
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.position": 1,
  "tasks.result.items.type": "string",
  "tasks.result.items.keywords": [
    "string"
  ],
  "tasks.result.items.data": [
    "string"
  ],
  "tasks.result.items.data.date_from": "string",
  "tasks.result.items.data.date_to": "string",
  "tasks.result.items.data.timestamp": 1,
  "tasks.result.items.data.values": [
    "string"
  ],
  "tasks.result.items.averages": [
    "string"
  ]
}

Successful response

Setting Live ‘DataForSEO Trends Explore’ Tasks

АутентификацияRequired

DataForSEO

Setting Live ‘DataForSEO Trends Explore’ Tasks