Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"location_code": 2840,
"limit": 10
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"limit": 10,
"location_code": 2840
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live"
payload = [
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"limit": 10,
"location_code": 2840
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
app_ids: {'1': '686449807', '2': '382617920'},
language_name: 'English',
limit: 10,
location_code: 2840
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'app_ids' => [
'1' => '686449807',
'2' => '382617920'
],
'language_name' => 'English',
'limit' => 10,
'location_code' => 2840
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live"
payload := strings.NewReader("[\n {\n \"app_ids\": {\n \"1\": \"686449807\",\n \"2\": \"382617920\"\n },\n \"language_name\": \"English\",\n \"limit\": 10,\n \"location_code\": 2840\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"app_ids\": {\n \"1\": \"686449807\",\n \"2\": \"382617920\"\n },\n \"language_name\": \"English\",\n \"limit\": 10,\n \"location_code\": 2840\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"app_ids\": {\n \"1\": \"686449807\",\n \"2\": \"382617920\"\n },\n \"language_name\": \"English\",\n \"limit\": 10,\n \"location_code\": 2840\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"app_ids": {},
"items": [
{
"intersection_result": {},
"keyword_data": {
"avg_backlinks_info": {
"backlinks": 123,
"dofollow": 123,
"last_updated_time": "<string>",
"main_domain_rank": 123,
"rank": 123,
"referring_domains": 123,
"referring_main_domains": 123,
"referring_pages": 123,
"se_type": "<string>"
},
"clickstream_keyword_info": {
"age_distribution": {},
"gender_distribution": {},
"last_updated_time": "<string>",
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"search_volume": 123
},
"keyword": "<string>",
"keyword_info": {
"categories": [
123
],
"competition": 123,
"competition_level": "<string>",
"cpc": 123,
"high_top_of_page_bid": 123,
"last_updated_time": "<string>",
"low_top_of_page_bid": 123,
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"se_type": "<string>",
"search_volume": 123,
"search_volume_trend": {
"monthly": 123,
"quarterly": 123,
"yearly": 123
}
},
"keyword_info_normalized_with_bing": {
"is_normalized": true,
"last_updated_time": "<string>",
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"search_volume": 123
},
"keyword_info_normalized_with_clickstream": {
"is_normalized": true,
"last_updated_time": "<string>",
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"search_volume": 123
},
"keyword_properties": {
"core_keyword": "<string>",
"detected_language": "<string>",
"is_another_language": true,
"keyword_difficulty": 123,
"se_type": "<string>",
"synonym_clustering_algorithm": "<string>",
"words_count": 123
},
"language_code": "<string>",
"location_code": 123,
"se_type": "<string>",
"search_intent_info": {
"foreign_intent": [
"<string>"
],
"last_updated_time": "<string>",
"main_intent": "<string>",
"se_type": "<string>"
},
"serp_info": {
"check_url": "<string>",
"last_updated_time": "<string>",
"previous_updated_time": "<string>",
"se_results_count": 123,
"se_type": "<string>",
"serp_item_types": [
"<string>"
]
}
},
"se_type": "<string>"
}
],
"items_count": 123,
"language_code": "<string>",
"location_code": 123,
"se_type": "<string>",
"total_count": 123
}
]
}
]
}Apple
App Store App Intersection Live
The keywords two or more App Store apps both rank for.
POST
https://api.aisa.one
/
apis
/
v1
/
dataforseo
/
dataforseo_labs
/
apple
/
app_intersection
/
live
Reference example
# Fixed reference example. Playground inputs do not update this sample.
curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '[
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"location_code": 2840,
"limit": 10
}
]'curl --request POST \
--url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
[
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"limit": 10,
"location_code": 2840
}
]
'import requests
url = "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live"
payload = [
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"limit": 10,
"location_code": 2840
}
]
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify([
{
app_ids: {'1': '686449807', '2': '382617920'},
language_name: 'English',
limit: 10,
location_code: 2840
}
])
};
fetch('https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'app_ids' => [
'1' => '686449807',
'2' => '382617920'
],
'language_name' => 'English',
'limit' => 10,
'location_code' => 2840
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live"
payload := strings.NewReader("[\n {\n \"app_ids\": {\n \"1\": \"686449807\",\n \"2\": \"382617920\"\n },\n \"language_name\": \"English\",\n \"limit\": 10,\n \"location_code\": 2840\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("[\n {\n \"app_ids\": {\n \"1\": \"686449807\",\n \"2\": \"382617920\"\n },\n \"language_name\": \"English\",\n \"limit\": 10,\n \"location_code\": 2840\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"app_ids\": {\n \"1\": \"686449807\",\n \"2\": \"382617920\"\n },\n \"language_name\": \"English\",\n \"limit\": 10,\n \"location_code\": 2840\n }\n]"
response = http.request(request)
puts response.read_body{
"cost": 123,
"status_code": 123,
"status_message": "<string>",
"tasks_count": 123,
"tasks_error": 123,
"time": "<string>",
"version": "<string>",
"tasks": [
{
"cost": 123,
"data": {},
"id": "<string>",
"path": [
"<string>"
],
"result_count": 123,
"status_code": 123,
"status_message": "<string>",
"time": "<string>",
"result": [
{
"app_ids": {},
"items": [
{
"intersection_result": {},
"keyword_data": {
"avg_backlinks_info": {
"backlinks": 123,
"dofollow": 123,
"last_updated_time": "<string>",
"main_domain_rank": 123,
"rank": 123,
"referring_domains": 123,
"referring_main_domains": 123,
"referring_pages": 123,
"se_type": "<string>"
},
"clickstream_keyword_info": {
"age_distribution": {},
"gender_distribution": {},
"last_updated_time": "<string>",
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"search_volume": 123
},
"keyword": "<string>",
"keyword_info": {
"categories": [
123
],
"competition": 123,
"competition_level": "<string>",
"cpc": 123,
"high_top_of_page_bid": 123,
"last_updated_time": "<string>",
"low_top_of_page_bid": 123,
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"se_type": "<string>",
"search_volume": 123,
"search_volume_trend": {
"monthly": 123,
"quarterly": 123,
"yearly": 123
}
},
"keyword_info_normalized_with_bing": {
"is_normalized": true,
"last_updated_time": "<string>",
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"search_volume": 123
},
"keyword_info_normalized_with_clickstream": {
"is_normalized": true,
"last_updated_time": "<string>",
"monthly_searches": [
{
"month": 123,
"search_volume": 123,
"year": 123
}
],
"search_volume": 123
},
"keyword_properties": {
"core_keyword": "<string>",
"detected_language": "<string>",
"is_another_language": true,
"keyword_difficulty": 123,
"se_type": "<string>",
"synonym_clustering_algorithm": "<string>",
"words_count": 123
},
"language_code": "<string>",
"location_code": 123,
"se_type": "<string>",
"search_intent_info": {
"foreign_intent": [
"<string>"
],
"last_updated_time": "<string>",
"main_intent": "<string>",
"se_type": "<string>"
},
"serp_info": {
"check_url": "<string>",
"last_updated_time": "<string>",
"previous_updated_time": "<string>",
"se_results_count": 123,
"se_type": "<string>",
"serp_item_types": [
"<string>"
]
}
},
"se_type": "<string>"
}
],
"items_count": 123,
"language_code": "<string>",
"location_code": 123,
"se_type": "<string>",
"total_count": 123
}
]
}
]
}The keywords two or more App Store apps both rank for. Pages with
Set this endpoint up in your agent →
limit, offset and offset_token; use the token past the first pages. This family is the one to reach for by default: the google_ads endpoints in seo-keywords answer similar questions but return megabytes with no way to cap them, where this one takes a limit. 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.
Example
curl -X POST "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '[{"app_ids": "...", "location_name": "...", "location_code": "..."}]'
// Copy this whole block into Claude Code, Codex, Cursor or any coding agent.
// It carries everything needed to connect, authorize and run this example —
// no key to paste, one click of Allow in the browser.
{
"calls": [
{
"call_id": "1",
"tool": "post_dataforseo_labs_apple_app_intersection_live",
"arguments": {}
}
]
}
// ── for the agent ─────────────────────────────────────────────────────────
// Register the AIsa MCP server, then call its `batch_quote` tool with the JSON above.
// name aisa
// endpoint https://mcp.aisa.one/mcp
// transport streamable-http
// auth OAuth. The server publishes RFC 9728 metadata, so open a
// browser and the user clicks Allow once — nothing to paste.
// If AISA_API_KEY is set, send it as a bearer header instead.
// Use your own MCP mechanism, not a hand-edited config file:
// Codex codex mcp add aisa --url https://mcp.aisa.one/mcp
// Claude Code claude mcp add --transport http -s user aisa https://mcp.aisa.one/mcp
// Cursor / VS Code a "url" entry for https://mcp.aisa.one/mcp in the MCP config
// The server reaches https://mcp.aisa.one/servers worth of APIs through a few meta
// tools: search, list_categories, get_details, batch_quote, batch_use.
// search, get_details and batch_quote are free; batch_use is billed per
// call. This operation's full contract — every argument, the response
// shape, the price and the pitfalls — is at
// https://aisa.one/docs/api-reference/dataforseo/post_dataforseo-dataforseo-labs-apple-app-intersection-live.md
// Show me the quoted cost. Once I approve, run the same calls with
// batch_use and show me the result.
First time? Point any MCP client at
https://mcp.aisa.one/mcp — Claude
Code, Codex, Cursor, VS Code and the rest. Authorization is OAuth: the client
opens a browser, you click Allow once, and there is no key to paste. Your
agent then reaches every endpoint through a few meta tools: search,
list_categories, get_details and batch_quote are free, batch_use is
billed per call. Setup per client is in
Connect via MCP; the live tool list and what each call
costs are on aisa.one/mcp.Request contract
- Method and path: POST /apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live
- Availability: enabled
- Request URL template: https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live
- Runtime facts: 6ab8fec17df1d5dcdff2e036dd1eb40587752b774ec040ab4eb0cc6946c3dd3c
{
"operationId": "post_dataforseo_labs_apple_app_intersection_live",
"method": "POST",
"path": "/apis/v1/dataforseo/dataforseo_labs/apple/app_intersection/live",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": [
{
"app_ids": {
"1": "686449807",
"2": "382617920"
},
"language_name": "English",
"limit": 10,
"location_code": 2840
}
],
"items": {
"oneOf": [
{
"properties": {
"app_ids": {
"additionalProperties": {
"type": [
"string",
"null"
]
},
"description": "<em>ids of the target apps</em><br><strong>required field</strong><br>IDs of the target mobile applications on App Store;<br>you can find the ID in the URL of every app listed on App Store;<br>example:<br>in the URL <code>https://apps.apple.com/us/app/id835599320</code><br>the id is <code>835599320</code>;<br>the ids should be specified the following way:<br>`\"app_ids\": {<br>\"1\": \"686449807\",<br>\"2\": \"382617920\"<br>}`<br>if you specify a single ID here, the API will return results only for one application;<br>the maximum number of app IDs you can specify in this object is <code>20</code>",
"type": [
"object",
"null"
]
},
"filters": {
"description": "<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code><</code>, <code><=</code>, <code>></code>, <code>>=</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code><br>example:<br><code>[\"keyword_data.keyword_info.search_volume\",\">\",500]</code><p><code>[[\"keyword_data.keyword_info.search_volume\",\"<>\",500],\"and\",[intersection_result.382617920.rank_group\",\">=\",\"10\"]]</code><p>for more information about filters, please refer to <a href=\"/v3/dataforseo_labs/filters\" target=\"_blank\" rel=\"noopener noreferrer\">Dataforseo Labs - Filters</a> or this <a href=\"https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api\" rel=\"noopener noreferrer\" target=\"_blank\">help center guide</a>",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
},
"type": [
"array",
"null"
]
},
"language_code": {
"description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en</code>",
"type": [
"string",
"null"
]
},
"language_name": {
"description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>Note:</strong> it is required to specify either <code>language_name</code> or <code>language_code</code><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English</code>",
"type": "string"
},
"limit": {
"description": "<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>",
"type": [
"integer",
"null"
]
},
"location_code": {
"description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840</code>",
"type": "integer"
},
"location_name": {
"description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code><br><strong>Note:</strong> it is required to specify either <code>location_name</code> or <code>location_code</code><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States</code>",
"type": "string"
},
"offset": {
"description": "<em>offset in the results array of returned keywords</em><br>optional field<br>default value: <code>0</code><br>if you specify the <code>10</code> value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
"type": [
"integer",
"null"
]
},
"order_by": {
"description": "<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results;<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order;<br><code>desc</code> - results will be sorted in the descending order;<br>you should use a comma to specify a sorting type;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,asc\"]</code><br><strong>Note:</strong> you can set no more than three sorting rules in a single request;<br>you should use a comma to separate several sorting rules;<br>example:<br><code>[\"intersection_result.382617920.rank_absolute,desc\",\"keyword_data.keyword_info.search_volume,asc\"]</code><br>default rule:<br><code>[\"keyword_data.keyword_info.search_volume,desc\"]</code><br><strong>Note:</strong> if the <code>item_types</code> array contains item types that are different from <code>organic</code>, the results will be ordered by the first item type in the array",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"tag": {
"description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
"type": [
"string",
"null"
]
}
},
"type": "object"
}
],
"type": [
"object",
"null"
]
},
"type": "array"
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_usd",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"default_request_estimate_usd": 0.1356,
"estimate_source": "profile_seed",
"evidence_source": "response_body"
},
"components": {
"schemas": {
"Provider0A3E90081762_AisaDataforseoFilterJsonValue": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": [
"object",
"null"
]
},
{
"items": {
"$ref": "#/components/schemas/Provider0A3E90081762_AisaDataforseoFilterJsonValue"
},
"type": "array"
}
],
"description": "JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator."
}
},
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
Usage-based billing; Default request estimate: $0.1356 USD (not a fixed price). Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Default request reference estimate (USD): 0.1356
- Cost contract: response_usd
- Published reference multiplier: 1.0
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
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": {<br>"1": "686449807",<br>"2": "382617920"<br>}
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
Show child attributes
Show child attributes
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
JSON representation of filter values and nested expressions. Field names, operators, condition counts and operand compatibility remain provider-validated as documented for each endpoint; this is not a complete filter-language validator.
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
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
the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000
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
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 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
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
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:
[
{
"app_ids": { "1": "686449807", "2": "382617920" },
"language_name": "English",
"limit": 10,
"location_code": 2840
}
]
Response
object | null
Successful operation
total tasks cost, USD
general status code you can find the full list of the response codes here
general informational message you can find the full list of general informational messages here
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
total execution time, seconds
the current version of the API
array of tasks
Show child attributes
Show child attributes