NAVNavbar
cURL php NodeJS Python cSharp

API Status

 
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.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforapps.com/api-dashboard

<?php
// You can download this file from here https://api.dataforapps.com/v3/_examples/php/_php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforapps.com/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforapps.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} 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";
	exit();
}
try {
	// using this method you can get information about current status
	// GET /v3/appendix/status
	$result = $client->get('/v3/appendix/status');
	print_r($result);
	// do something with 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;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20230825",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.1070 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11091948-6944-0497-3000-fc5658a9ba1b",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0546 sec.",
      "cost": 0,
      "result_count": 2,
      "path": [
        "v3",
        "appendix",
        "status"
      ],
      "data": {
        "api": "appendix",
        "function": "status"
      },
      "result": [
        {
          "api": "appendix",
          "status": "ok",
          "endpoints": null
        },
        {
          "api": "app_data",
          "status": "ok",
          "endpoints": [
            {
              "endpoint": "task_post",
              "status": "ok"
            },
            {
              "endpoint": "task_get",
              "status": "ok"
            },
            {
              "endpoint": "postback/pingback",
              "status": "ok"
            }
          ]
        }
      ]
    }
  ]
}

‌‌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
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
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 DataForApps, 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 parameters passed in the URL of the GET request
        result array array of results
            api string name of the API
the list of APIs:
app_data
            status string current status
the list of possible current statuses:
major_outage
partial_outage
long_response_time
long_execution_time
webhook_delay
send_delay
            endpoints array array of objects that contain status information for API endpoints
                endpoint string name of the endpoint
the list of possible endpoints:
task_get
task_post
live
postback/pingback
                status string current status
the list of possible current statuses:
major_outage
partial_outage
long_response_time
long_execution_time
webhook_delay
send_delay