{"id":14631,"date":"2022-06-24T15:25:45","date_gmt":"2022-06-24T15:25:45","guid":{"rendered":"https:\/\/docs_v3.dataforseo.com\/v3\/?page_id=14631"},"modified":"2026-07-28T19:26:46","modified_gmt":"2026-07-28T19:26:46","slug":"dataforseo_labs-apple-bulk_app_metrics-live","status":"publish","type":"page","link":"https:\/\/docs.dataforseo.com\/v3\/dataforseo_labs-apple-bulk_app_metrics-live\/","title":{"rendered":"dataforseo_labs\/apple\/bulk_app_metrics\/live"},"content":{"rendered":"<div class=\"wpb-content-wrapper\"><p>[vc_row][vc_column][vc_column_text]<\/p>\n<h2 id=\"setting-serp-tasks\">App Store Bulk App Metrics Live<\/h2>\n<p>\u200c<br \/>\nThis endpoint will provide you with ranking metrics for up to 1000 App Store applications.<\/p>\n<p>The returned results are specific to the <code>app_ids<\/code> specified in a POST request. <\/p>\n<p>The <code>app_id<\/code> parameter can be found on the App Store website as a part of a URL pointing to a specific mobile application. It consists of numbers indicated after <code>id<\/code> in the URL string. For example, here is the URL of the TikTok app on App Store:<\/p>\n<p><code>https:\/\/apps.apple.com\/us\/app\/id835599320<\/code><\/p>\n<p>The <code>app_id<\/code> of this app is <code>835599320<\/code><\/p>\n<p>[\/vc_column_text]    <div class=\"endpoint\">\n        <img decoding=\"async\" class=\"endpoint__icon\" src=\"https:\/\/docs.dataforseo.com\/v3\/wp-content\/themes\/dataforseo\/assets\/img\/icons\/checked-circle.svg\" alt=\"checked\">\n\n                    POST            <button class=\"btn-reset button-link copy-button\" data-href=\"https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live\">\n                https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live                <svg width=\"16\" height=\"16\" viewBox=\"0 0 16 16\">\n                    <use href=\"https:\/\/docs.dataforseo.com\/v3\/wp-content\/themes\/dataforseo\/assets\/img\/icons\/sprite.svg#layers\"><\/use>\n                <\/svg>\n            <\/button>\n            <\/div>\n    \t<article class=\"info-card info-card--yellow\">\n\t\t<header class=\"info-card__header\">\n\t\t\t<div class=\"info-card__icon\">\n\t\t\t\t<svg width=\"16\" height=\"16\" viewBox=\"0 0 16 16\">\n\t\t\t\t\t<use href=\"https:\/\/docs.dataforseo.com\/v3\/wp-content\/themes\/dataforseo\/assets\/img\/icons\/sprite.svg#label\"><\/use>\n\t\t\t\t<\/svg>\n\t\t\t<\/div>\n\t\t\t<div class=\"info-card__title\">Pricing<\/div>\n\t\t<\/header>\n\t\t<div class=\"info-card__content\">\n\t\t\t<p> Your account will be charged for each request.<br \/>\nThe cost can be calculated on the <a title=\"Pricing\" href=\"https:\/\/dataforseo.com\/pricing\/dataforseo-labs\/dataforseo-bing-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing<\/a> page.<\/p>\n\t\t<\/div>\n\t<\/article>\n\t[vc_column_text]All POST data should be sent in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/JSON\">JSON<\/a> format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, each Live API call can contain only one task.<\/p>\n<p>Below you will find a detailed description of the fields you can use for setting a task.<\/p>\n<p><strong>Description of the fields for setting a task:<\/strong><br \/>\n<div class=\"dfs-doc-container dfs-doc-request\"><table><thead><tr><th>Field name<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr data-doc-id=\"app_ids\"><td><code>app_ids<\/code><\/td><td>array<\/td><td><p><em>ids of the apps<\/em><br><strong>required field<\/strong><br>IDs of 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><a href=\"https:\/\/apps.apple.com\/us\/app\/id835599320\">https:\/\/apps.apple.com\/us\/app\/id835599320<\/a><\/code><br>the id is <code>835599320<\/code>;<br>the maximum number of IDs you can specify in this field is <code>1000<\/code><\/p><\/td><\/tr><tr data-doc-id=\"location_name\"><td><code>location_name<\/code><\/td><td>string<\/td><td><p><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><a href=\"https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages\">https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages<\/a><\/code>;<br><strong>Note:<\/strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">United States<\/code><\/p><\/td><\/tr><tr data-doc-id=\"location_code\"><td><code>location_code<\/code><\/td><td>integer<\/td><td><p><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><a href=\"https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages\">https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages<\/a><\/code>;<br><strong>Note:<\/strong> this endpoint currently supports the US location only;<br>example:<br><code class=\"long-string\">2840<\/code><\/p><\/td><\/tr><tr data-doc-id=\"language_name\"><td><code>language_name<\/code><\/td><td>string<\/td><td><p><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><a href=\"https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages\">https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages<\/a><\/code>;<br><strong>Note:<\/strong> this endpoint currently supports the English language only;<br>example:<br><code class=\"long-string\">English<\/code><\/p><\/td><\/tr><tr data-doc-id=\"language_code\"><td><code>language_code<\/code><\/td><td>string<\/td><td><p><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><a href=\"https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages\">https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/locations_and_languages<\/a><\/code>;<br><strong>Note:<\/strong> this endpoint currently supports the English language only<br>example:<br><code class=\"long-string\">en<\/code><\/p><\/td><\/tr><tr data-doc-id=\"tag\"><td><code>tag<\/code><\/td><td>string<\/td><td><p><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<\/p><\/td><\/tr><\/tbody><\/table><\/div><br \/>\n\u200c<\/p>\n<p>As a response of the API server, you will receive <a href=\"https:\/\/en.wikipedia.org\/wiki\/JSON\">JSON<\/a>-encoded data containing a <code>tasks<\/code> array with the information specific to the set tasks.<\/p>\n<p><strong>Description of the fields in the results array:<\/strong><br \/>\n<div class=\"dfs-doc-container dfs-doc-response\"><div class=\"api-block-main\"><div class=\"api-section\"><table><thead><tr><th>Field name<\/th><th>Type<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr data-doc-id=\"version\"><td><code>version<\/code><\/td><td>string<\/td><td><p><em>the current version of the API<\/em><\/p><\/td><\/tr><tr data-doc-id=\"status_code\"><td><code>status_code<\/code><\/td><td>integer<\/td><td><p><i>general status code<\/i><br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><br><strong>Note:<\/strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions<\/p><\/td><\/tr><tr data-doc-id=\"status_message\"><td><code>status_message<\/code><\/td><td>string<\/td><td><p><em>general informational message<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"time\"><td><code>time<\/code><\/td><td>string<\/td><td><p><em>execution time, seconds<\/em><\/p><\/td><\/tr><tr data-doc-id=\"cost\"><td><code>cost<\/code><\/td><td>float<\/td><td><p><em>total tasks cost, USD<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks_count\"><td><code>tasks_count<\/code><\/td><td>integer<\/td><td><p><em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks_error\"><td><code>tasks_error<\/code><\/td><td>integer<\/td><td><p><em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array returned with an error<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks\"><td><strong><code>tasks<\/code><\/strong><\/td><td>array<\/td><td><p><em>array of tasks<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-id\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>id<\/code><\/td><td>string<\/td><td><p><em>task identifier<\/em><br><strong>unique task identifier in our system in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/Universally_unique_identifier\">UUID<\/a> format<\/strong><\/p><\/td><\/tr><tr data-doc-id=\"tasks-status_code\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>status_code<\/code><\/td><td>integer<\/td><td><p><em>status code of the task <\/em><br>generated by DataForSEO; can be within the following range: 10000-60000<br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"tasks-status_message\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>status_message<\/code><\/td><td>string<\/td><td><p><em>informational message of the task<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix-errors\/\">here<\/a><\/p><\/td><\/tr><tr data-doc-id=\"tasks-time\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>time<\/code><\/td><td>string<\/td><td><p><em>execution time, seconds<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-cost\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>cost<\/code><\/td><td>float<\/td><td><p><em>cost of the task, USD<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result_count\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>result_count<\/code><\/td><td>integer<\/td><td><p><em>number of elements in the <code>result<\/code> array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-path\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>path<\/code><\/td><td>array<\/td><td><p><em>URL path<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-data\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<code>data<\/code><\/td><td>object<\/td><td><p><em>contains the same parameters that you specified in the POST request<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result\"><td>&nbsp;&nbsp;&nbsp;&nbsp;<strong><code>result<\/code><\/strong><\/td><td>array<\/td><td><p><em>array of results<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-se_type\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>se_type<\/code><\/td><td>string<\/td><td><p><em>search engine type<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-app_id\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>app_id<\/code><\/td><td>string<\/td><td><p><em>id of the app in a POST array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-location_code\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>location_code<\/code><\/td><td>integer<\/td><td><p><em>location code in a POST array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-language_code\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>language_code<\/code><\/td><td>string<\/td><td><p><em>language code in a POST array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-total_count\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>total_count<\/code><\/td><td>integer<\/td><td><p><em>total amount of results in our database relevant to your request<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items_count\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>items_count<\/code><\/td><td>integer<\/td><td><p><em>the number of results returned in the <code>items<\/code> array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong><code>items<\/code><\/strong><\/td><td>array<\/td><td><p><em>contains data related to the ranking app metrics of the specified application<\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-se_type\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>se_type<\/code><\/td><td>string<\/td><td><p><em>search engine type<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-app_id\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>app_id<\/code><\/td><td>string<\/td><td><p><em>id of the app in a POST array<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong><code>metrics<\/code><\/strong><\/td><td>object<\/td><td><p><em>metrics for the ranking keywords of the app<\/em><br>ranking data relevant to the keywords that the provided application ranks for on App Store<\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<strong><code>app_store_search_organic<\/code><\/strong><\/td><td>object<\/td><td><p><em>ranking data from App Store organic search<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic-pos_1\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>pos_1<\/code><\/td><td>integer<\/td><td><p><em>number of SERPs where the app ranks #1 in organic results<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic-pos_2_3\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>pos_2_3<\/code><\/td><td>integer<\/td><td><p><em>number of SERPs where the app ranks #2-3 in organic results<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic-pos_4_10\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>pos_4_10<\/code><\/td><td>integer<\/td><td><p><em>number of SERPs where the app ranks #4-10 in organic results<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic-pos_11_100\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>pos_11_100<\/code><\/td><td>integer<\/td><td><p><em>number of SERPs where the app ranks #11-100 in organic results<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic-count\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>count<\/code><\/td><td>integer<\/td><td><p><em>total count of organic SERPs that contain the app<\/em><\/p><\/td><\/tr><tr data-doc-id=\"tasks-result-items-metrics-app_store_search_organic-search_volume\"><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<code>search_volume<\/code><\/td><td>integer<\/td><td><p><em>total search volume of the app's ranking keywords in App Store organic SERP<\/em><\/p><\/td><\/tr><\/tbody><\/table><\/div><\/div><\/div><br \/>\n\u200c\u200c[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n<blockquote><p>Instead of \u2018login\u2019 and \u2018password\u2019 use your credentials from https:\/\/app.dataforseo.com\/api-access<\/p><\/blockquote><div id=\"curl\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-bash hljs\"># Instead of &#039;login&#039; and &#039;password&#039; use your credentials from https:\/\/app.dataforseo.com\/api-access \r\nlogin=&quot;login&quot; \r\npassword=&quot;password&quot; \r\ncred=&quot;$(printf ${login}:${password} | base64)&quot; \r\ncurl --location --request POST &quot;https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live&quot; \r\n--header &quot;Authorization: Basic ${cred}&quot;  \r\n--header &quot;Content-Type: application\/json&quot; \r\n--data-raw &#039;[\r\n    {\r\n        &quot;app_ids&quot;: [\r\n            &quot;686449807&quot;,\r\n            &quot;382617920&quot;\r\n        ],\r\n        &quot;language_name&quot;: &quot;English&quot;,\r\n        &quot;location_code&quot;: 2840\r\n    }\r\n]&#039;<\/code><\/pre><\/div><\/div><div id=\"php\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-php hljs\">&lt;?php\r\n\/\/ You can download this file from here https:\/\/cdn.dataforseo.com\/v3\/examples\/php\/php_RestClient.zip\r\nrequire(&#039;RestClient.php&#039;);\r\n$api_url = &#039;https:\/\/api.dataforseo.com\/&#039;;\r\n\/\/ Instead of &#039;login&#039; and &#039;password&#039; use your credentials from https:\/\/app.dataforseo.com\/api-access\r\n$client = new RestClient($api_url, null, &#039;login&#039;, &#039;password&#039;);\r\n\r\n$post_array = array();\r\n\/\/ simple way to set a task\r\n$post_array[] = array(\r\n\t&quot;app_ids&quot; =&gt; [\r\n            &quot;686449807&quot;,\r\n            &quot;382617920&quot;\r\n        ],\r\n\t&quot;language_name&quot; =&gt; &quot;English&quot;,\r\n\t&quot;location_code&quot; =&gt; 2840,\r\n\t&quot;limit&quot; =&gt; 10\r\n);\r\ntry {\r\n   \/\/ POST \/v3\/dataforseo_labs\/bulk_app_metrics\/live\r\n   $result = $client-&gt;post(&#039;\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live&#039;, $post_array);\r\n   print_r($result);\r\n   \/\/ do something with post result\r\n} catch (RestClientException $e) {\r\n   echo &quot;n&quot;;\r\n   print &quot;HTTP code: {$e-&gt;getHttpCode()}n&quot;;\r\n   print &quot;Error code: {$e-&gt;getCode()}n&quot;;\r\n   print &quot;Message: {$e-&gt;getMessage()}n&quot;;\r\n   print  $e-&gt;getTraceAsString();\r\n   echo &quot;n&quot;;\r\n}\r\n$client = null;\r\n?&gt;<\/code><\/pre><\/div><\/div><div id=\"javascript\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-javascript hljs\">const post_array = [];\r\n\r\npost_array.push({\r\n  &quot;app_ids&quot;: [\r\n            &quot;686449807&quot;,\r\n            &quot;382617920&quot;\r\n        ],\r\n  &quot;language_name&quot;: &quot;English&quot;,\r\n  &quot;location_code&quot;: 2840\r\n});\r\n\r\nconst axios = require(&#039;axios&#039;);\r\n\r\naxios({\r\n  method: &#039;post&#039;,\r\n  url: &#039;https:\/\/api.dataforseo.com\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live&#039;,\r\n  auth: {\r\n    username: &#039;login&#039;,\r\n    password: &#039;password&#039;\r\n  },\r\n  data: post_array,\r\n  headers: {\r\n    &#039;content-type&#039;: &#039;application\/json&#039;\r\n  }\r\n}).then(function (response) {\r\n  var result = response[&#039;data&#039;][&#039;tasks&#039;];\r\n  \/\/ Result data\r\n  console.log(result);\r\n}).catch(function (error) {\r\n  console.log(error);\r\n});<\/code><\/pre><\/div><\/div><div id=\"python\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-python hljs\">from client import RestClient\r\n# You can download this file from here https:\/\/cdn.dataforseo.com\/v3\/examples\/python\/python_Client.zip\r\nclient = RestClient(&quot;login&quot;, &quot;password&quot;)\r\npost_data = dict()\r\n# simple way to set a task\r\npost_data[len(post_data)] = dict(\r\n    app_ids=[\r\n            &quot;686449807&quot;,\r\n            &quot;382617920&quot;\r\n        ],\r\n    location_name=&quot;United States&quot;,\r\n    language_name=&quot;English&quot;\r\n)\r\n# POST \/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live\r\nresponse = client.post(&quot;\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live&quot;, post_data)\r\n# you can find the full list of the response codes here https:\/\/docs.dataforseo.com\/v3\/appendix\/errors\r\nif response[&quot;status_code&quot;] == 20000:\r\n    print(response)\r\n    # do something with result\r\nelse:\r\n    print(&quot;error. Code: %d Message: %s&quot; % (response[&quot;status_code&quot;], response[&quot;status_message&quot;]))<\/code><\/pre><\/div><\/div><div id=\"csharp\" class=\"tab-content example__content\"><div class=\"example__code\"><pre><code class=\"language-csharp hljs\">using Newtonsoft.Json;\r\nusing System;\r\nusing System.Collections.Generic;\r\nusing System.Net.Http;\r\nusing System.Net.Http.Headers;\r\nusing System.Text;\r\nusing System.Threading.Tasks;\r\n\r\nnamespace DataForSeoDemos\r\n{\r\n    public static partial class Demos\r\n    {\r\n        public static async Task dataforseo_labs_apple_bulk_app_metrics_live()\r\n        {\r\n            var httpClient = new HttpClient\r\n            {\r\n                BaseAddress = new Uri(&quot;https:\/\/api.dataforseo.com\/&quot;),\r\n                \/\/ Instead of &#039;login&#039; and &#039;password&#039; use your credentials from https:\/\/app.dataforseo.com\/api-access\r\n                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue(&quot;Basic&quot;, Convert.ToBase64String(Encoding.ASCII.GetBytes(&quot;login:password&quot;))) }\r\n            };\r\n            var postData = new List&lt;object&gt;();\r\n            postData.Add(new\r\n            {\r\n                app_ids = [\r\n                    &quot;686449807&quot;,\r\n                    &quot;382617920&quot;\r\n                ],\r\n                location_name = &quot;United States&quot;,\r\n                language_name = &quot;English&quot;\r\n            });\r\n            \/\/ POST \/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live\r\n            \/\/ the full list of possible parameters is available in documentation\r\n            var taskPostResponse = await httpClient.PostAsync(&quot;\/v3\/dataforseo_labs\/apple\/bulk_app_metrics\/live&quot;, new StringContent(JsonConvert.SerializeObject(postData)));\r\n            var result = JsonConvert.DeserializeObject(await taskPostResponse.Content.ReadAsStringAsync());\r\n            \/\/ you can find the full list of the response codes here https:\/\/docs.dataforseo.com\/v3\/appendix\/errors\r\n            if (result.status_code == 20000)\r\n            {\r\n                \/\/ do something with result\r\n                Console.WriteLine(result);\r\n            }\r\n            else\r\n                Console.WriteLine($&quot;error. Code: {result.status_code} Message: {result.status_message}&quot;);\r\n        }\r\n    }\r\n}<\/code><\/pre><\/div><\/div><blockquote><p>The above command returns JSON structured like this:<\/p><\/blockquote><div class=\"example example--json\"><div class=\"example__content\"><div class=\"example__code example__code-json\"><pre><code class=\"language-json hljs\">{\r\n    &quot;version&quot;: &quot;0.1.20220428&quot;,\r\n    &quot;status_code&quot;: 20000,\r\n    &quot;status_message&quot;: &quot;Ok.&quot;,\r\n    &quot;time&quot;: &quot;0.2300 sec.&quot;,\r\n    &quot;cost&quot;: 0.0102,\r\n    &quot;tasks_count&quot;: 1,\r\n    &quot;tasks_error&quot;: 0,\r\n    &quot;tasks&quot;: [\r\n        {\r\n            &quot;id&quot;: &quot;06241759-2806-0453-0000-8e77e0ed4203&quot;,\r\n            &quot;status_code&quot;: 20000,\r\n            &quot;status_message&quot;: &quot;Ok.&quot;,\r\n            &quot;time&quot;: &quot;0.1474 sec.&quot;,\r\n            &quot;cost&quot;: 0.0102,\r\n            &quot;result_count&quot;: 1,\r\n            &quot;path&quot;: [\r\n                &quot;v3&quot;,\r\n                &quot;dataforseo_labs&quot;,\r\n                &quot;apple&quot;,\r\n                &quot;bulk_app_metrics&quot;,\r\n                &quot;live&quot;\r\n            ],\r\n            &quot;data&quot;: {\r\n                &quot;api&quot;: &quot;dataforseo_labs&quot;,\r\n                &quot;function&quot;: &quot;bulk_app_metrics&quot;,\r\n                &quot;se_type&quot;: &quot;apple&quot;,\r\n                &quot;app_ids&quot;: [\r\n                    &quot;686449807&quot;,\r\n                    &quot;382617920&quot;\r\n                ],\r\n                &quot;location_code&quot;: 2840,\r\n                &quot;language_name&quot;: &quot;English&quot;\r\n            },\r\n            &quot;result&quot;: [\r\n                {\r\n                    &quot;se_type&quot;: &quot;apple&quot;,\r\n                    &quot;location_code&quot;: 2840,\r\n                    &quot;language_code&quot;: &quot;en&quot;,\r\n                    &quot;total_count&quot;: 2,\r\n                    &quot;items_count&quot;: 2,\r\n                    &quot;items&quot;: [\r\n                        {\r\n                            &quot;se_type&quot;: &quot;apple&quot;,\r\n                            &quot;app_id&quot;: &quot;382617920&quot;,\r\n                            &quot;metrics&quot;: {\r\n                                &quot;app_store_search_organic&quot;: {\r\n                                    &quot;pos_1&quot;: 213,\r\n                                    &quot;pos_2_3&quot;: 317,\r\n                                    &quot;pos_4_10&quot;: 1309,\r\n                                    &quot;pos_11_100&quot;: 3505,\r\n                                    &quot;count&quot;: 5344,\r\n                                    &quot;search_volume&quot;: 42237121\r\n                                }\r\n                            }\r\n                        },\r\n                        {\r\n                            &quot;se_type&quot;: &quot;apple&quot;,\r\n                            &quot;app_id&quot;: &quot;686449807&quot;,\r\n                            &quot;metrics&quot;: {\r\n                                &quot;app_store_search_organic&quot;: {\r\n                                    &quot;pos_1&quot;: 214,\r\n                                    &quot;pos_2_3&quot;: 167,\r\n                                    &quot;pos_4_10&quot;: 570,\r\n                                    &quot;pos_11_100&quot;: 1855,\r\n                                    &quot;count&quot;: 2806,\r\n                                    &quot;search_volume&quot;: 34508416\r\n                                }\r\n                            }\r\n                        }\r\n                    ]\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}<\/code><\/pre><\/div><\/div><\/div><\/div>","protected":false},"excerpt":{"rendered":"<p>[vc_row][vc_column][vc_column_text] App Store Bulk App Metrics Live \u200c This endpoint will provide you with ranking metrics for up to 1000 App Store applications. The returned results are specific to the app_ids specified in a POST request. The app_id parameter can be found on the App Store website as a part of a URL pointing to [&hellip;]<\/p>\n","protected":false},"author":6,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"template.php","meta":{"apibase_doc_request_yaml":"parameters:\n  - name: app_ids\n    type: array\n    description: |\n      <em>ids of the apps<\/em><br><strong>required field<\/strong><br>IDs of 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 maximum number of IDs you can specify in this field is <code>1000<\/code>\n  - name: location_name\n    type: string\n    description: |\n      <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>\n  - name: location_code\n    type: integer\n    description: |\n      <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>\n  - name: language_name\n    type: string\n    description: |\n      <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>\n  - name: language_code\n    type: string\n    description: |\n      <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>\n  - name: tag\n    type: string\n    description: |\n      <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","apibase_doc_request_additional_yaml":"","apibase_doc_response_yaml":"parameters:\n  - name: version\n    type: string\n    description: |\n      <em>the current version of the API<\/em>\n  - name: status_code\n    type: integer\n    description: |\n      <i>general status code<\/i><br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><br><strong>Note:<\/strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions\n  - name: status_message\n    type: string\n    description: |\n      <em>general informational message<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a>\n  - name: time\n    type: string\n    description: |\n      <em>execution time, seconds<\/em>\n  - name: cost\n    type: float\n    description: |\n      <em>total tasks cost, USD<\/em>\n  - name: tasks_count\n    type: integer\n    description: |\n      <em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array<\/em>\n  - name: tasks_error\n    type: integer\n    description: |\n      <em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array returned with an error<\/em>\n  - name: tasks\n    type: array\n    description: |\n      <em>array of tasks<\/em>\n    items:\n      children:\n        - name: id\n          type: string\n          description: |\n            <em>task identifier<\/em><br><strong>unique task identifier in our system in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/Universally_unique_identifier\">UUID<\/a> format<\/strong>\n        - name: status_code\n          type: integer\n          description: |\n            <em>status code of the task <\/em><br>generated by DataForSEO; can be within the following range: 10000-60000<br>you can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a>\n        - name: status_message\n          type: string\n          description: |\n            <em>informational message of the task<\/em><br>you can find the full list of general informational messages <a href=\"\/v3\/appendix-errors\/\">here<\/a>\n        - name: time\n          type: string\n          description: |\n            <em>execution time, seconds<\/em>\n        - name: cost\n          type: float\n          description: |\n            <em>cost of the task, USD<\/em>\n        - name: result_count\n          type: integer\n          description: |\n            <em>number of elements in the <code>result<\/code> array<\/em>\n        - name: path\n          type: array\n          description: |\n            <em>URL path<\/em>\n        - name: data\n          type: object\n          description: |\n            <em>contains the same parameters that you specified in the POST request<\/em>\n        - name: result\n          type: array\n          description: |\n            <em>array of results<\/em>\n          items:\n            children:\n              - name: se_type\n                type: string\n                description: |\n                  <em>search engine type<\/em>\n              - name: app_id\n                type: string\n                description: |\n                  <em>id of the app in a POST array<\/em>\n              - name: location_code\n                type: integer\n                description: |\n                  <em>location code in a POST array<\/em>\n              - name: language_code\n                type: string\n                description: |\n                  <em>language code in a POST array<\/em>\n              - name: total_count\n                type: integer\n                description: |\n                  <em>total amount of results in our database relevant to your request<\/em>\n              - name: items_count\n                type: integer\n                description: |\n                  <em>the number of results returned in the <code>items<\/code> array<\/em>\n              - name: items\n                type: array\n                description: |\n                  <em>contains data related to the ranking app metrics of the specified application\n                items:\n                  children:\n                    - name: se_type\n                      type: string\n                      description: |\n                        <em>search engine type<\/em>\n                    - name: app_id\n                      type: string\n                      description: |\n                        <em>id of the app in a POST array<\/em>\n                    - name: metrics\n                      type: object\n                      description: |\n                        <em>metrics for the ranking keywords of the app<\/em><br>ranking data relevant to the keywords that the provided application ranks for on App Store\n                      children:\n                        - name: app_store_search_organic\n                          type: object\n                          description: |\n                            <em>ranking data from App Store organic search<\/em>\n                          children:\n                            - name: pos_1\n                              type: integer\n                              description: |\n                                <em>number of SERPs where the app ranks #1 in organic results<\/em>\n                            - name: pos_2_3\n                              type: integer\n                              description: |\n                                <em>number of SERPs where the app ranks #2-3 in organic results<\/em>\n                            - name: pos_4_10\n                              type: integer\n                              description: |\n                                <em>number of SERPs where the app ranks #4-10 in organic results<\/em>\n                            - name: pos_11_100\n                              type: integer\n                              description: |\n                                <em>number of SERPs where the app ranks #11-100 in organic results<\/em>\n                            - name: count\n                              type: integer\n                              description: |\n                                <em>total count of organic SERPs that contain the app<\/em>\n                            - name: search_volume\n                              type: integer\n                              description: |\n                                <em>total search volume of the app's ranking keywords in App Store organic SERP<\/em>","footnotes":""},"class_list":["post-14631","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/14631","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/comments?post=14631"}],"version-history":[{"count":6,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/14631\/revisions"}],"predecessor-version":[{"id":25057,"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/pages\/14631\/revisions\/25057"}],"wp:attachment":[{"href":"https:\/\/docs.dataforseo.com\/v3\/wp-json\/wp\/v2\/media?parent=14631"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}