{"id":15638,"date":"2022-10-27T14:08:03","date_gmt":"2022-10-27T14:08:03","guid":{"rendered":"https:\/\/docs_v3.dataforseo.com\/v3\/?page_id=15638"},"modified":"2023-11-10T12:44:24","modified_gmt":"2023-11-10T12:44:24","slug":"appendix-status","status":"publish","type":"page","link":"https:\/\/docs.dataforapps.com\/v3\/appendix-status\/","title":{"rendered":"appendix\/status"},"content":{"rendered":"<p>[vc_row][vc_column][vc_column_text]<\/p>\n<h2 id=\"serp-google-locations\">API Status<\/h2>\n<p>&nbsp;<br \/>\nBy calling this API you will receive detailed information about the current status of all our APIs and endpoints. You will also get a full issue description if a problem occurs. <\/p>\n<p><strong>Note:<\/strong> You can send no more than 10 requests per minute. <\/p>\n<p>[\/vc_column_text]\n        <blockquote>\n            <p>Instead of \u2018login\u2019 and \u2018password\u2019 use your credentials from https:\/\/app.dataforapps.com\/api-dashboard<\/p>\n        <\/blockquote>\n        <pre class=\"highlight bash tab-bash\" style=\"display: none;\">\n            <\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"bash\" data-enlighter-theme=\"mocha\">\r\n# Instead of 'login' and 'password' use your credentials from https:\/\/app.dataforapps.com\/api-dashboard \r\nlogin=\"login\" \r\npassword=\"password\" \r\ncred=\"$(printf ${login}:${password} | base64)\" \r\ncurl --location --request GET \"https:\/\/api.dataforapps.com\/v3\/appendix\/status\" \r\n--header \"Authorization: Basic ${cred}\"  \r\n--header \"Content-Type: application\/json\" \r\n<\/pre>\n<p>\n        <\/pre>\n        <pre class=\"highlight php tab-php\" style=\"display: block;\"><\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"php\">&lt;?php\r\n\/\/ You can download this file from here https:\/\/api.dataforapps.com\/v3\/_examples\/php\/_php_RestClient.zip\r\nrequire('RestClient.php');\r\n$api_url = 'https:\/\/api.dataforapps.com\/';\r\ntry {\r\n\t\/\/ Instead of 'login' and 'password' use your credentials from https:\/\/app.dataforapps.com\/api-dashboard\r\n\t$client = new RestClient($api_url, null, 'login', 'password');\r\n} catch (RestClientException $e) {\r\n\techo \"n\";\r\n\tprint \"HTTP code: {$e-&gt;getHttpCode()}n\";\r\n\tprint \"Error code: {$e-&gt;getCode()}n\";\r\n\tprint \"Message: {$e-&gt;getMessage()}n\";\r\n\tprint  $e-&gt;getTraceAsString();\r\n\techo \"n\";\r\n\texit();\r\n}\r\ntry {\r\n\t\/\/ using this method you can get information about current status\r\n\t\/\/ GET \/v3\/appendix\/status\r\n\t$result = $client-&gt;get('\/v3\/appendix\/status');\r\n\tprint_r($result);\r\n\t\/\/ do something with result\r\n} catch (RestClientException $e) {\r\n\techo \"n\";\r\n\tprint \"HTTP code: {$e-&gt;getHttpCode()}n\";\r\n\tprint \"Error code: {$e-&gt;getCode()}n\";\r\n\tprint \"Message: {$e-&gt;getMessage()}n\";\r\n\tprint  $e-&gt;getTraceAsString();\r\n\techo \"n\";\r\n}\r\n$client = null;\r\n?&gt;<\/pre>\n<p><\/pre>\n        <pre class=\"highlight python tab-python\" style=\"display: none;\">\n            <\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"python\" data-enlighter-theme=\"mocha\">from random import Random\r\nfrom client import RestClient\r\n# You can download this file from here https:\/\/api.dataforapps.com\/v3\/_examples\/python\/_python_Client.zip\r\n\r\nclient = RestClient(\"login\", \"password\")\r\n# using this method you can get information about current status\r\n# GET \/v3\/appendix\/status\r\nresponse = client.get(\"\/v3\/appendix\/status\")\r\n# you can find the full list of the response codes here https:\/\/docs.dataforapps.com\/v3\/appendix\/errors\r\nif response[\"status_code\"] == 20000:\r\n    print(response)\r\n    # do something with result\r\nelse:\r\n    print(\"error. Code: %d Message: %s\" % (response[\"status_code\"], response[\"status_message\"]))<\/pre>\n<p>\n        <\/pre>\n        <pre class=\"highlight csharp tab-csharp\" style=\"display: none;\">\n            <\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"csharp\" data-enlighter-theme=\"mocha\">using Newtonsoft.Json;\r\nusing System;\r\nusing System.Net.Http;\r\nusing System.Net.Http.Headers;\r\nusing System.Text;\r\nusing System.Threading.Tasks;\r\n\r\nnamespace DataForAppsDemos\r\n{\r\n    public static partial class Demos\r\n    {\r\n        public static async Task appendix_status()\r\n        {\r\n            var httpClient = new HttpClient\r\n            {\r\n                BaseAddress = new Uri(\"https:\/\/api.dataforapps.com\/\"),\r\n                \/\/ Instead of 'login' and 'password' use your credentials from https:\/\/app.dataforapps.com\/api-dashboard\r\n                DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(Encoding.ASCII.GetBytes(\"login:password\"))) }\r\n            };\r\n            \/\/ using this method you can get information about current status\r\n            \/\/ GET \/v3\/appendix\/status\r\n            var response = await httpClient.GetAsync(\"\/v3\/appendix\/status\");\r\n            var result = JsonConvert.DeserializeObject(await response.Content.ReadAsStringAsync());\r\n            \/\/ you can find the full list of the response codes here https:\/\/docs.dataforapps.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($\"error. Code: {result.status_code} Message: {result.status_message}\");\r\n        }\r\n    }\r\n}\r\n<\/pre>\n<p>\n        <\/pre>\n        <pre class=\"highlight javascript tab-javascript\" style=\"display: none;\">\n            <\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"bash\" data-enlighter-theme=\"mocha\">\r\nconst axios = require('axios');\r\naxios({\r\n    method: 'get',\r\n    url: 'https:\/\/api.dataforapps.com\/v3\/appendix\/status',\r\n    auth: {\r\n        username: 'login',\r\n        password: 'password'\r\n    },\r\n    headers: {\r\n        'content-type': 'application\/json'\r\n    }\r\n}).then(function (response) {\r\n    var result = response['data']['tasks'][0]['result'];\r\n    \/\/ Result data\r\n    console.log(result);\r\n}).catch(function (error) {\r\n    console.log(error);\r\n});\r\n<\/pre>\n<p>\n        <\/pre><aside class=\"notice\">Your account will not be charged for using this API<\/aside>\n        <blockquote>\n            <p>The above command returns JSON structured like this:<\/p>\n        <\/blockquote>\n        <pre class=\"json tab-json\"><\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"json\" data-enlighter-theme=\"mocha\">{\r\n  \"version\": \"0.1.20230825\",\r\n  \"status_code\": 20000,\r\n  \"status_message\": \"Ok.\",\r\n  \"time\": \"0.1070 sec.\",\r\n  \"cost\": 0,\r\n  \"tasks_count\": 1,\r\n  \"tasks_error\": 0,\r\n  \"tasks\": [\r\n    {\r\n      \"id\": \"11091948-6944-0497-3000-fc5658a9ba1b\",\r\n      \"status_code\": 20000,\r\n      \"status_message\": \"Ok.\",\r\n      \"time\": \"0.0546 sec.\",\r\n      \"cost\": 0,\r\n      \"result_count\": 2,\r\n      \"path\": [\r\n        \"v3\",\r\n        \"appendix\",\r\n        \"status\"\r\n      ],\r\n      \"data\": {\r\n        \"api\": \"appendix\",\r\n        \"function\": \"status\"\r\n      },\r\n      \"result\": [\r\n        {\r\n          \"api\": \"appendix\",\r\n          \"status\": \"ok\",\r\n          \"endpoints\": null\r\n        },\r\n        {\r\n          \"api\": \"app_data\",\r\n          \"status\": \"ok\",\r\n          \"endpoints\": [\r\n            {\r\n              \"endpoint\": \"task_post\",\r\n              \"status\": \"ok\"\r\n            },\r\n            {\r\n              \"endpoint\": \"task_get\",\r\n              \"status\": \"ok\"\r\n            },\r\n            {\r\n              \"endpoint\": \"postback\/pingback\",\r\n              \"status\": \"ok\"\r\n            }\r\n          ]\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/pre>\n<p><\/pre><aside class=\"success\"><b><code>GET https:\/\/api.dataforapps.com\/v3\/appendix\/status<\/code><\/b><\/aside>[vc_column_text]<\/p>\n<p>\u200c\u200cAs 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<table style=\"width: 58%; height: 1608px;\">\n<thead>\n<tr style=\"height: 24px;\">\n<th style=\"width: 38.423%; height: 24px;\">Field name<\/th>\n<th style=\"width: 1.75219%; height: 24px;\">Type<\/th>\n<th style=\"width: 61.2015%; height: 24px;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr style=\"height: 48px;\">\n<td style=\"width: 24.3517%; height: 48px;\"><code>version<\/code><\/td>\n<td style=\"width: 6.19209%; height: 48px;\">string<\/td>\n<td style=\"width: 79.8065%; height: 48px;\"><em>the current version of the API<\/em><\/td>\n<\/tr>\n<tr style=\"height: 48px;\">\n<td style=\"width: 38.423%; height: 48px;\"><code>status_code<\/code><\/td>\n<td style=\"width: 1.75219%; height: 48px;\">integer<\/td>\n<td style=\"width: 61.2015%; height: 48px;\"><i>general status code<\/i><br \/>\nyou can find the full list of the response codes <a href=\"\/v3\/appendix\/errors\">here<\/a><br \/>\n<strong>Note:<\/strong> we strongly recommend designing a necessary system for handling related exceptional or error conditions<\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 24.3517%; height: 24px;\"><code>status_message<\/code><\/td>\n<td style=\"width: 6.19209%; height: 24px;\">string<\/td>\n<td style=\"width: 79.8065%; height: 24px;\"><em>general informational message<\/em><br \/>\nyou can find the full list of general informational messages <a href=\"\/v3\/appendix\/errors\">here<\/a><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\"><code>time<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">string<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>total execution time, seconds<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\"><code>cost<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">float<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>total tasks cost, USD<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\"><code>tasks_count<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">integer<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\"><code>tasks_error<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">integer<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>the number of tasks in the <strong><code>tasks<\/code><\/strong> array returned with an error<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\"><strong><code>tasks<\/code><\/strong><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">array<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>array of tasks<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>id<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">string<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>task identifier<\/em><br \/>\n<strong>unique task identifier in our system in the <a href=\"https:\/\/en.wikipedia.org\/wiki\/Universally_unique_identifier\">UUID<\/a> format<\/strong><\/td>\n<\/tr>\n<tr style=\"height: 48px;\">\n<td style=\"width: 38.423%; height: 48px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>status_code<\/code><\/td>\n<td style=\"width: 1.75219%; height: 48px;\">integer<\/td>\n<td style=\"width: 61.2015%; height: 48px;\"><em>status code of the task<\/em><br \/>\ngenerated by DataForApps, can be within the following range: 10000-60000<br \/>\nyou can find the full list of the response codes <a href=\"\/v3\/appendix-errors\/\">here<\/a><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>status_message<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">string<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>informational message of the task<\/em><br \/>\nyou can find the full list of general informational messages <a href=\"\/v3\/appendix-errors\/\">here<\/a><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>time<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">string<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>execution time, seconds<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>cost<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">float<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>cost of the task, USD<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>result_count<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">integer<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>number of elements in the <code>result<\/code> array<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>path<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">array<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>URL path<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 <code>data<\/code><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">array<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>contains the parameters passed in the URL of the GET request<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 <strong>\u00a0 \u00a0 <code>result<\/code><\/strong><\/td>\n<td style=\"width: 1.75219%; height: 24px;\">array<\/td>\n<td style=\"width: 61.2015%; height: 24px;\"><em>array of results<\/em><\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <code>api<\/code><\/td>\n<td style=\"width: 1.25156%; height: 24px;\">string<\/td>\n<td style=\"width: 61.7021%; height: 24px;\"><em>name of the API<\/em><br \/>\nthe list of APIs:<br \/>\n<code>app_data<\/code>\n<\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <code>status<\/code><\/td>\n<td style=\"width: 1.25156%; height: 24px;\">string<\/td>\n<td style=\"width: 61.7021%; height: 24px;\"><em>current status<\/em><br \/>\nthe list of possible current statuses:<br \/>\n<code>major_outage<br \/>\npartial_outage<br \/>\nlong_response_time<br \/>\nlong_execution_time<br \/>\nwebhook_delay<br \/>\nsend_delay<\/code>\n<\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0 <code>endpoints<\/code><\/td>\n<td style=\"width: 1.25156%; height: 24px;\">array<\/td>\n<td style=\"width: 61.7021%; height: 24px;\"><em>array of objects that contain status information for API endpoints<\/em>\n<\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0  \u00a0 \u00a0 <code>endpoint<\/code><\/td>\n<td style=\"width: 1.25156%; height: 24px;\">string<\/td>\n<td style=\"width: 61.7021%; height: 24px;\"><em>name of the endpoint<\/em><br \/>\nthe list of possible endpoints:<br \/>\n<code>task_get<br \/>\ntask_post<br \/>\nlive<br \/>\npostback\/pingback<\/code>\n<\/td>\n<\/tr>\n<tr style=\"height: 24px;\">\n<td style=\"width: 38.423%; height: 24px;\">\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \u00a0  \u00a0 \u00a0 <code>status<\/code><\/td>\n<td style=\"width: 1.25156%; height: 24px;\">string<\/td>\n<td style=\"width: 61.7021%; height: 24px;\"><em>current status<\/em><br \/>\nthe list of possible current statuses:<br \/>\n<code>major_outage<br \/>\npartial_outage<br \/>\nlong_response_time<br \/>\nlong_execution_time<br \/>\nwebhook_delay<br \/>\nsend_delay<\/code>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div data-unique=\"list-of-keywords-finder-locations\"><\/div>\n<p>[\/vc_column_text][\/vc_column][\/vc_row]<\/p>\n","protected":false},"excerpt":{"rendered":"<p>[vc_row][vc_column][vc_column_text] API Status &nbsp; By calling this API you will receive detailed information about the current status of all our APIs and endpoints. You will also get a full issue description if a problem occurs. Note: You can send no more than 10 requests per minute. [\/vc_column_text][vc_column_text] \u200c\u200cAs a response of the API server, you [&hellip;]<\/p>\n","protected":false},"author":11,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"template.php","meta":{"footnotes":""},"_links":{"self":[{"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/pages\/15638"}],"collection":[{"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/users\/11"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/comments?post=15638"}],"version-history":[{"count":32,"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/pages\/15638\/revisions"}],"predecessor-version":[{"id":17595,"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/pages\/15638\/revisions\/17595"}],"wp:attachment":[{"href":"https:\/\/docs.dataforapps.com\/v3\/wp-json\/wp\/v2\/media?parent=15638"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}