By calling this endpoint you will receive information about the Keywords Data API tasks that returned an error within the past 7 days.
For example, if you have set tasks with webhooks (pingbacks and postback), but haven’t received them due to a server error, you can get a list of task IDs using the Keywords Data API Errors endpoint, and use these IDs to resend webhooks.
Note that if a certain task does not appear on the list, this means the task did not respond with an error or has not been completed yet.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request POST "https://api.dataforseo.com/v3/keywords_data/errors"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"limit": 10,
"offset": 0,
"filtered_function": "pingback_url"
}
]"
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to get a result
$post_array[] = array(
"limit" => 10,
"offset" => 0,
"filtered_function" => "pingback_url"
);
try {
// POST /v3/keywords_data/errors
// the full list of possible parameters is available in documentation
$result = $client->post('/v3/keywords_data/errors', $post_array);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
echo "n";
print "HTTP code: {$e->getHttpCode()}n";
print "Error code: {$e->getCode()}n";
print "Message: {$e->getMessage()}n";
print $e->getTraceAsString();
echo "n";
}
$client = null;
?>
from random import Random
from client import RestClient
# You can download this file from here https://api.dataforseo.com/v3/_examples/python/_python_Client.zip
client = RestClient("login", "password")
post_data = dict()
post_data[len(post_data)] = dict(
limit=10,
offset=0,
filtered_function="pingback_url"
)
# POST /v3/keywords_data/errors
# the full list of possible parameters is available in documentation
response = client.post("/v3/keywords_data/errors", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/keywords_data/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task errors()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
// simple way to get a result
postData.Add(new
{
limit = 10,
offset = 0,
filtered_function = "pingback_url"
});
// POST /v3/keywords_data/errors
// the full list of possible parameters is available in documentation
var taskPostResponse = await httpClient.PostAsync("/v3/keywords_data/errors", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject<dynamic>(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/keywords_data/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in JSON 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.
Description of the fields for sending a request:
Field name
Type
Description
limit
integer
the maximum number of returned tasks that responded with an error
optional field
default value: 1000
maximum value: 1000
offset
integer
offset in the results array of returned tasks
optional field
default value: 0
if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks
filtered_function
string
return tasks with a certain function
use this field to obtain a list of tasks that returned an error filtered by a certain function
you can filter the results by the values you receive in the function fields of the API response
i.e., once you receive unfiltered results, you can call this API again to filter them by function
example: keywords_data/keywords_for_site/task_post, postback_url, pingback_url
datetime_from
string
start time for filtering results
optional field
allows filtering results by the datetime parameter within the range of the last 7 days;
must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2021-11-15 12:57:46 +00:00
datetime_to
string
finish time for filtering results
optional field
allows filtering results by the datetime parameter within the range of the last 7 days;
must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2021-11-15 13:57:46 +00:00
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Field name
Type
Description
version
string
the current version of the API
status_code
integer
general status code
you can find the full list of the response codes here
status_message
string
general informational message
you can find the full list of general informational messages here
time
string
total execution time, seconds
cost
float
total tasks cost, USD
tasks_count
integer
the number of tasks in the tasks array
tasks_error
integer
the number of tasks in the tasks array returned with an error
tasks
array
array of tasks
id
string
task identifier unique task identifier in our system in the UUID format
status_code
integer
status code of the task
generated by DataForSEO, can be within the following range: 10000-60000
you can find the full list of the response codes here
status_message
string
informational message of the task
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
cost of the task, USD
result_count
integer
number of elements in the result array
path
array
URL path
data
array
contains the same parameters that you specified in the POST request
result
array
array of results
id
string
id of the task
datetime
string
date and time when an error occurred
in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
example: 2019-11-15 12:57:46 +00:00
function
string
corresponding API function
error_code
integer
error code
error_message
string
error message or error URL
error message (see full list) or URL that caused an error
http_url
string
URL that caused an error
URL you used for making an API call or pingback/postback URL
http_method
string
HTTP method
http_code
integer
HTTP status code
http_time
float
time taken by HTTP request
for tasks set with a pingback/postback, this field will show the time it took your server to respond
