DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
Setting Apple App List Tasks
Queues one of the App Store's curated collections, chosen with app_collection, returning a task id. depth caps how far down the chart to read. Asynchronous: submit returns a task id in tasks[0].id and the fetch tool returns the result once ready. Retrieve with get_dataforseo_app_apple_app_list_fetch. No HTML variant exists on the Apple half.
- Type: array object[]
- Type: object
- appType: string
_collection requiredapp collection required field app collection on App Store from which apps will be collected; you can specify the following values: top_free_ios, top_paid_ios, top_grossing_ios, new_ios, new_free_ios, new_paid_ios
- appType: string
_category application category on the App Store optional field you can filter the results by app category; example: lifestyle; you can review the full list of available categories here or by making a separate request to https://api.dataforseo.com/v3/app_data/apple/categories
- depthType: integer
parsing depth optional field number of apps to be returned from the App Store SERP; we strongly recommend setting the parsing depth in the multiples of 100, because our system processes 100 results in a row; default value: 100 maximum value: 1000 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page.
- languageType: string
_code search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: en
- languageType: string
_name full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/app_data/apple/languages example: English
- locationType: integer
_code search engine location code required field if you don’t specify location_name if you use this field, you don’t need to specify location_name you can receive the list of available locations of the search engine with their location_code by making a separate request to https://api.dataforseo.com/v3/app_data/apple/locations example: 9061121
- locationType: string
_name full name of search engine location required field if you don’t specify location_code 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/app_data/apple/locations example: West Los Angeles,California,United States
- pingbackType: string
_url notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center
- postbackType: string
_data postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced
- postbackType: string
_url URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center
- priorityType: integer
task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.
- tagType: 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
Empty objectEmpty object- Empty object
- Type: object200
Successful response
- Type: numbercost
total tasks cost, USD
- Type: 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
- Type: stringstatus
_message general informational message you can find the full list of general informational messages here
- Type: array string[]tasks
array of tasks
- Type: integertasks
_count the number of tasks in the tasksarray
- Type: integertasks
_error the number of tasks in the tasks array returned with an error
- Type: numbertasks
.cost cost of the task, USD
- Type: objecttasks
.data contains the same parameters that you specified in the POST request
- Type: stringtasks
.id unique task identifier in our system in the Universally unique identifier (UUID) format
- Type: array string[]tasks
.path URL path
- Type: array string[]tasks
.result array of results in this case, the value will be null
- Type: integertasks
.result _count number of elements in the result array
- Type: integertasks
.status _code status code of the task generated by DataForSEO; can be within the following range: 10000-60000
- Type: stringtasks
.status _message informational message of the task
- Type: stringtasks
.time execution time, seconds
- Type: stringtime
execution time, seconds
- Type: 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/app_data/apple/app_list/task_post \
--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"
]
}