Data API / DataForSEO / DataForSEO Labs

App Store App Intersection Live

The keywords two or more App Store apps both rank 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. Google Play twin: post_dataforseo_labs_google_app_intersection_live.

Parameters

No path, query, or header parameters.

Request body

app_idsobjectRequired
ids of the target apps required field IDs of the target mobile applications 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; the ids should be specified the following way: "app_ids": { "1": "686449807", "2": "382617920" } if you specify a single ID here, the API will return results only for one application; the maximum number of app IDs you can specify in this object is 20
location_namestringOptional
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_codeintegerOptional
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_namestringOptional
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_codestringOptional
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
filtersarrayOptional
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",[intersection_result.382617920.rank_group",">=","10"]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Optional
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: ["intersection_result.382617920.rank_absolute,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: ["intersection_result.382617920.rank_absolute,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
limitintegerOptional
the maximum number of returned keywords optional field default value: 100 maximum value: 1000
offsetintegerOptional
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
tagstringOptional
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

Example request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/apple/app_intersection/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "app_ids": {},
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "limit": 0
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
se_typestringOptional
search engine type
app_idsobjectOptional
ids of the apps in a POST array
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
total_countintegerOptional
total amount of results in our database relevant to your request
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
contains data related to the ranking keywords for the app specified in the app_id field
se_typestringOptional
search engine type
keyword_dataobjectOptional
keyword data for the returned keyword
se_typestringOptional
search engine type
keywordstringOptional
returned keyword
location_codeintegerOptional
location code in a POST array
language_codestringOptional
language code in a POST array
keyword_infoobjectOptional
keyword info for the returned keyword
se_typestringOptional
search engine type
last_updated_timestringOptional
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
competitionnumberOptional
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_levelstringOptional
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
cpcnumberOptional
cost-per-click represents the average cost per click (USD) historically paid for the keyword; in this case, will equal null
search_volumeintegerOptional
average monthly search volume rate represents the (approximate) number of searches for the given keyword on App Store
low_top_of_page_bidnumberOptional
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_bidnumberOptional
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[]Optional
product and service categories you can download the full list of possible categories; in this case, will equal null
monthly_searchesstring[]Optional
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
serp_infoobjectOptional
SERP data the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database
se_typestringOptional
search engine type search engine type specified in a POST request; for this endpoint, the field equals bing
check_urlstringOptional
direct URL to search engine results you can use it to make sure that we provided accurate results
serp_item_typesstring[]Optional
types of search results in SERP contains types of search results (items) found in SERP; in this case, will equal null
se_results_countstringOptional
number of search results for the returned keyword
last_updated_timestringOptional
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_timestringOptional
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
intersection_resultobjectOptional
contains SERP data for the returned keyword data will be provided in separate arrays for each app ID you specified in the app_ids object when setting a task; depending on the number of specified app IDs, it can contain from 1 to 20 arrays named respectively
1objectOptional
contains SERP data for the respective app ID field name varies in the range from 1 to 20 according to the number of app IDs in the app_ids object; possible types of SERP elements: app_store_search_organic
typestringOptional
type of the SERP element possible values: app_store_search_organic
rank_groupintegerOptional
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteintegerOptional
absolute rank in SERP absolute position among all the elements in SERP
positionstringOptional
the alignment of the element in SERP can take the following values: left, right
app_idstringOptional
id of the app
titlestringOptional
title of the app
urlstringOptional
URL to the app page on App Store
iconstringOptional
URL to the app icon
reviews_countintegerOptional
the total number of reviews of the app
ratingobjectOptional
average rating of the app
rating_typestringOptional
the type of the rating can take the following values: Max5
valuenumberOptional
the value of the rating
votes_countintegerOptional
the amount of feedback in this case, the value will be null
rating_maxintegerOptional
the maximum value for a rating_type the maximum value for Max5 is 5
is_freebooleanOptional
indicates whether the app is free
currentnumberOptional
current price refers to the current price indicated in the element
regularnumberOptional
regular price refers to the regular price indicated in the element
max_valuenumberOptional
the maximum price refers to the maximum price indicated in the element
currencystringOptional
currency of the listed price ISO code of the currency applied to the price
is_price_rangebooleanOptional
price is provided as a range indicates whether a price is provided in a range
displayed_pricestringOptional
price string in the result raw price string as provided in the result