数据 API / DataForSEO / DataForSEO Labs

App Store Keywords For App Live

The keywords an App Store app ranks for. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. The Google Play twin is post_dataforseo_labs_google_keywords_for_app_live; the two stores' keyword sets rarely match, which is the reason to run both.

参数

没有路径、查询或请求头参数。

请求体

app_idstring必填
id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320
location_namestring可选
full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States
location_codeinteger可选
location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840
language_namestring可选
full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English
language_codestring可选
language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en
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: , , >, >=, =, , in, not_in example: ["keyword_data.keyword_info.search_volume",">",500] [["keyword_data.keyword_info.search_volume","",500],"and",["ranked_serp_element.serp_item.rank_group",">=","10"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
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 specify a sorting type; example: ["ranked_serp_element.serp_item.rank_group,asc"] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: ["ranked_serp_element.serp_item.rank_group,desc","keyword_data.keyword_info.search_volume,asc"] default rule: ["keyword_data.keyword_info.search_volume,desc"] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array
limitinteger可选
the maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetinteger可选
offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
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/dataforseo_labs/apple/keywords_for_app/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "app_id": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "limit": 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
se_typestring可选
search engine type
app_idstring可选
id of the app in a POST array
location_codeinteger可选
location code in a POST array
language_codestring可选
language code in a POST array
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 data related to the ranking keywords for the app specified in the app_id field
se_typestring可选
search engine type
keyword_dataobject可选
keyword data for the returned keyword
se_typestring可选
search engine type
keywordstring可选
returned keyword
location_codeinteger可选
location code in a POST array
language_codestring可选
language code in a POST array
keyword_infoobject可选
keyword info for the returned keyword
se_typestring可选
search engine type
last_updated_timestring可选
date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: 2019-11-15 12:57:46 +00:00
competitionnumber可选
competition represents the relative amount of competition associated with the given keyword; the value is based on Google Ads data and can be between 0 and 1 (inclusive); in this case, will equal null
competition_levelstring可选
competition level represents the relative level of competition associated with the given keyword in paid SERP only; possible values: LOW, MEDIUM, HIGH if competition level is unknown, the value is null; learn more about the metric in this help center article; in this case, will equal null
cpcnumber可选
cost-per-click represents the average cost per click (USD) historically paid for the keyword; in this case, will equal null
search_volumeinteger可选
average monthly search volume rate represents the (approximate) number of searches for the given keyword on App Store
low_top_of_page_bidnumber可选
minimum bid for the ad to be displayed at the top of the first page indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request; in this case, will equal null
high_top_of_page_bidnumber可选
maximum bid for the ad to be displayed at the top of the first page indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request; in this case, will equal null
categoriesstring[]可选
product and service categories you can download the full list of possible categories; in this case, will equal null
monthly_searchesstring[]可选
monthly searches represents the (approximate) number of searches for this keyword (as available for the past twelve months), targeted to the specified geographic locations; in this case, will equal null
ranked_serp_elementobject可选
contains data on the domain’s SERP element found for the returned keyword
se_typestring可选
search engine type
serp_itemstring[]可选
contains data on the SERP element the list of supported SERP elements can be found below
typestring可选
type of the SERP element possible values: app_store_search_organic
rank_groupinteger可选
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteinteger可选
absolute rank in SERP absolute position among all the elements in SERP
positionstring可选
the alignment of the element in SERP can take the following values: left, right
app_idstring可选
id of the app
titlestring可选
title of the app
urlstring可选
URL to the app page on App Store
iconstring可选
URL to the app icon
reviews_countinteger可选
the total number of reviews of the app
ratingobject可选
average rating of the app
rating_typestring可选
the type of the rating can take the following values: Max5
valuenumber可选
the value of the rating
votes_countinteger可选
the amount of feedback in this case, the value will be null
rating_maxinteger可选
the maximum value for a rating_type the maximum value for Max5 is 5
is_freeboolean可选
indicates whether the app is free
currentnumber可选
current price refers to the current price indicated in the element
regularnumber可选
regular price refers to the regular price indicated in the element
max_valuenumber可选
the maximum price refers to the maximum price indicated in the element
currencystring可选
currency of the listed price ISO code of the currency applied to the price
is_price_rangeboolean可选
price is provided as a range indicates whether a price is provided in a range
displayed_pricestring可选
price string in the result raw price string as provided in the result
check_urlstring可选
direct URL to search engine results you can use it to make sure that we provided accurate results
se_results_countstring可选
number of search results for the returned keyword
last_updated_timestring可选
date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
previous_updated_timestring可选
previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00; in this case, will equal null