データ API / DataForSEO / DataForSEO Labs
App Store App Competitors Live
App Store apps competing with a given app on shared keywords. 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_competitors_live.
パラメータ
パス・クエリ・ヘッダーのパラメータはありません。
リクエストボディ
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: ["intersections",">",500] [["competitor_metrics.app_store_search_organic.pos_1","",10],"and",["avg_position",">=","10"]] [[["intersections",">=",50],"and",["competitor_metrics.app_store_search_organic.pos_1","in",[1,5]]], "or", ["sum_position",">=","10000"]] 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: ["intersections,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: ["intersections,desc","sum_position,asc"] default rule: ["intersections,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 apps optional field default value: 100 maximum value: 1000
offsetinteger任意offset in the results array of returned apps optional field default value: 0 if you specify the 10 value, the first ten apps 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/app_competitors/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 app_id and competitor applications
se_typestring任意search engine type
app_idstring任意id of the competitor app
avg_positionnumber任意average position of the app in App Store SERP Note: average position is calculated for intersected keywords only; the value for a given application may differ when combined with different target applications
sum_positioninteger任意sum of all app positions in App Store SERP Note: sum position is calculated for intersected keywords only; the value for a given application may differ when combined with different target applications
intersectionsinteger任意number of intersecting keywords
competitor_metricsobject任意metrics for intersecting keywords ranking data relevant to the keywords that the provided competitor application shares with the app in a POST request; note: in this array ranking data is provided for the returned competitor’s app_id
app_store_search_organicobject任意ranking data from App Store organic search
pos_1integer任意number of SERPs where the competitor app ranks #1 in organic results
pos_2_3integer任意number of SERPs where the competitor app ranks #2-3 in organic results
pos_4_10integer任意number of SERPs where the competitor app ranks #4-10 in organic results
pos_11_100integer任意number of SERPs where the competitor app ranks #11-100 in organic results
countinteger任意total count of organic SERPs that contain the competitor app
search_volumeinteger任意total search volume of the intersecting keywords in App Store organic SERP
full_metricsobject任意metrics for all keywords of the application full overview of ranking data relevant to all keywords that the provided app_id is ranking for
app_store_search_organicobject任意ranking data from App Store organic search
pos_1integer任意number of SERPs where the competitor app ranks #1 in organic results
pos_2_3integer任意number of SERPs where the competitor app ranks #2-3 in organic results
pos_4_10integer任意number of SERPs where the competitor app ranks #4-10 in organic results
pos_11_100integer任意number of SERPs where the competitor app ranks #11-100 in organic results
countinteger任意total count of organic SERPs that contain the competitor app
search_volumeinteger任意total search volume of the app’s ranking keywords in App Store organic SERP