DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
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.
- Тип: array object[]
- Тип: object
- appТип: string
_id обязательно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
- filtersТип: array
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
- languageТип: string
_code 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
- languageТип: string
_name 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
- limitТип: integer
the maximum number of returned apps optional field default value: 100 maximum value: 1000
- locationТип: integer
_code 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
- locationТип: string
_name 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
- offsetТип: integer
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
- orderТип: array string[]
_by 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
- 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
Пустой объектПустой объект
- Тип: object200
Successful response
- Тип: numbercost
total tasks cost, USD
- Тип: integerstatus
_code 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
- Тип: stringstatus
_message general informational message you can find the full list of general informational messages here
- Тип: array string[]tasks
array of tasks
- Тип: integertasks
_count the number of tasks in the tasks array
- Тип: integertasks
_error the number of tasks in the tasks array returned with an error
- Тип: numbertasks
.cost cost of the task, USD
- Тип: objecttasks
.data contains the same parameters that you specified in the POST request
- Тип: stringtasks
.id task identifier unique task identifier in our system in the UUID format
- Тип: array string[]tasks
.path URL path
- Тип: array string[]tasks
.result array of results
- Тип: integertasks
.result _count number of elements in the result array
- Тип: stringtasks
.result .app _id id of the app in a POST array
- Тип: array string[]tasks
.result .items contains data related to the app_id and competitor applications
- Тип: integertasks
.result .items _count the number of results returned in the items array
- Тип: stringtasks
.result .items .app _id id of the competitor app
- Тип: numbertasks
.result .items .avg _position 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
- Тип: objecttasks
.result .items .competitor _metrics 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
- Тип: objecttasks
.result .items .competitor _metrics .app _store _search _organic ranking data from App Store organic search
- Тип: integertasks
.result .items .competitor _metrics .app _store _search _organic .count total count of organic SERPs that contain the competitor app
- Тип: integertasks
.result .items .competitor _metrics .app _store _search _organic .pos _1 number of SERPs where the competitor app ranks #1 in organic results
- Тип: integertasks
.result .items .competitor _metrics .app _store _search _organic .pos _11 _100 number of SERPs where the competitor app ranks #11-100 in organic results
- Тип: integertasks
.result .items .competitor _metrics .app _store _search _organic .pos _2 _3 number of SERPs where the competitor app ranks #2-3 in organic results
- Тип: integertasks
.result .items .competitor _metrics .app _store _search _organic .pos _4 _10 number of SERPs where the competitor app ranks #4-10 in organic results
- Тип: integertasks
.result .items .competitor _metrics .app _store _search _organic .search _volume total search volume of the intersecting keywords in App Store organic SERP
- Тип: objecttasks
.result .items .full _metrics metrics for all keywords of the application full overview of ranking data relevant to all keywords that the provided app_id is ranking for
- Тип: objecttasks
.result .items .full _metrics .app _store _search _organic ranking data from App Store organic search
- Тип: integertasks
.result .items .full _metrics .app _store _search _organic .count total count of organic SERPs that contain the competitor app
- Тип: integertasks
.result .items .full _metrics .app _store _search _organic .pos _1 number of SERPs where the competitor app ranks #1 in organic results
- Тип: integertasks
.result .items .full _metrics .app _store _search _organic .pos _11 _100 number of SERPs where the competitor app ranks #11-100 in organic results
- Тип: integertasks
.result .items .full _metrics .app _store _search _organic .pos _2 _3 number of SERPs where the competitor app ranks #2-3 in organic results
- Тип: integertasks
.result .items .full _metrics .app _store _search _organic .pos _4 _10 number of SERPs where the competitor app ranks #4-10 in organic results
- Тип: integertasks
.result .items .full _metrics .app _store _search _organic .search _volume total search volume of the app’s ranking keywords in App Store organic SERP
- Тип: integertasks
.result .items .intersections number of intersecting keywords
- Тип: stringtasks
.result .items .se _type search engine type
- Тип: integertasks
.result .items .sum _position 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
- Тип: stringtasks
.result .language _code language code in a POST array
- Тип: integertasks
.result .location _code location code in a POST array
- Тип: stringtasks
.result .se _type search engine type
- Тип: integertasks
.result .total _count total amount of results in our database relevant to your request
- Тип: integertasks
.status _code 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
- Тип: stringtasks
.status _message informational message of the task you can find the full list of general informational messages here
- Тип: stringtasks
.time execution time, seconds
- Тип: stringtime
execution time, seconds
- Тип: stringversion
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.
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/apple/app_competitors/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{},
{}
]'
{
"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.se_type": "string",
"tasks.result.app_id": "string",
"tasks.result.location_code": 1,
"tasks.result.language_code": "string",
"tasks.result.total_count": 1,
"tasks.result.items_count": 1,
"tasks.result.items": [
"string"
],
"tasks.result.items.se_type": "string",
"tasks.result.items.app_id": "string",
"tasks.result.items.avg_position": 1,
"tasks.result.items.sum_position": 1,
"tasks.result.items.intersections": 1,
"tasks.result.items.competitor_metrics": {},
"tasks.result.items.competitor_metrics.app_store_search_organic": {},
"tasks.result.items.competitor_metrics.app_store_search_organic.pos_1": 1,
"tasks.result.items.competitor_metrics.app_store_search_organic.pos_2_3": 1,
"tasks.result.items.competitor_metrics.app_store_search_organic.pos_4_10": 1,
"tasks.result.items.competitor_metrics.app_store_search_organic.pos_11_100": 1,
"tasks.result.items.competitor_metrics.app_store_search_organic.count": 1,
"tasks.result.items.competitor_metrics.app_store_search_organic.search_volume": 1,
"tasks.result.items.full_metrics": {},
"tasks.result.items.full_metrics.app_store_search_organic": {},
"tasks.result.items.full_metrics.app_store_search_organic.pos_1": 1,
"tasks.result.items.full_metrics.app_store_search_organic.pos_2_3": 1,
"tasks.result.items.full_metrics.app_store_search_organic.pos_4_10": 1,
"tasks.result.items.full_metrics.app_store_search_organic.pos_11_100": 1,
"tasks.result.items.full_metrics.app_store_search_organic.count": 1,
"tasks.result.items.full_metrics.app_store_search_organic.search_volume": 1
}