{"id":1574,"date":"2019-11-28T11:12:17","date_gmt":"2019-11-28T11:12:17","guid":{"rendered":"https:\/\/docs_v3.dataforseo.com\/v3\/?page_id=1574"},"modified":"2023-11-13T13:54:20","modified_gmt":"2023-11-13T13:54:20","slug":"appendix-errors","status":"publish","type":"page","link":"https:\/\/docs.dataforapps.com\/v3\/appendix-errors\/","title":{"rendered":"appendix\/errors"},"content":{"rendered":"

[vc_row][vc_column][vc_column_text]<\/p>\n

Errors<\/h2>\n

[\/vc_column_text]\n

\n

Instead of \u2018login\u2019 and \u2018password\u2019 use your credentials from https:\/\/app.dataforapps.com\/api-dashboard<\/p>\n <\/blockquote>\n 

\n            <\/p>\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\/errors\" \\\r\n--header \"Authorization: Basic ${cred}\"  \\\r\n--header \"Content-Type: application\/json\" \\\r\n--data-raw \"\"\r\n<\/pre>\n
\n        <\/pre>\n        
<\/p>\n
<?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->getHttpCode()}\\n\";\r\n\tprint \"Error code: {$e->getCode()}\\n\";\r\n\tprint \"Message: {$e->getMessage()}\\n\";\r\n\tprint  $e->getTraceAsString();\r\n\techo \"\\n\";\r\n\texit();\r\n}\r\ntry {\r\n\t\/\/ using this method you can get a list of errors\r\n\t\/\/ GET \/v3\/appendix\/errors\r\n\t$result = $client->get('\/v3\/appendix\/errors');\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->getHttpCode()}\\n\";\r\n\tprint \"Error code: {$e->getCode()}\\n\";\r\n\tprint \"Message: {$e->getMessage()}\\n\";\r\n\tprint  $e->getTraceAsString();\r\n\techo \"\\n\";\r\n}\r\n$client = null;\r\n?><\/pre>\n
<\/pre>\n        
\n            <\/p>\n
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 a list of errors\r\n# GET \/v3\/appendix\/errors\r\nresponse = client.get(\"\/v3\/appendix\/errors\")\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
\n        <\/pre>\n        
\n            <\/p>\n
const axios = require('axios');\r\n\r\naxios({\r\n    method: 'get',\r\n    url: 'https:\/\/api.dataforapps.com\/v3\/appendix\/errors',\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
\n        <\/pre>\n        
\n            <\/p>\n
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_errors()\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 a list of errors\r\n            \/\/ GET \/v3\/appendix\/errors\r\n            var response = await httpClient.GetAsync(\"\/v3\/appendix\/errors\");\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
\n        <\/pre>\n        
\n            
The above command returns JSON structured like this:<\/p>\n        <\/blockquote>\n        
<\/p>\n
{\r\n  \"version\": \"0.1.20230825\",\r\n  \"status_code\": 20000,\r\n  \"status_message\": \"Ok.\",\r\n  \"time\": \"0.0782 sec.\",\r\n  \"cost\": 0,\r\n  \"tasks_count\": 1,\r\n  \"tasks_error\": 0,\r\n  \"tasks\": [\r\n    {\r\n      \"id\": \"11011828-6944-0161-3000-73689637de5e\",\r\n      \"status_code\": 20000,\r\n      \"status_message\": \"Ok.\",\r\n      \"time\": \"0.0000 sec.\",\r\n      \"cost\": 0,\r\n      \"result_count\": 46,\r\n      \"path\": [\r\n        \"v3\",\r\n        \"appendix\",\r\n        \"errors\"\r\n      ],\r\n      \"data\": {\r\n        \"api\": \"appendix\",\r\n        \"function\": \"errors\"\r\n      },\r\n      \"result\": [\r\n        {\r\n          \"code\": 20000,\r\n          \"message\": \"Ok.\"\r\n        },\r\n        {\r\n          \"code\": 20100,\r\n          \"message\": \"Task Created.\"\r\n        },\r\n        {\r\n          \"code\": 40000,\r\n          \"message\": \"You can set only one task at a time.\"\r\n        },\r\n        {\r\n          \"code\": 40001,\r\n          \"message\": \"This id is used by another client, check the id.\"\r\n        },\r\n        {\r\n          \"code\": 40002,\r\n          \"message\": \"This id is used by another search engine, check the Path.\"\r\n        },\r\n        {\r\n          \"code\": 40003,\r\n          \"message\": \"This id is used by another search type, check the Path.\"\r\n        },\r\n        {\r\n          \"code\": 40004,\r\n          \"message\": \"This id is used by another function, check the id.\"\r\n        },\r\n        {\r\n          \"code\": 40006,\r\n          \"message\": \"You can set no more than 100 tasks at a time.\"\r\n        },\r\n        {\r\n          \"code\": 40100,\r\n          \"message\": \"You are not authorized to access this resource. See your login details here: https:\/\/app.dataforapps.com\/api-dashboard .\"\r\n        },\r\n        {\r\n          \"code\": 40101,\r\n          \"message\": \"Internal SE Server Error.\"\r\n        },\r\n        {\r\n          \"code\": 40102,\r\n          \"message\": \"No Search Results.\"\r\n        }\r\n      ]\r\n    }\r\n  ]\r\n}<\/pre>\n
<\/pre>[vc_column_text]<\/p>\n
This endpoint returns a list of possible DataForApps API errors and general status codes. Below you will find a list of HTTP response codes and internal messages. We recommend storing the data connected to error codes in your application log and designing a necessary system for handling related exceptional or error conditions.<\/p>\n
Note:<\/strong> DataForApps API servers always return the 200<\/code> HTTP response code, except for the following cases.<\/p>\n
HTTP response codes:<\/strong><\/p>\n\n\n\n\n\n\n\n\n
Code<\/th>\nMessage<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
401<\/code><\/td>\nUnauthorized<\/td>\nYou are not authorized to access this resource. See your login details here: https:\/\/app.dataforapps.com\/api-dashboard<\/em><\/td>\n<\/tr>\n
402<\/code><\/td>\nPayment Required<\/td>\nWe had a problem billing your account. Please, check your account’s balance.<\/em><\/td>\n<\/tr>\n
404<\/code><\/td>\nNot Found<\/td>\nRequested endpoint not found<\/i><\/td>\n<\/tr>\n
500<\/code><\/td>\nInternal Server Error<\/td>\nSorry, we could not process your request due to the internal server error. Please, try again later.<\/i><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
 <\/p>\n
Alongside the 200<\/code> HTTP code, our system also generates internal status codes which you may find in status_code<\/code> and status_message<\/code> fields of the API response.<\/p>\n
Note:<\/strong> status messages can be expanded in the API response and may vary depending on the event that triggered them.<\/p>\n
You can also get the list of internal error codes by calling the ‘Errors’ endpoint:<\/strong>
\n