×

Documentation for API

Description of API methods for shell, php and python with an indication of examples of the use of.


Syntax for methods

List of used syntax for the names of the methods to the API. Where method is confusing depending on the applied action. For example for listing Your resources / websites you use the method sourceList().

methodInfoMethod for detail
methodListMethod for listing
methodAddMethod for adding
methodUpdateMethod for updating
methodSetMethod for set
methodDeleteMethod for deletion


Used conditions

List of conditions, which returns the API method

200OK The operation was performed without any errors, the requirement is successfully met.
204No Content The requirement was úspěsný, but his results are no data for the client.
304Not Modified The conditional request has been correctly processed, the document, however, from the given time has not been modified.
401Unauthorized If the original client request anonymous, must now be autentizován. If the requirement was autentizován, then was access denied.
403Forbidden The Server can not request, authorization was not successful.
404Not Found The Server did not find the specified URL.
409Conflict Indicates that the request cannot be completed due to a conflict.
500Server Error The server encountered an unexpected error.


An example of the output

Description klíců in the output with an example.

status Status Require
statusCode Kodový the name of the state Require
statusMessage Description of the status Require
data Data, which returns the method
found Number of results

For example, for the OK response, which returns the data:
 {'status'       : 200,
  'statusCode'   : 'OK',
  'statusMessage': 'OK',
  'data'         : [...],
  'found'        : 1
 }

An example for incorrect authorization.:
 {'status'       : 403,
  'statusCode'   : 'FORBIDDEN',
  'statusMessage': 'You dont have permission to access /api/methodName on this server',
 }

Example, where there are no data.:
 {'status'       : 404,
  'statusCode'   : 'NOT_FOUND',
  'statusMessage': 'Data not found',
 }

For example, for the incorrectly specified input parameters:
 {'status'       : 409,
  'statusCode'   : 'WRONG_ARG',
  'statusMessage': 'Wrong argument: ArgId must be input',
 }


API key

Your API key and examples of methods of using the keys


You don't have generated no API key.

List and add the new API keys, see " after logging in the administration of the : Overview of API keys


An example of a method call to extract the resources with the correct and incorrect API key::

Method Status
source.list( [API_KEY_OK] ) 200 OK
source.list( [API_KEY_ERR] ) 403 FORBIDDEN


Library

Python;

    git clone https://github.com/eSiUX/siux-python.git

PHP;

    git clone https://github.com/eSiUX/siux-php.git


API token

apikeyAdd Adding the API key
apikeyDelete Delete API keys
apikeyList The list of API keys

apikeyAdd

Adding the API key

GET /api/apikeyAdd
array apikeyAdd(  name, readOnly )
dict apikeyAdd(  name, readOnly )
Name Type Description
api_key string string str The API key
name string string str The name of the API key
readOnly boolean bool bool Only for reading? (0/1)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/apikeyAdd?api_key=${APIKEY}&name=&readOnly=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->apikeyAdd( $name='', $readOnly=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.apikeyAdd( name='', readOnly=0 )
pprint.pprint( ret )

apikeyDelete

Delete API keys

GET /api/apikeyDelete
array apikey.add(  apikeyId )
dict apikey.add(  apikeyId )
Name Type Description
api_key string string str The API key
apikeyId integer int int The ID of the API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/apikeyDelete?api_key=${APIKEY}&apikeyId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->apikeyDelete( $apikeyId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.apikeyDelete( apikeyId=0 )
pprint.pprint( ret )

apikeyList

The list of API keys

GET /api/apikeyList
array apikeyList(  )
dict apikeyList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/apikeyList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->apikeyList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.apikeyList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'apikey': 'f91667b60be9fd8af035bc2228b0798c',
'apikeyId': 64,
'name': 'api key #1',
'readonly': 0}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'apikey': 'f91667b60be9fd8af035bc2228b0798c',
'apikeyId': 64,
'name': 'api key #1',
'readonly': 0}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Availability

availabilityInfo Detail the availability of resources / web sites
availabilityList The availability of resources / web sites
 
availabilityHourlyList The availability of resources / web sites after hours

availabilityInfo

Detail the availability of resources / web sites

GET /api/availabilityInfo
array availabilityInfo(  date )
dict availabilityInfo(  date )
Name Type Description
api_key string string str The API key
date integer int int A date in the format YYYYMMDD

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/availabilityInfo?api_key=${APIKEY}&dateTo=20150901"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->availabilityInfo( $dateTo=20150901 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.availabilityInfo( dateTo=20150901 )
pprint.pprint( ret )

availabilityList

The availability of resources / web sites

GET /api/availabilityList
array availability.info(  date, history, sourceId )
dict availability.info(  date, history, sourceId )
Name Type Description
api_key string string str The API key
date integer int int A date in the format YYYYMMDD
history integer int int The number of the day into the history of the
sourceId integer int int Source ID, if not zadano so for all the resources of the client, etc sourceList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/availabilityList?api_key=${APIKEY}&dateInput=20150901&history=30&sourceId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->availabilityList( $dateInput=20150901, $history=30, $sourceId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.availabilityList( dateInput=20150901, history=30, sourceId=0 )
pprint.pprint( ret )

availabilityHourlyList

The availability of resources / web sites after hours

GET /api/availabilityHourlyList
array availabilityHourlyList(  date, history, view )
dict availabilityHourlyList(  date, history, view )
Name Type Description
api_key string string str The API key
date integer int int A date in the format YYYYMMDD
history integer int int The number of the day into the history of the
view string string str The type of view (hourOnly, hourDay)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/availabilityHourlyList?api_key=${APIKEY}&dateInput=20160201&history=30&view=hourOnly"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->availabilityHourlyList( $dateInput=20160201, $history=30, $view='hourOnly' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.availabilityHourlyList( dateInput=20160201, history=30, view='hourOnly' )
pprint.pprint( ret )

Browser

browserList A list of www prohlížeču for tests

browserList

A list of www prohlížeču for tests

GET /api/browserList
array browserList(  )
dict browserList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/browserList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->browserList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.browserList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'browser': 'adroid43',
'browserId': 16,
'familyName': 'android',
'name': 'Android 4.3 Jelly Bean'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'browser': 'adroid43',
'browserId': 16,
'familyName': 'android',
'name': 'Android 4.3 Jelly Bean'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Nodes

checkpointInfo Detail of the control point
checkpointList The list of control points

checkpointInfo

Detail of the control point

GET /api/checkpointInfo
array checkpoint.list(  checkpointId )
dict checkpoint.list(  checkpointId )
Name Type Description
api_key string string str The API key
checkpointId integer int int The Id of the control point

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/checkpointInfo?api_key=${APIKEY}&checkpointId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->checkpointInfo( $checkpointId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.checkpointInfo( checkpointId=0 )
pprint.pprint( ret )

checkpointList

The list of control points

GET /api/checkpointList
array checkpointList(  active )
dict checkpointList(  active )
Name Type Description
api_key string string str The API key
active integer int int 1 active, 0 inactive, -1 on all points

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/checkpointList?api_key=${APIKEY}&active=-1"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->checkpointList( $active=-1 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.checkpointList( active=-1 )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'checkpointId': 43,
'city': 'Montreal',
'connection': '10M',
'connectionName': '10Mbps',
'continent': 'am',
'continentName': 'America',
'country': 'ca',
'countryName': 'CA',
'description': 'Montreal, Canada',
'ip': '192.99.199.236',
'ipv6': 0,
'locality': 'Montreal, Canada',
'localityLat': '45.5601',
'localityLng': '-73.7121',
'name': 'montreal, ca',
'nickname': 'ca-montreal',
'seo': 'montreal-canada',
'status': 'active'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'checkpointId': 43,
'city': 'Montreal',
'connection': '10M',
'connectionName': '10Mbps',
'continent': 'am',
'continentName': 'America',
'country': 'ca',
'countryName': 'CA',
'description': 'Montreal, Canada',
'ip': '192.99.199.236',
'ipv6': 0,
'locality': 'Montreal, Canada',
'localityLat': '45.5601',
'localityLng': '-73.7121',
'name': 'montreal, ca',
'nickname': 'ca-montreal',
'seo': 'montreal-canada',
'status': 'active'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Country

countryList The list of countries

countryList

The list of countries

GET /api/countryList
array countryList(  )
dict countryList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/countryList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->countryList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.countryList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'continent': 'eu',
'continentId': 1,
'continentName': 'Europe',
'country': 'ad',
'countryId': 45,
'currency': 'eur',
'name': 'AD',
'vat': 0}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'continent': 'eu',
'continentId': 1,
'continentName': 'Europe',
'country': 'ad',
'countryId': 45,
'currency': 'eur',
'name': 'AD',
'vat': 0}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

They

deployAdd Add information about the deployment of the new version
deployInfo The Detail of the deployment
deployList A list of the deployment

deployAdd

Add information about the deployment of the new version

GET /api/deployAdd
array deployAdd(  tagId, vesion, environment, operatorId )
dict deployAdd(  tagId, vesion, environment, operatorId )
Name Type Description
api_key string string str The API key
tagId integer int int ID tag
version string string str Version
environment array array list Environment
operatorId integer int int User ID

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/deployAdd?api_key=${APIKEY}&tagId=0&version=&env=&operatorId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->deployAdd( $tagId=0, $version='', $env='', $operatorId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.deployAdd( tagId=0, version='', env='', operatorId=0 )
pprint.pprint( ret )

deployInfo

The Detail of the deployment

GET /api/deployInfo
array deployInfo(  deployId )
dict deployInfo(  deployId )
Name Type Description
api_key string string str The API key
deployUd integer int int The ID of the release

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/deployInfo?api_key=${APIKEY}&deployId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->deployInfo( $deployId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.deployInfo( deployId=0 )
pprint.pprint( ret )

deployList

A list of the deployment

GET /api/deployList
array deployList(  environments )
dict deployList(  environments )
Name Type Description
api_key string string str The API key
environments array array list Environment

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/deployList?api_key=${APIKEY}&environments*=&environments*="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->deployList( $environments=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.deployList( environments=[] )
pprint.pprint( ret )

Outages

dropoutInfo The list of shortfalls of resources / websites for the day
dropoutList The list of shortfalls in the resources / web sites

dropoutInfo

The list of shortfalls of resources / websites for the day

GET /api/dropoutInfo
array dropoutInfo(  dateTo )
dict dropoutInfo(  dateTo )
Name Type Description
api_key string string str The API key
dateTo integer int int A date in the format YYYYMMDD

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/dropoutInfo?api_key=${APIKEY}&dateTo=20150901"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->dropoutInfo( $dateTo=20150901 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.dropoutInfo( dateTo=20150901 )
pprint.pprint( ret )

dropoutList

The list of shortfalls in the resources / web sites

GET /api/dropoutList
array dropoutList(  dateInput, history )
dict dropoutList(  dateInput, history )
Name Type Description
api_key string string str The API key
dateInput integer int int A date in the format YYYYMMDD
history integer int int The number of the date backward (1,3,5,7,10,14,21,30)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/dropoutList?api_key=${APIKEY}&dateInput=2040101&history=7"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->dropoutList( $dateInput=2040101, $history=7 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.dropoutList( dateInput=2040101, history=7 )
pprint.pprint( ret )

An example of the output

{ 'data': { 'dateAvg': 1441058400.0,
'dateFrom': 1440799200.0,
'dateFromIso': '2015-08-29 00:00:00',
'dateInput': 1441058400.0,
'dateTo': 1441317600.0,
'dateToIso': '2015-09-04 00:00:00',
'dropoutDate': [ { 'cnt': 8, 'tsDate': 1440799200.0},
{ 'cnt': 7, 'tsDate': 1440885600.0},
{ 'cnt': 6, 'tsDate': 1441058400.0},
{ 'cnt': 5, 'tsDate': 1440972000.0},
{ 'cnt': 4, 'tsDate': 1441231200.0},
{ 'cnt': 3, 'tsDate': 1441144800.0}],
'dropoutSource': [ { 'cnt': 4,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1440799200},
{ 'cnt': 4,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1441058400},
{ 'cnt': 3,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1441231200},
{ 'cnt': 3,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1440885600},
{ 'cnt': 3,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1440972000},
{ 'cnt': 2,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1440885600},
{ 'cnt': 2,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1440799200},
{ 'cnt': 2,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1440885600},
{ 'cnt': 2,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1440799200},
{ 'cnt': 1,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1441058400},
{ 'cnt': 1,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1440972000},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1440972000},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1441058400},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1441231200},
{ 'cnt': 1,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1441144800},
{ 'cnt': 1,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1441144800},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1441144800}],
'dropoutStatus': [ { 'cnt': 32, 'statusCode': 612},
{ 'cnt': 1, 'statusCode': 502}],
'list': [ { 'cnt': 0,
'date': '2015-09-04',
'dateInt': 20150904,
'dateTs': 1441317600.0,
'dropout': []},
{ 'cnt': 4,
'date': '2015-09-03',
'dateInt': 20150903,
'dateTs': 1441231200.0,
'dropout': [ { 'checktime': 1441314135,
'cnt': 3,
'dateInt': '20150903',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1441292060,
'cnt': 1,
'dateInt': '20150903',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'}]},
{ 'cnt': 3,
'date': '2015-09-02',
'dateInt': 20150902,
'dateTs': 1441144800.0,
'dropout': [ { 'checktime': 1441219875,
'cnt': 1,
'dateInt': '20150902',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'},
{ 'checktime': 1441196800,
'cnt': 1,
'dateInt': '20150902',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1441187840,
'cnt': 1,
'dateInt': '20150902',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'}]},
{ 'cnt': 6,
'date': '2015-09-01',
'dateInt': 20150901,
'dateTs': 1441058400.0,
'dropout': [ { 'checktime': 1441117635,
'cnt': 4,
'dateInt': '20150901',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'},
{ 'checktime': 1441107280,
'cnt': 1,
'dateInt': '20150901',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'},
{ 'checktime': 1441073300,
'cnt': 1,
'dateInt': '20150901',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'}]},
{ 'cnt': 5,
'date': '2015-08-31',
'dateInt': 20150831,
'dateTs': 1440972000.0,
'dropout': [ { 'checktime': 1441052475,
'cnt': 1,
'dateInt': '20150831',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'},
{ 'checktime': 1441042130,
'cnt': 3,
'dateInt': '20150831',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1440989145,
'cnt': 1,
'dateInt': '20150831',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'}]},
{ 'cnt': 7,
'date': '2015-08-30',
'dateInt': 20150830,
'dateTs': 1440885600.0,
'dropout': [ { 'checktime': 1440957295,
'cnt': 2,
'dateInt': '20150830',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1440943315,
'cnt': 3,
'dateInt': '20150830',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'},
{ 'checktime': 1440915325,
'cnt': 2,
'dateInt': '20150830',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'}]},
{ 'cnt': 8,
'date': '2015-08-29',
'dateInt': 20150829,
'dateTs': 1440799200.0,
'dropout': [ { 'checktime': 1440867770,
'cnt': 2,
'dateInt': '20150829',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1440858520,
'cnt': 2,
'dateInt': '20150829',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'},
{ 'checktime': 1440855530,
'cnt': 4,
'dateInt': '20150829',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'}]}],
'sum': { 'dropoutCnt': 33, 'sourceCnt': 3},
'top_1': { 'cnt': 13,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz'},
'top_2': { 'cnt': 12,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz'},
'top_3': { 'cnt': 8,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz'}},
'found': 34,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': { 'dateAvg': 1441058400.0,
'dateFrom': 1440799200.0,
'dateFromIso': '2015-08-29 00:00:00',
'dateInput': 1441058400.0,
'dateTo': 1441317600.0,
'dateToIso': '2015-09-04 00:00:00',
'dropoutDate': [ { 'cnt': 8, 'tsDate': 1440799200.0},
{ 'cnt': 7, 'tsDate': 1440885600.0},
{ 'cnt': 6, 'tsDate': 1441058400.0},
{ 'cnt': 5, 'tsDate': 1440972000.0},
{ 'cnt': 4, 'tsDate': 1441231200.0},
{ 'cnt': 3, 'tsDate': 1441144800.0}],
'dropoutSource': [ { 'cnt': 4,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1440799200},
{ 'cnt': 4,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1441058400},
{ 'cnt': 3,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1441231200},
{ 'cnt': 3,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1440885600},
{ 'cnt': 3,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1440972000},
{ 'cnt': 2,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1440885600},
{ 'cnt': 2,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1440799200},
{ 'cnt': 2,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1440885600},
{ 'cnt': 2,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1440799200},
{ 'cnt': 1,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1441058400},
{ 'cnt': 1,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1440972000},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1440972000},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1441058400},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1441231200},
{ 'cnt': 1,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz',
'tsDate': 1441144800},
{ 'cnt': 1,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz',
'tsDate': 1441144800},
{ 'cnt': 1,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz',
'tsDate': 1441144800}],
'dropoutStatus': [ { 'cnt': 32, 'statusCode': 612},
{ 'cnt': 1, 'statusCode': 502}],
'list': [ { 'cnt': 0,
'date': '2015-09-04',
'dateInt': 20150904,
'dateTs': 1441317600.0,
'dropout': []},
{ 'cnt': 4,
'date': '2015-09-03',
'dateInt': 20150903,
'dateTs': 1441231200.0,
'dropout': [ { 'checktime': 1441314135,
'cnt': 3,
'dateInt': '20150903',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1441292060,
'cnt': 1,
'dateInt': '20150903',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'}]},
{ 'cnt': 3,
'date': '2015-09-02',
'dateInt': 20150902,
'dateTs': 1441144800.0,
'dropout': [ { 'checktime': 1441219875,
'cnt': 1,
'dateInt': '20150902',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'},
{ 'checktime': 1441196800,
'cnt': 1,
'dateInt': '20150902',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1441187840,
'cnt': 1,
'dateInt': '20150902',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'}]},
{ 'cnt': 6,
'date': '2015-09-01',
'dateInt': 20150901,
'dateTs': 1441058400.0,
'dropout': [ { 'checktime': 1441117635,
'cnt': 4,
'dateInt': '20150901',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'},
{ 'checktime': 1441107280,
'cnt': 1,
'dateInt': '20150901',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'},
{ 'checktime': 1441073300,
'cnt': 1,
'dateInt': '20150901',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'}]},
{ 'cnt': 5,
'date': '2015-08-31',
'dateInt': 20150831,
'dateTs': 1440972000.0,
'dropout': [ { 'checktime': 1441052475,
'cnt': 1,
'dateInt': '20150831',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'},
{ 'checktime': 1441042130,
'cnt': 3,
'dateInt': '20150831',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1440989145,
'cnt': 1,
'dateInt': '20150831',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'}]},
{ 'cnt': 7,
'date': '2015-08-30',
'dateInt': 20150830,
'dateTs': 1440885600.0,
'dropout': [ { 'checktime': 1440957295,
'cnt': 2,
'dateInt': '20150830',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1440943315,
'cnt': 3,
'dateInt': '20150830',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'},
{ 'checktime': 1440915325,
'cnt': 2,
'dateInt': '20150830',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'}]},
{ 'cnt': 8,
'date': '2015-08-29',
'dateInt': 20150829,
'dateTs': 1440799200.0,
'dropout': [ { 'checktime': 1440867770,
'cnt': 2,
'dateInt': '20150829',
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'url': 'http://www.centrum.cz'},
{ 'checktime': 1440858520,
'cnt': 2,
'dateInt': '20150829',
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'url': 'http://www.idnes.cz'},
{ 'checktime': 1440855530,
'cnt': 4,
'dateInt': '20150829',
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'url': 'http://www.seznam.cz'}]}],
'sum': { 'dropoutCnt': 33, 'sourceCnt': 3},
'top_1': { 'cnt': 13,
'sourceId': 33743,
'sourceName': 'www.seznam.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.seznam.cz'},
'top_2': { 'cnt': 12,
'sourceId': 33744,
'sourceName': 'www.centrum.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.centrum.cz'},
'top_3': { 'cnt': 8,
'sourceId': 33745,
'sourceName': 'www.idnes.cz',
'sourceType': 'http',
'sourceUrl': 'http://www.idnes.cz'}},
'found': 34,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Filters

filterAdd Add a filter
filterDelete Deletion filteru
filterExist Test the existence of a filter
filterInfo Detail filteru
filterList List filteru
 
filterViewList A list of the types of views

filterAdd

Add a filter

GET /api/filterAdd
array notify.link.add(  filterData, sourceIds )
dict notify.link.add(  filterData, sourceIds )
Name Type Description
api_key string string str The API key
filterData integer int int Input proměné
sourceIds integer int int ID resources / www sites

Argument: filterData

Name Type Description
name string string str The name of the filter
sourceType string string str Resource type (http/ ping/ socket/ ...)
sourceTypeValue string string str The value of which porovnavam [see source.type.value() ]
filterView string string str Type perspective (output/daily_summary)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/filterAdd?api_key=${APIKEY}&sourceIds*=&sourceIds*=&filterData_name=&filterData_sourceType=&filterData_sourceTypeValue=&filterData_filterView="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->filterAdd( $filterData=array(), $sourceIds=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.filterAdd( filterData={}, sourceIds=[] )
pprint.pprint( ret )

filterDelete

Deletion filteru

GET /api/filterDelete
array filter.delete  filterId )
dict filter.delete  filterId )
Name Type Description
api_key string string str The API key
filterId integer int int The ID of the filter

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/filterDelete?api_key=${APIKEY}&filterId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->filterDelete( $filterId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.filterDelete( filterId=0 )
pprint.pprint( ret )

filterExist

Test the existence of a filter

GET /api/filterExist
array filterExist(  filterData, sourceIds )
dict filterExist(  filterData, sourceIds )
Name Type Description
api_key string string str The API key
filterData integer int int Input proměné
sourceIds integer int int ID resources / www sites

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/filterExist?api_key=${APIKEY}&sourceIds*=&sourceIds*="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->filterExist( $filterData=array(), $sourceIds=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.filterExist( filterData={}, sourceIds=[] )
pprint.pprint( ret )

filterInfo

Detail filteru

GET /api/filterInfo
array filterInfo(  filterId )
dict filterInfo(  filterId )
Name Type Description
api_key string string str The API key
filterId integer int int The ID of the filter

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/filterInfo?api_key=${APIKEY}&filterId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->filterInfo( $filterId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.filterInfo( filterId=0 )
pprint.pprint( ret )

filterList

List filteru

GET /api/filterList
array filterList(  sourceId )
dict filterList(  sourceId )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/filterList?api_key=${APIKEY}&sourceId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->filterList( $sourceId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.filterList( sourceId=0 )
pprint.pprint( ret )

filterViewList

A list of the types of views

GET /api/filterViewList
array filterViewList(  )
dict filterViewList(  )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/filterViewList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->filterViewList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.filterViewList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'filterView': 'output',
'filterViewId': 1,
'filterViewName': 'Output data'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'filterView': 'output',
'filterViewId': 1,
'filterViewName': 'Output data'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Languages

langList The list of available languages

langList

The list of available languages

GET /api/langList
array langList(  )
dict langList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/langList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->langList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.langList( )
pprint.pprint( ret )

An example of the output

{ 'data': [{ 'lang': 'cz', 'langId': 1, 'name': 'Cesky'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [{ 'lang': 'cz', 'langId': 1, 'name': 'Cesky'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Notification

notifyAdd Add a contact for notification
notifyDeactive The setting of contact for the notification to inactive
notifyDelete Deletion of contact for the notification
notifyInfo Detail of contact for the notification
notifyList List of contacts for notification
notifyUpdate Updates of contact for the notification
 
notifyGroupAdd Add group notifications
notifyGroupDelete Deletion of the group notification
notifyGroupInfo Detail of the group notification
notifyGroupList The list of groups notifications
 
notifySenderInfo A list of sent notifications
notifySenderList A list of sent notifications after days

notifyAdd

Add a contact for notification

GET /api/notifyAdd
array notifyAdd(  name, value, parameter, contactGroup )
dict notifyAdd(  name, value, parameter, contactGroup )
Name Type Description
api_key string string str The API key
name string string str Name of contact for the notification
value string string str The value of contact for the notification
parameter struct associative array dict Other parameters
contactGroup array array list Group notifications

Argument: parameter

Name Type Description
contactType string string str Type of contact (email/sms/gtalk/icq)
status string string str Active/inactive contact (active/deactive)
lang string string str Language (cz/en/sk/de/ru/en/pl)
errorNo integer int int After the umpteenth time such to send the alert message?
warnOk string string str Send at the end of the report (yes/no/late)
contactView string string str View contact (admin/manager)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyAdd?api_key=${APIKEY}&name=&value=&contactGroup*=&contactGroup*=&parameter_contactType=&parameter_status=&parameter_lang=&parameter_errorNo=0&parameter_warnOk=&parameter_contactView="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyAdd( $name='', $value='', $parameter=array(), $contactGroup=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyAdd( name='', value='', parameter={}, contactGroup=[] )
pprint.pprint( ret )

notifyDeactive

The setting of contact for the notification to inactive

GET /api/notifyDeactive
array notifyDeactive(  value )
dict notifyDeactive(  value )
Name Type Description
api_key string string str The API key
value string string str The value of the notification

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyDeactive?api_key=${APIKEY}&value="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyDeactive( $value='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyDeactive( value='' )
pprint.pprint( ret )

notifyDelete

Deletion of contact for the notification

GET /api/notifyDelete
array notifyDelete(  contactId )
dict notifyDelete(  contactId )
Name Type Description
api_key string string str The API key
contactId integer int int ID of contact for the notification

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyDelete?api_key=${APIKEY}&contactId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyDelete( $contactId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyDelete( contactId=0 )
pprint.pprint( ret )

notifyInfo

Detail of contact for the notification

GET /api/notifyInfo
array notifyInfo(  contactId )
dict notifyInfo(  contactId )
Name Type Description
api_key string string str The API key
contactId integer int int ID of contact for the notification

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyInfo?api_key=${APIKEY}&contactId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyInfo( $contactId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyInfo( contactId=0 )
pprint.pprint( ret )

notifyList

List of contacts for notification

GET /api/notifyList
array notifyList(  status )
dict notifyList(  status )
Name Type Description
api_key string string str The API key
status string string str The status of the contact for the notification (active/deactive/all)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyList?api_key=${APIKEY}&status=all"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyList( $status='all' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyList( status='all' )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'check': 1,
'clientId': 985,
'contactId': 1250,
'contactType': 'email',
'contactTypeName': 'E-mail',
'contactView': 'manager',
'errorNo': 3,
'lang': 'cz',
'name': 'Prijemni1 Jmeno1',
'notifyId': 1250,
'status': 'deactive',
'value': 'test1@ni.cz',
'warnOk': 'yes'}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'check': 1,
'clientId': 985,
'contactId': 1250,
'contactType': 'email',
'contactTypeName': 'E-mail',
'contactView': 'manager',
'errorNo': 3,
'lang': 'cz',
'name': 'Prijemni1 Jmeno1',
'notifyId': 1250,
'status': 'deactive',
'value': 'test1@ni.cz',
'warnOk': 'yes'}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

notifyUpdate

Updates of contact for the notification

GET /api/notifyUpdate
array notifyUpdate(  contacId, parameter, contactGroup )
dict notifyUpdate(  contacId, parameter, contactGroup )
Name Type Description
api_key string string str The API key
contactId integer int int ID of contact for the notification
parameter struct associative array dict Other parameters
contactGroup array array list Group notifications

Argument: parameter

Name Type Description
contactType string string str Type of contact (email/sms/gtalk/icq)
status string string str Active/inactive contact (active/deactive)
lang string string str Language (cz/en/sk/de/ru/en/pl)
errorNo integer int int After the umpteenth time such to send the alert message?
warnOk string string str Send at the end of the report (yes/no/late)
contactView string string str View contact (admin/manager)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyUpdate?api_key=${APIKEY}&contactId=0&contactGroup*=&contactGroup*=&parameter_contactType=&parameter_status=&parameter_lang=&parameter_errorNo=0&parameter_warnOk=&parameter_contactView="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyUpdate( $contactId=0, $parameter=array(), $contactGroup=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyUpdate( contactId=0, parameter={}, contactGroup=[] )
pprint.pprint( ret )

notifyGroupAdd

Add group notifications

GET /api/notifyGroupAdd
array notifyGroupAdd(  name, parameter )
dict notifyGroupAdd(  name, parameter )
Name Type Description
api_key string string str The API key
name string string str The name of the contact
parameter struct associative array dict Other parameters

Argument: parameter

Name Type Description
description string string str Description

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyGroupAdd?api_key=${APIKEY}&name=&parameter_description="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyGroupAdd( $name='', $parameter=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyGroupAdd( name='', parameter={} )
pprint.pprint( ret )

notifyGroupDelete

Deletion of the group notification

GET /api/notifyGroupDelete
array notifyGroupDelete(  contactGroupId )
dict notifyGroupDelete(  contactGroupId )
Name Type Description
api_key string string str The API key
contactGroupId integer int int ID of the group notification

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyGroupDelete?api_key=${APIKEY}&contactGroupId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyGroupDelete( $contactGroupId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyGroupDelete( contactGroupId=0 )
pprint.pprint( ret )

notifyGroupInfo

Detail of the group notification

GET /api/notifyGroupInfo
array	notifyGroupInfo(  contactGroupId )
dict	notifyGroupInfo(  contactGroupId )
Name Type Description
api_key string string str The API key
contactGroupId integer int int ID of the group notification

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyGroupInfo?api_key=${APIKEY}&contactGroupId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyGroupInfo( $contactGroupId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyGroupInfo( contactGroupId=0 )
pprint.pprint( ret )

notifyGroupList

The list of groups notifications

GET /api/notifyGroupList
array notifyGroupList(  )
dict notifyGroupList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifyGroupList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifyGroupList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifyGroupList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'contactGroupId': 1010,
'description': 'Na jaky email, sms, ... zasilam varovne a OK zpravy?',
'name': 'Kontakty Test1 s.r.o',
'sourceGroup': [ { 'clientId': 985,
'contact': [ { 'active': '0',
'contactId': 1250,
'contactType': 'email',
'name': 'Prijemni1 Jmeno1',
'notifyId': 1250,
'value': 'test1@ni.cz'}],
'contactGroup': [ { 'checked': 1,
'contactGroupId': 1010,
'description': 'Na jaky email, sms, ... zasilam varovne a OK zpravy?',
'name': 'Kontakty Test1 s.r.o'},
{ 'checked': 0,
'contactGroupId': 1024,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1025,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1026,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1027,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1028,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1029,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1030,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1031,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1032,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1033,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1034,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1035,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1036,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1012,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1013,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1014,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1015,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1016,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1017,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1018,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1019,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1020,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1021,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1022,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1023,
'description': 'desc',
'name': 'name'}],
'contactGroupLink': [ { 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 1},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 2},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 3},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 4},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 5},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 6},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 0},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 1},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 2},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 3},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 4},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 5},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 6},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 0},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 1},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 2},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 3},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 4},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 5},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 6},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 0}],
'description': 'WWW adresy',
'errCnt': 1,
'minAvailability': 99.0,
'name': 'Skupina zdroju Test1 s.r.o',
'source': [ { 'name': 'name',
'sourceId': 33777,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33776,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33775,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33774,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33773,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33772,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33771,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33770,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33769,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33768,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33767,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33766,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33765,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33764,
'status': 'active'},
{ 'name': 'www.idnes.cz',
'sourceId': 33745,
'status': 'active'},
{ 'name': 'www.centrum.cz',
'sourceId': 33744,
'status': 'active'},
{ 'name': 'www.seznam.cz',
'sourceId': 33743,
'status': 'deactive'}],
'sourceGroupId': 5960,
'summaryDaily': 0,
'summaryDailyErr': 1,
'summaryHourlyErr': 1,
'summaryMonthly': 1,
'summaryWeekly': 0,
'testValue': [ { 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124021,
'weekday': 'Tuesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124027,
'weekday': 'Monday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124026,
'weekday': 'Sunday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124025,
'weekday': 'Saturday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124024,
'weekday': 'Friday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124023,
'weekday': 'Thursday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124022,
'weekday': 'Wednesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124034,
'weekday': 'Monday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124033,
'weekday': 'Sunday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124032,
'weekday': 'Saturday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124031,
'weekday': 'Friday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124030,
'weekday': 'Thursday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124029,
'weekday': 'Wednesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124028,
'weekday': 'Tuesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124040,
'weekday': 'Sunday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124039,
'weekday': 'Saturday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124038,
'weekday': 'Friday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124037,
'weekday': 'Thursday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124036,
'weekday': 'Wednesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124035,
'weekday': 'Tuesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124041,
'weekday': 'Monday',
'what': 'statusCode'}]}]}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'contactGroupId': 1010,
'description': 'Na jaky email, sms, ... zasilam varovne a OK zpravy?',
'name': 'Kontakty Test1 s.r.o',
'sourceGroup': [ { 'clientId': 985,
'contact': [ { 'active': '0',
'contactId': 1250,
'contactType': 'email',
'name': 'Prijemni1 Jmeno1',
'notifyId': 1250,
'value': 'test1@ni.cz'}],
'contactGroup': [ { 'checked': 1,
'contactGroupId': 1010,
'description': 'Na jaky email, sms, ... zasilam varovne a OK zpravy?',
'name': 'Kontakty Test1 s.r.o'},
{ 'checked': 0,
'contactGroupId': 1024,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1025,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1026,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1027,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1028,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1029,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1030,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1031,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1032,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1033,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1034,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1035,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1036,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1012,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1013,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1014,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1015,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1016,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1017,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1018,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1019,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1020,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1021,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1022,
'description': 'desc',
'name': 'name'},
{ 'checked': 0,
'contactGroupId': 1023,
'description': 'desc',
'name': 'name'}],
'contactGroupLink': [ { 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 1},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 2},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 3},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 4},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 5},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 6},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'weekday': 0},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 1},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 2},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 3},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 4},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 5},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 6},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'weekday': 0},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 1},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 2},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 3},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 4},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 5},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 6},
{ 'contactGroupId': 1010,
'contactGroupName': 'Kontakty Test1 s.r.o',
'endTime': '23:59:59',
'startTime': '00:00:01',
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'weekday': 0}],
'description': 'WWW adresy',
'errCnt': 1,
'minAvailability': 99.0,
'name': 'Skupina zdroju Test1 s.r.o',
'source': [ { 'name': 'name',
'sourceId': 33777,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33776,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33775,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33774,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33773,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33772,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33771,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33770,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33769,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33768,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33767,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33766,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33765,
'status': 'active'},
{ 'name': 'name',
'sourceId': 33764,
'status': 'active'},
{ 'name': 'www.idnes.cz',
'sourceId': 33745,
'status': 'active'},
{ 'name': 'www.centrum.cz',
'sourceId': 33744,
'status': 'active'},
{ 'name': 'www.seznam.cz',
'sourceId': 33743,
'status': 'deactive'}],
'sourceGroupId': 5960,
'summaryDaily': 0,
'summaryDailyErr': 1,
'summaryHourlyErr': 1,
'summaryMonthly': 1,
'summaryWeekly': 0,
'testValue': [ { 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124021,
'weekday': 'Tuesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124027,
'weekday': 'Monday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124026,
'weekday': 'Sunday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124025,
'weekday': 'Saturday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124024,
'weekday': 'Friday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124023,
'weekday': 'Thursday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 399,
'startTime': '00:00:00',
'startValue': 300,
'testStatus': 'warn',
'testStatusId': 2761,
'testStatusName': u'Varov\xe1n\xed',
'testValueId': 124022,
'weekday': 'Wednesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124034,
'weekday': 'Monday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124033,
'weekday': 'Sunday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124032,
'weekday': 'Saturday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124031,
'weekday': 'Friday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124030,
'weekday': 'Thursday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124029,
'weekday': 'Wednesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 599,
'startTime': '00:00:00',
'startValue': 400,
'testStatus': 'error',
'testStatusId': 2762,
'testStatusName': 'Chyba aplikace',
'testValueId': 124028,
'weekday': 'Tuesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124040,
'weekday': 'Sunday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124039,
'weekday': 'Saturday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124038,
'weekday': 'Friday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124037,
'weekday': 'Thursday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124036,
'weekday': 'Wednesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124035,
'weekday': 'Tuesday',
'what': 'statusCode'},
{ 'endTime': '23:59:59',
'endValue': 699,
'startTime': '00:00:00',
'startValue': 600,
'testStatus': 'fatal',
'testStatusId': 2763,
'testStatusName': u'Chyba u\u017eivatele',
'testValueId': 124041,
'weekday': 'Monday',
'what': 'statusCode'}]}]}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

notifySenderInfo

A list of sent notifications

GET /api/notifySenderInfo
array notifySenderInfo(  dateTo, view, from, step )
dict notifySenderInfo(  dateTo, view, from, step )
Name Type Description
api_key string string str The API key
dateTo integer int int A date in the format YYYYMMDD
view string string str The type of view (all/short)
from integer int int From what recordings the data display?
step VAR_TYPE_shell_intgeer VAR_TYPE_php_intgeer VAR_TYPE_python_intgeer The number of record per page

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifySenderInfo?api_key=${APIKEY}&dateTo=20150101&view=all&From=0&step=20"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifySenderInfo( $dateTo=20150101, $view='all', $From=0, $step=20 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifySenderInfo( dateTo=20150101, view='all', From=0, step=20 )
pprint.pprint( ret )

notifySenderList

A list of sent notifications after days

GET /api/notifySenderList
array notifySenderList(  dateTo, history )
dict notifySenderList(  dateTo, history )
Name Type Description
api_key string string str The API key
dateTo integer int int A date in the format YYYYMMDD
view integer int int History - the number of days

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/notifySenderList?api_key=${APIKEY}&dateTo=20160101&history=30"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->notifySenderList( $dateTo=20160101, $history=30 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.notifySenderList( dateTo=20160101, history=30 )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438552800'}],
'ts': 1438552800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438639200'}],
'ts': 1438639200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438725600'}],
'ts': 1438725600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438812000'}],
'ts': 1438812000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438898400'}],
'ts': 1438898400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438984800'}],
'ts': 1438984800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439071200'}],
'ts': 1439071200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439157600'}],
'ts': 1439157600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439244000'}],
'ts': 1439244000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439330400'}],
'ts': 1439330400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439416800'}],
'ts': 1439416800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439503200'}],
'ts': 1439503200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439589600'}],
'ts': 1439589600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439676000'}],
'ts': 1439676000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439762400'}],
'ts': 1439762400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439848800'}],
'ts': 1439848800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439935200'}],
'ts': 1439935200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440021600'}],
'ts': 1440021600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440108000'}],
'ts': 1440108000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440194400'}],
'ts': 1440194400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440280800'}],
'ts': 1440280800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440367200'}],
'ts': 1440367200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440453600'}],
'ts': 1440453600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440540000'}],
'ts': 1440540000},
{ 'cnt': 2,
'rows': [ { 'cnt': 2,
'notifyType': 'email',
'notifyValue': 'test1@ni.cz',
'tsDate': 1440626400}],
'ts': 1440626400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440712800'}],
'ts': 1440712800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440799200'}],
'ts': 1440799200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440885600'}],
'ts': 1440885600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440972000'}],
'ts': 1440972000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1441058400'}],
'ts': 1441058400}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438552800'}],
'ts': 1438552800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438639200'}],
'ts': 1438639200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438725600'}],
'ts': 1438725600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438812000'}],
'ts': 1438812000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438898400'}],
'ts': 1438898400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1438984800'}],
'ts': 1438984800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439071200'}],
'ts': 1439071200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439157600'}],
'ts': 1439157600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439244000'}],
'ts': 1439244000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439330400'}],
'ts': 1439330400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439416800'}],
'ts': 1439416800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439503200'}],
'ts': 1439503200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439589600'}],
'ts': 1439589600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439676000'}],
'ts': 1439676000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439762400'}],
'ts': 1439762400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439848800'}],
'ts': 1439848800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1439935200'}],
'ts': 1439935200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440021600'}],
'ts': 1440021600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440108000'}],
'ts': 1440108000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440194400'}],
'ts': 1440194400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440280800'}],
'ts': 1440280800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440367200'}],
'ts': 1440367200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440453600'}],
'ts': 1440453600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440540000'}],
'ts': 1440540000},
{ 'cnt': 2,
'rows': [ { 'cnt': 2,
'notifyType': 'email',
'notifyValue': 'test1@ni.cz',
'tsDate': 1440626400}],
'ts': 1440626400},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440712800'}],
'ts': 1440712800},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440799200'}],
'ts': 1440799200},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440885600'}],
'ts': 1440885600},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1440972000'}],
'ts': 1440972000},
{ 'cnt': 0,
'rows': [{ 'cnt': 0, 'tsDate': '1441058400'}],
'ts': 1441058400}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Operators

operatorInfo The Detail of the user
operatorList The list of users
 
operatorLangSet The language settings
 
operatorLogList The history of user login

operatorInfo

The Detail of the user

GET /api/operatorInfo
array operatorInfo( Id, operatorId )
dict operatorInfo( Id, operatorId )
Name Type Description
api_key string string str The API key
operatorId integer int int The user ID, etc operatorList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/operatorInfo?api_key=${APIKEY}&operatorId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->operatorInfo( $operatorId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.operatorInfo( operatorId=0 )
pprint.pprint( ret )

operatorList

The list of users

GET /api/operatorList
array operatorList(  )
dict operatorList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/operatorList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->operatorList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.operatorList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'email': 'test1@ni.cz',
'ip': None,
'lang': 'cs',
'langId': 5,
'login': 'test1@ni.cz',
'name': 'Jmeno1',
'operatorId': 1937,
'operatorView': 'manager',
'role': 'admin',
'status': 'active',
'surname': 'Prijemni1',
'tsLastLogin': 1440183840}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'email': 'test1@ni.cz',
'ip': None,
'lang': 'cs',
'langId': 5,
'login': 'test1@ni.cz',
'name': 'Jmeno1',
'operatorId': 1937,
'operatorView': 'manager',
'role': 'admin',
'status': 'active',
'surname': 'Prijemni1',
'tsLastLogin': 1440183840}],
'found': 1,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

operatorLangSet

The language settings

GET /api/operatorLangSet
array operatorLangSet(  operatorId, lang )
dict operatorLangSet(  operatorId, lang )
Name Type Description
api_key string string str The API key
operatorId integer int int The user ID, etc operatorList()
lang struct associative array dict Language

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/operatorLangSet?api_key=${APIKEY}&operatorId=0&lang="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->operatorLangSet( $operatorId=0, $lang='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.operatorLangSet( operatorId=0, lang='' )
pprint.pprint( ret )

operatorLogList

The history of user login

GET /api/operatorLogList
array operatorLogList(  operatorId )
dict operatorLogList(  operatorId )
Name Type Description
api_key string string str The API key
operatorId integer int int The user ID, etc operatorList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/operatorLogList?api_key=${APIKEY}&operatorId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->operatorLogList( $operatorId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.operatorLogList( operatorId=0 )
pprint.pprint( ret )

The RUM measurement

 
rumOutputInfo API_rum_output_info_DESC

rumOutputInfo

API_rum_output_info_DESC

GET /api/rumOutputInfo
 
 

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/rumOutputInfo?api_key=${APIKEY}&sourceId=0&date=2015-09-01&outputId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->rumOutputInfo( $sourceId=0, $date='2015-09-01', $outputId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.rumOutputInfo( sourceId=0, date='2015-09-01', outputId=0 )
pprint.pprint( ret )

Browser tests

seleniumAdd Adding a selenium test
seleniumInfo Detail of a selenium test
seleniumList A list of selenium tests
seleniumUpdate Update selenium test
 
seleniumAdvancedAdd The addition of the advanced test
seleniumAdvancedInfo Detail for the advanced test
seleniumAdvancedList List of advanced tests
 
seleniumOutputInfo The Detail of the results of the tests
 
seleniumTestAdd Adding a new test
seleniumTestInfo Detail for selenium test
seleniumTestList A list of selenium tests

seleniumAdd

Adding a selenium test

GET /api/seleniumAdd
array seleniumAdd(  name, browser, timeout, testType, testIds, paramJS, paramScreen )
dict seleniumAdd(  name, browser, timeout, testType, testIds, paramJS, paramScreen )
Name Type Description
api_key string string str The API key
name string string str The name of the unit test
browser string string str Browser, that test will have
timeout integer int int Max. time to perform the test
testType string string str Test type (content/stepbystep)
testIds array array list ID test
paramJS integer int int Enable/disable JS (0/1)
paramScreen string string str Make a screenshot of the screen (all - always/err - only pri such/"" - never)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumAdd?api_key=${APIKEY}&name=&browser=chromelin&timeout=30&testType=content&testIds*=&testIds*=&paramJS=1&paramScreen="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumAdd( $name='', $browser='chromelin', $timeout=30, $testType='content', $testIds=array(), $paramJS=1, $paramScreen='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumAdd( name='', browser='chromelin', timeout=30, testType='content', testIds=[], paramJS=1, paramScreen='' )
pprint.pprint( ret )

seleniumInfo

Detail of a selenium test

GET /api/seleniumInfo
array selenium.list(  seleniumId )
dict selenium.list(  seleniumId )
Name Type Description
api_key string string str The API key
seleniumId integer int int ID of the test, etc seleniumList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumInfo?api_key=${APIKEY}&seleniumId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumInfo( $seleniumId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumInfo( seleniumId=0 )
pprint.pprint( ret )

seleniumList

A list of selenium tests

GET /api/seleniumList
array seleniumList(  )
dict seleniumList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumList( )
pprint.pprint( ret )

seleniumUpdate

Update selenium test

GET /api/seleniumUpdate
array seleniumUpdate(  seleniumId, name, browser, timeout, testType, testIds, status, paramJS, paramScreen )
dict seleniumUpdate(  seleniumId, name, browser, timeout, testType, testIds, status, paramJS, paramScreen )
Name Type Description
api_key string string str The API key
seleniumId integer int int ID of the test, etc seleniumList()
name string string str The name of the unit test
browser string string str Browser, that test will have
timeout integer int int Max. time to perform the test
testType string string str Test type (content/stepbystep)
testIds array array list ID test
status string string str The status of the active/deactive
paramJS integer int int Enable/disable JS (0/1)
paramScreen string string str Make a screenshot of the screen (all - always/err - only pri such/"" - never)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumUpdate?api_key=${APIKEY}&seleniumId=0&name=&browser=chromelin&timeout=30&testType=content&testIds*=&testIds*=&status=active&paramJS=1&paramScreen="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumUpdate( $seleniumId=0, $name='', $browser='chromelin', $timeout=30, $testType='content', $testIds=array(), $status='active', $paramJS=1, $paramScreen='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumUpdate( seleniumId=0, name='', browser='chromelin', timeout=30, testType='content', testIds=[], status='active', paramJS=1, paramScreen='' )
pprint.pprint( ret )

seleniumAdvancedAdd

The addition of the advanced test

GET /api/seleniumAdvancedAdd
array seleniumAdvancedAdd(  name, desc, code, nickname, inputUrl, targetUrl )
dict seleniumAdvancedAdd(  name, desc, code, nickname, inputUrl, targetUrl )
Name Type Description
api_key string string str The API key
name string string str The name of the advanced test
desc string string str A description of the advanced test
code string string str The code of the test
nickname string string str Abbreviation
inpurUrl string string str Landing page URL
targetUr string string str The URL of the target site

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumAdvancedAdd?api_key=${APIKEY}&name=&desc=&code=&nickname=&inputUrl=&targetUrl="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumAdvancedAdd( $name='', $desc='', $code='', $nickname='', $inputUrl='', $targetUrl='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumAdvancedAdd( name='', desc='', code='', nickname='', inputUrl='', targetUrl='' )
pprint.pprint( ret )

seleniumAdvancedInfo

Detail for the advanced test

GET /api/seleniumAdvancedInfo
array seleniumAdvancedInfo(  advancedId )
dict seleniumAdvancedInfo(  advancedId )
Name Type Description
api_key string string str The API key
advancedId integer int int ID of the advanced test

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumAdvancedInfo?api_key=${APIKEY}&advancedId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumAdvancedInfo( $advancedId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumAdvancedInfo( advancedId=0 )
pprint.pprint( ret )

seleniumAdvancedList

List of advanced tests

GET /api/seleniumAdvancedList
array seleniumAdvancedList(  )
dict seleniumAdvancedList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumAdvancedList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumAdvancedList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumAdvancedList( )
pprint.pprint( ret )

seleniumOutputInfo

The Detail of the results of the tests

GET /api/seleniumOutputInfo
array seleniumOutputInfo(  seleniumId, date )
dict seleniumOutputInfo(  seleniumId, date )
Name Type Description
api_key string string str The API key
seleniumId integer int int ID of the test, etc seleniumList()
date string string str A date in the format YYYY-MM-DD

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumOutputInfo?api_key=${APIKEY}&seleniumId=0&date=2015-01-01"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumOutputInfo( $seleniumId=0, $date='2015-01-01' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumOutputInfo( seleniumId=0, date='2015-01-01' )
pprint.pprint( ret )

seleniumTestAdd

Adding a new test

GET /api/seleniumTestAdd
array seleniumTestAdd(  urlInput, searchType, searchValue, urlTarget, advancedId )
dict seleniumTestAdd(  urlInput, searchType, searchValue, urlTarget, advancedId )
Name Type Description
api_key string string str The API key
urlInput string string str Input the url, the where check content
searchType string string str Search type
searchValue string string str Value for search
urltarget string string str Target Url
advancedId integer int int Advanced test Id

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumTestAdd?api_key=${APIKEY}&urlInput=&searchType=css_selector&searchValue=&urlTarget=&advancedId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumTestAdd( $urlInput='', $searchType='css_selector', $searchValue='', $urlTarget='', $advancedId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumTestAdd( urlInput='', searchType='css_selector', searchValue='', urlTarget='', advancedId=0 )
pprint.pprint( ret )

seleniumTestInfo

Detail for selenium test

GET /api/seleniumTestInfo
array seleniumTestInfo(  seleniumTestId )
dict seleniumTestInfo(  seleniumTestId )
Name Type Description
api_key string string str The API key
seleniumTestId integer int int ID test

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumTestInfo?api_key=${APIKEY}&seleniumTestId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumTestInfo( $seleniumTestId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumTestInfo( seleniumTestId=0 )
pprint.pprint( ret )

seleniumTestList

A list of selenium tests

GET /api/seleniumTestList
array seleniumTestList(  )
dict seleniumTestList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/seleniumTestList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->seleniumTestList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.seleniumTestList( )
pprint.pprint( ret )

An example of the output

{ 'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Resources

sourceActive The settings of the resources / websites to active
sourceAdd Adding a resource / web page
sourceDeactive Settings resources / web pages on the inactive
sourceInfo The Detail of the resources / websites for monitoring
sourceList A list of resources / websites for monitoring
sourceUpdate Update the resources / websites
 
sourceDropoutInfo The list of shortfalls of resources / websites for the day
sourceDropoutList The list of shortfalls in the resources / web sites
 
sourceGroupAdd Adding a group of resources / web sites
sourceGroupDelete Deleting a group of resources / web sites
sourceGroupInfo The Detail of the group's resources / www sites
sourceGroupList Resource group / www
sourceGroupUpdate Update the parameters for the group of resources
 
sourceOutputGroup The list of measured data for one selected minute, which was groupována
sourceOutputHeaderInfo Header for the result of the measurement
sourceOutputInfo A list of the measured data for the resource / web page
 
sourceStatDailyList Daily statistics resources / www sites
sourceStatMonthlyList Monthly statistics of resources / web sites
sourceStatWeeklyList Weekly statistics resources / www sites
 
sourceVideoInfo The result of the measurement for the video

sourceActive

The settings of the resources / websites to active

GET /api/sourceActive
array sourceActive(  sourceId )
dict sourceActive(  sourceId )
Name Type Description
api_key string string str The API key
sourceId string string str ID resources / websites, etc sourceList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceActive?api_key=${APIKEY}&sourceId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceActive( $sourceId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceActive( sourceId=0 )
pprint.pprint( ret )

sourceAdd

Adding a resource / web page

GET /api/sourceAdd
array sourceAdd(  sourceGroupId, name, url, parameter )
dict sourceAdd(  sourceGroupId, name, url, parameter )
Name Type Description
api_key string string str The API key
sourceGroupId integer int int Group ID of resources / websites, etc sourceGroupList()
name string string str The name of the monitored resources
url string string str URL of resource / web page
parameter struct associative array dict Other parameters

Argument: parameter

Name Type Description
sourceType string string str Resource type (http/ ping/ socket/ ...)
parentId integer int int The parent of the monitored resources
timeSchemeId integer int int ID time plan (optional), etc. timeSchemeList()
timeout integer int int Timeout (s) for the error. Max. value is 30s [default is 3s]
timeoutWarn integer int int Timeout (s) for the warning. Max value is 10s. [default is 1s]
tag array array list The list of tags (with their ID)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceAdd?api_key=${APIKEY}&sourceGroupId=0&name=&url=&parameter_sourceType=&parameter_parentId=0&parameter_timeSchemeId=0&parameter_timeout=0&parameter_timeoutWarn=0&parameter_tag="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceAdd( $sourceGroupId=0, $name='', $url='', $parameter=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceAdd( sourceGroupId=0, name='', url='', parameter={} )
pprint.pprint( ret )

sourceDeactive

Settings resources / web pages on the inactive

GET /api/sourceDeactive
array sourceDeactive(  sourceId )
dict sourceDeactive(  sourceId )
Name Type Description
api_key string string str The API key
sourceId string string str ID resources / websites, etc sourceList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceDeactive?api_key=${APIKEY}&sourceId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceDeactive( $sourceId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceDeactive( sourceId=0 )
pprint.pprint( ret )

sourceInfo

The Detail of the resources / websites for monitoring

GET /api/sourceInfo
array sourceInfo( Id, sourceId )
dict sourceInfo( Id, sourceId )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceInfo?api_key=${APIKEY}&sourceId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceInfo( $sourceId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceInfo( sourceId=0 )
pprint.pprint( ret )

sourceList

A list of resources / websites for monitoring

GET /api/sourceList
array sourceList(  sourceGroupId, tagId )
dict sourceList(  sourceGroupId, tagId )
Name Type Description
api_key string string str The API key
sourceGroupId integer int int The ID of the resource group / www
tagId integer int int ID tag

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceList?api_key=${APIKEY}&sourceGroupId=0&tagId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceList( $sourceGroupId=0, $tagId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceList( sourceGroupId=0, tagId=0 )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'clientId': 985,
'domainId': 19,
'lastChecktime': 1458681192,
'lastErrChecktime': 1458124850,
'lastErrNo': 0,
'lastErrStatusCode': 614,
'lastErrStatusText': 'Operation timed out after 20000 milliseconds with 0 bytes receiv',
'lastIncidentChecktime': 0,
'lastIncidentStatusCode': 0,
'lastIncidentStatusText': '',
'lastOkChecktime': 1458681192,
'lastStatusCode': 200,
'lastStatusText': 'OK',
'name': 'name',
'parentId': '',
'sourceId': 33764,
'sourceType': 'http',
'sourceTypeName': 'HTTP',
'status': 'active',
'timeout': 10,
'timeoutErr': 10,
'timeoutWarn': 1,
'tsCreate': 1420066800,
'tsUpdate': 1420066800,
'url': 'http://www.seznam.cz',
'urlNice': 'www.seznam.cz'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'clientId': 985,
'domainId': 19,
'lastChecktime': 1458681192,
'lastErrChecktime': 1458124850,
'lastErrNo': 0,
'lastErrStatusCode': 614,
'lastErrStatusText': 'Operation timed out after 20000 milliseconds with 0 bytes receiv',
'lastIncidentChecktime': 0,
'lastIncidentStatusCode': 0,
'lastIncidentStatusText': '',
'lastOkChecktime': 1458681192,
'lastStatusCode': 200,
'lastStatusText': 'OK',
'name': 'name',
'parentId': '',
'sourceId': 33764,
'sourceType': 'http',
'sourceTypeName': 'HTTP',
'status': 'active',
'timeout': 10,
'timeoutErr': 10,
'timeoutWarn': 1,
'tsCreate': 1420066800,
'tsUpdate': 1420066800,
'url': 'http://www.seznam.cz',
'urlNice': 'www.seznam.cz'}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

sourceUpdate

Update the resources / websites

GET /api/sourceUpdate
array sourceUpdate(  sourceId, sourceDict )
dict sourceUpdate(  sourceId, sourceDict )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc. sourceList()
sourceDict struct associative array dict The parameters of the sources / websites

Argument: sourceDict

Name Type Description
url string string str The URL address
timeout integer int int The time limit for the error
timeoutWarn integer int int The time limit for the warning
sourceGroupId integer int int The ID of the resource group, etc. sourceGroupList()
name string string str The name of the resource
paramHeaderOnly boolean bool bool For HTTP(S) to inquire about using the HEAD
paramSearch string string str Search text in page
paramIPv6 boolean bool bool IPv6 prefer for HTTP(S)
browserId integer int int ID of the browser, etc. browserList()

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceUpdate?api_key=${APIKEY}&sourceId=0&sourceDict_url=&sourceDict_timeout=0&sourceDict_timeoutWarn=0&sourceDict_sourceGroupId=0&sourceDict_name=&sourceDict_paramHeaderOnly=&sourceDict_paramSearch=&sourceDict_paramIPv6=&sourceDict_browserId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceUpdate( $sourceId=0, $sourceDict=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceUpdate( sourceId=0, sourceDict={} )
pprint.pprint( ret )

sourceDropoutInfo

The list of shortfalls of resources / websites for the day

GET /api/sourceDropoutInfo
array sourceDropoutInfo(  sourceId, date )
dict sourceDropoutInfo(  sourceId, date )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
date string string str A date in the format YYYY-MM-DD

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceDropoutInfo?api_key=${APIKEY}&sourceId=0&date=2015-09-01"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceDropoutInfo( $sourceId=0, $date='2015-09-01' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceDropoutInfo( sourceId=0, date='2015-09-01' )
pprint.pprint( ret )

sourceDropoutList

The list of shortfalls in the resources / web sites

GET /api/sourceDropoutList
array sourceDropoutList(  sourceId, history )
dict sourceDropoutList(  sourceId, history )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
history integer int int History: how Many a day backwards

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceDropoutList?api_key=${APIKEY}&sourceId=0&history=7"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceDropoutList( $sourceId=0, $history=7 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceDropoutList( sourceId=0, history=7 )
pprint.pprint( ret )

sourceGroupAdd

Adding a group of resources / web sites

GET /api/sourceGroupAdd
array sourceGroupAdd(  name, parameter )
dict sourceGroupAdd(  name, parameter )
Name Type Description
api_key string string str The API key
name string string str The name of the group of monitored resources
parameter struct associative array dict Other parameters

Argument: parameter

Name Type Description
description string string str Description
minAvailability integer int int Min. availability (99%)
contactGroupId integer int int ID of the group notification
errCnt integer int int After the umpteenth time of the coherent error is the unavailability reflected in the statistics?
summaryMonthly boolean bool bool Monthly report (0/1)
summaryWeekly boolean bool bool Tydenní report (0/1)
summaryDaily boolean bool bool Daily report (0/1)
summaryDailyErr boolean bool bool The daily report in the reports (0/1)
summaryHourlyErr VAR_TYPE_shell_tinyint VAR_TYPE_php_tinyint VAR_TYPE_python_tinyint Hodinnový report in the reports (0/1)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceGroupAdd?api_key=${APIKEY}&name=&parameter_description=&parameter_minAvailability=0&parameter_contactGroupId=0&parameter_errCnt=0&parameter_summaryMonthly=&parameter_summaryWeekly=&parameter_summaryDaily=&parameter_summaryDailyErr=&parameter_summaryHourlyErr="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceGroupAdd( $name='', $parameter=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceGroupAdd( name='', parameter={} )
pprint.pprint( ret )

sourceGroupDelete

Deleting a group of resources / web sites

GET /api/sourceGroupDelete
array sourceGroupDelete(  sourceGroupId )
dict sourceGroupDelete(  sourceGroupId )
Name Type Description
api_key string string str The API key
sourceGroupId integer int int The ID of the resource group / www

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceGroupDelete?api_key=${APIKEY}&sourceGroupId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceGroupDelete( $sourceGroupId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceGroupDelete( sourceGroupId=0 )
pprint.pprint( ret )

sourceGroupInfo

The Detail of the group's resources / www sites

GET /api/sourceGroupInfo
array sourceGroupInfo(  sourceGroupId )
dict sourceGroupInfo(  sourceGroupId )
Name Type Description
api_key string string str The API key
sourceGroupId integer int int The ID of the resource group / www

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceGroupInfo?api_key=${APIKEY}&sourceGroupId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceGroupInfo( $sourceGroupId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceGroupInfo( sourceGroupId=0 )
pprint.pprint( ret )

sourceGroupList

Resource group / www

GET /api/sourceGroupList
array sourceGroupList(  )
dict sourceGroupList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceGroupList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceGroupList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceGroupList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'contactGroup': [ { 'clientId': 985,
'contact': [ { 'contactId': 1250,
'name': 'Prijemni1 Jmeno1',
'notifyId': 1250,
'status': 'deactive'}],
'contactGroupId': 1010,
'description': 'Na jaky email, sms, ... zasilam varovne a OK zpravy?',
'name': 'Kontakty Test1 s.r.o'}],
'description': 'WWW adresy',
'minAvailability': 99.0,
'name': 'Skupina zdroju Test1 s.r.o',
'sourceGroupId': 5960,
'summaryDaily': 0,
'summaryDailyErr': 1,
'summaryHourlyErr': 1,
'summaryMonthly': 1,
'summaryWeekly': 0}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'contactGroup': [ { 'clientId': 985,
'contact': [ { 'contactId': 1250,
'name': 'Prijemni1 Jmeno1',
'notifyId': 1250,
'status': 'deactive'}],
'contactGroupId': 1010,
'description': 'Na jaky email, sms, ... zasilam varovne a OK zpravy?',
'name': 'Kontakty Test1 s.r.o'}],
'description': 'WWW adresy',
'minAvailability': 99.0,
'name': 'Skupina zdroju Test1 s.r.o',
'sourceGroupId': 5960,
'summaryDaily': 0,
'summaryDailyErr': 1,
'summaryHourlyErr': 1,
'summaryMonthly': 1,
'summaryWeekly': 0}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

sourceGroupUpdate

Update the parameters for the group of resources

GET /api/sourceGroupUpdate
array sourceGroupUpdate(  sourceGroupId, parameter )
dict sourceGroupUpdate(  sourceGroupId, parameter )
Name Type Description
api_key string string str The API key
name string string str The name of the group of monitored resources
parameter struct associative array dict Other parameters

Argument: parameter

Name Type Description
description string string str Description
minAvailability integer int int Min. availability (99%)
contactGroupId integer int int ID of the group notification
errCnt integer int int After the umpteenth time of the coherent error is the unavailability reflected in the statistics?
summaryMonthly boolean bool bool Monthly report (0/1)
summaryWeekly boolean bool bool Tydenní report (0/1)
summaryDaily boolean bool bool Daily report (0/1)
summaryDailyErr boolean bool bool The daily report in the reports (0/1)
summaryHourlyErr VAR_TYPE_shell_tinyint VAR_TYPE_php_tinyint VAR_TYPE_python_tinyint Hodinnový report in the reports (0/1)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceGroupUpdate?api_key=${APIKEY}&sourceGroupId=0&parameter_description=&parameter_minAvailability=0&parameter_contactGroupId=0&parameter_errCnt=0&parameter_summaryMonthly=&parameter_summaryWeekly=&parameter_summaryDaily=&parameter_summaryDailyErr=&parameter_summaryHourlyErr="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceGroupUpdate( $sourceGroupId=0, $parameter=array() );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceGroupUpdate( sourceGroupId=0, parameter={} )
pprint.pprint( ret )

sourceOutputGroup

The list of measured data for one selected minute, which was groupována

GET /api/sourceOutputGroup
array sourceOutputGroup(  sourceId, tsGroup )
dict sourceOutputGroup(  sourceId, tsGroup )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
tsGroup integer int int Time groupování

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceOutputGroup?api_key=${APIKEY}&sourceId=0&tsGroup=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceOutputGroup( $sourceId=0, $tsGroup=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceOutputGroup( sourceId=0, tsGroup=0 )
pprint.pprint( ret )

sourceOutputHeaderInfo

Header for the result of the measurement

GET /api/sourceOutputHeaderInfo
array sourceOutputHeaderInfo(  sourceId, date, outputId )
dict sourceOutputHeaderInfo(  sourceId, date, outputId )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
date string string str A date in the format YYYY-MM-DD
outputId integer int int ID of the result

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceOutputHeaderInfo?api_key=${APIKEY}&sourceId=0&date=2015-01-01&outputId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceOutputHeaderInfo( $sourceId=0, $date='2015-01-01', $outputId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceOutputHeaderInfo( sourceId=0, date='2015-01-01', outputId=0 )
pprint.pprint( ret )

sourceOutputInfo

A list of the measured data for the resource / web page

GET /api/sourceOutputInfo
array sourceOutputInfo(  sourceId, date, limit, FromId, outputId, countrys, checkpointIds, dataView )
dict sourceOutputInfo(  sourceId, date, limit, FromId, outputId, countrys, checkpointIds, dataView )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
date string string str A date in the format YYYY-MM-DD
limit integer int int Max. the number of results
fromId integer int int From what ID, we'll display the data
outputId integer int int ID detail
countrys array array list ID of the countries of the control points, for which I want to see results, etc countryList()
checkpointIds array array list The ID of the control point from which I want to see results, etc checkpointList()
dataView string string str The type of view (short/all)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceOutputInfo?api_key=${APIKEY}&sourceId=0&date=2015-09-01&limit=2000&FromId=0&outputId=0&countrys*=&countrys*=&checkpointIds*=&checkpointIds*=&dataView=all"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceOutputInfo( $sourceId=0, $date='2015-09-01', $limit=2000, $FromId=0, $outputId=0, $countrys=array(), $checkpointIds=array(), $dataView='all' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceOutputInfo( sourceId=0, date='2015-09-01', limit=2000, FromId=0, outputId=0, countrys=[], checkpointIds=[], dataView='all' )
pprint.pprint( ret )

sourceStatDailyList

Daily statistics resources / www sites

GET /api/sourceStatDailyList
array sourceStatDailyList(  sourceId, date )
dict sourceStatDailyList(  sourceId, date )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
date string string str A date in the format YYYY-MM

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceStatDailyList?api_key=${APIKEY}&sourceId=0&date=2001-01"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceStatDailyList( $sourceId=0, $date='2001-01' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceStatDailyList( sourceId=0, date='2001-01' )
pprint.pprint( ret )

An example of the output

{ 'data': { 'browser': 'ie10',
'browserFamilyName': 'ie',
'browserId': 1,
'browserName': 'Windows: Internet explorer 10',
'clientId': 985,
'clientName': 'Test1 s.r.o',
'clientPay': 1,
'domainId': 19,
'googleGaProfileId': 0,
'googleGaTsCreate': 0,
'hash': '',
'lastChecktime': 0,
'lastErrChecktime': 1441636430,
'lastErrNo': 0,
'lastErrStatusCode': 612,
'lastErrStatusMessage': 'SSL connection timeout',
'lastIncidentChecktime': 0,
'lastIncidentStatusCode': 0,
'lastIncidentStatusText': '',
'lastOkChecktime': 0,
'lastStatusCode': 0,
'lastStatusMessage': '0',
'lastStatusText': '',
'minAvailability': 99.0,
'name': 'www.seznam.cz',
'paramCacheSet': 0,
'paramCookie': '',
'paramCookieSet': 1,
'paramHeaderOnly': 0,
'paramIPv6': 0,
'paramPasswd': '',
'paramPost': '',
'paramSearch': '',
'paramSearchEq': 0,
'paramServer': '',
'paramServerType': '',
'paramSizeGt': 0,
'paramSizeValue': 0,
'paramUsername': '',
'parentId': '',
'publicStatActive': 0,
'rumIdent': '',
'serviceCheckType': 'name',
'serviceCheckTypeId': 1,
'siuxdbId': 3,
'sourceGroupId': 5960,
'sourceGroupName': 'Skupina zdroju Test1 s.r.o',
'sourceId': 33743,
'sourceType': 'http',
'sourceTypeName': 'HTTP',
'stat': [ { 'availability': 99.706999999999994,
'checktime': '2015-09-01',
'cntErr': 4,
'cntOk': 1361,
'cntTotal': 1365,
'connectTime': 0.031764000000000001,
'fullMonth': 'no',
'month': 9,
'outputLen': 22243.0,
'readTime': 0.25643100000000002,
'resolveTime': 0.010954999999999999,
'responseTime': 0.299149,
'speed': 655.23299999999995,
'ts': 1441058401,
'year': 2015},
{ 'availability': 99.924800000000005,
'checktime': '2015-09-02',
'cntErr': 1,
'cntOk': 1328,
'cntTotal': 1329,
'connectTime': 0.034315999999999999,
'fullMonth': 'no',
'month': 9,
'outputLen': 22406.5,
'readTime': 0.25708500000000001,
'resolveTime': 0.0060049999999999999,
'responseTime': 0.297406,
'speed': 658.46699999999998,
'ts': 1441144801,
'year': 2015},
{ 'availability': 100.0,
'checktime': '2015-09-03',
'cntErr': 0,
'cntOk': 1345,
'cntTotal': 1345,
'connectTime': 0.026335999999999998,
'fullMonth': 'no',
'month': 9,
'outputLen': 22117.0,
'readTime': 0.24165400000000001,
'resolveTime': 0.010640999999999999,
'responseTime': 0.27863100000000002,
'speed': 691.18499999999995,
'ts': 1441231201,
'year': 2015},
{ 'availability': 100.0,
'checktime': '2015-09-04',
'cntErr': 0,
'cntOk': 1304,
'cntTotal': 1304,
'connectTime': 0.020499,
'fullMonth': 'no',
'month': 9,
'outputLen': 22698.299999999999,
'readTime': 0.19828799999999999,
'resolveTime': 0.006633,
'responseTime': 0.22542100000000001,
'speed': 865.24300000000005,
'ts': 1441317601,
'year': 2015},
{ 'availability': 99.8536,
'checktime': '2015-09-05',
'cntErr': 2,
'cntOk': 1364,
'cntTotal': 1366,
'connectTime': 0.029406999999999999,
'fullMonth': 'no',
'month': 9,
'outputLen': 22242.700000000001,
'readTime': 0.24193600000000001,
'resolveTime': 0.006313,
'responseTime': 0.27765600000000001,
'speed': 694.45500000000004,
'ts': 1441404001,
'year': 2015},
{ 'availability': 99.926500000000004,
'checktime': '2015-09-06',
'cntErr': 1,
'cntOk': 1360,
'cntTotal': 1361,
'connectTime': 0.025794000000000001,
'fullMonth': 'no',
'month': 9,
'outputLen': 21889.700000000001,
'readTime': 0.23766899999999999,
'resolveTime': 0.020286999999999999,
'responseTime': 0.28375,
'speed': 695.35199999999998,
'ts': 1441490401,
'year': 2015}],
'status': 'deactive',
'sum': { 'avgAvailability': 99.901983000000001,
'avgConnectTime': 0.028018999999999999,
'avgOutputLen': 22266.200000000001,
'avgReadTime': 0.238844,
'avgResolveTime': 0.010139,
'avgResponseTime': 0.27700200000000003,
'avgSpeed': 709.98916699999995,
'errCnt': 8,
'maxAvailability': 100.0,
'minAvailability': 99.706999999999994,
'sumCnt': 8070,
'sumConnectTime': 0.16811599999999999,
'sumOutputLen': 133597.20000000001,
'sumReadTime': 1.433063,
'sumResolveTime': 0.060833999999999999,
'sumResponseTime': 1.662013,
'sumSpeed': 4259.9350000000004},
'timeSchemeId': 955,
'timeSchemeName': 'Interval 1min',
'timeout': 3,
'timeoutErr': 3,
'timeoutWarn': 1,
'timezone': 1,
'timezoneId': 37,
'timezoneName': 'Belgrade, Bratislava, Budapest, Ljubljana, Prague',
'timezoneNick': 'europe/belgrade',
'tsCreate': 1420066800,
'tsMax': 1441490401,
'tsMin': 1441058401,
'tsUpdate': 1420066800,
'url': 'http://www.seznam.cz',
'urlNice': 'www.seznam.cz',
'week': [ { 'avgAvailability': 99.901983000000001,
'avgConnectTime': 0.028018999999999999,
'avgOutputLen': 22266.200000000001,
'avgReadTime': 0.238844,
'avgResolveTime': 0.010139,
'avgResponseTime': 0.27700200000000003,
'avgSpeed': 709.98916699999995,
'errCnt': 8,
'found': 6,
'sumAvailability': 599.41189999999995,
'sumCnt': 8070,
'sumConnectTime': 0.16811599999999999,
'sumOutputLen': 133597.20000000001,
'sumReadTime': 1.433063,
'sumResolveTime': 0.060833999999999999,
'sumResponseTime': 1.662013,
'sumSpeed': 4259.9350000000004,
'tsMax': 1441490401,
'tsMin': 1441058401,
'weekNo': 35}]},
'found': 6,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': { 'browser': 'ie10',
'browserFamilyName': 'ie',
'browserId': 1,
'browserName': 'Windows: Internet explorer 10',
'clientId': 985,
'clientName': 'Test1 s.r.o',
'clientPay': 1,
'domainId': 19,
'googleGaProfileId': 0,
'googleGaTsCreate': 0,
'hash': '',
'lastChecktime': 0,
'lastErrChecktime': 1441636430,
'lastErrNo': 0,
'lastErrStatusCode': 612,
'lastErrStatusMessage': 'SSL connection timeout',
'lastIncidentChecktime': 0,
'lastIncidentStatusCode': 0,
'lastIncidentStatusText': '',
'lastOkChecktime': 0,
'lastStatusCode': 0,
'lastStatusMessage': '0',
'lastStatusText': '',
'minAvailability': 99.0,
'name': 'www.seznam.cz',
'paramCacheSet': 0,
'paramCookie': '',
'paramCookieSet': 1,
'paramHeaderOnly': 0,
'paramIPv6': 0,
'paramPasswd': '',
'paramPost': '',
'paramSearch': '',
'paramSearchEq': 0,
'paramServer': '',
'paramServerType': '',
'paramSizeGt': 0,
'paramSizeValue': 0,
'paramUsername': '',
'parentId': '',
'publicStatActive': 0,
'rumIdent': '',
'serviceCheckType': 'name',
'serviceCheckTypeId': 1,
'siuxdbId': 3,
'sourceGroupId': 5960,
'sourceGroupName': 'Skupina zdroju Test1 s.r.o',
'sourceId': 33743,
'sourceType': 'http',
'sourceTypeName': 'HTTP',
'stat': [ { 'availability': 99.706999999999994,
'checktime': '2015-09-01',
'cntErr': 4,
'cntOk': 1361,
'cntTotal': 1365,
'connectTime': 0.031764000000000001,
'fullMonth': 'no',
'month': 9,
'outputLen': 22243.0,
'readTime': 0.25643100000000002,
'resolveTime': 0.010954999999999999,
'responseTime': 0.299149,
'speed': 655.23299999999995,
'ts': 1441058401,
'year': 2015},
{ 'availability': 99.924800000000005,
'checktime': '2015-09-02',
'cntErr': 1,
'cntOk': 1328,
'cntTotal': 1329,
'connectTime': 0.034315999999999999,
'fullMonth': 'no',
'month': 9,
'outputLen': 22406.5,
'readTime': 0.25708500000000001,
'resolveTime': 0.0060049999999999999,
'responseTime': 0.297406,
'speed': 658.46699999999998,
'ts': 1441144801,
'year': 2015},
{ 'availability': 100.0,
'checktime': '2015-09-03',
'cntErr': 0,
'cntOk': 1345,
'cntTotal': 1345,
'connectTime': 0.026335999999999998,
'fullMonth': 'no',
'month': 9,
'outputLen': 22117.0,
'readTime': 0.24165400000000001,
'resolveTime': 0.010640999999999999,
'responseTime': 0.27863100000000002,
'speed': 691.18499999999995,
'ts': 1441231201,
'year': 2015},
{ 'availability': 100.0,
'checktime': '2015-09-04',
'cntErr': 0,
'cntOk': 1304,
'cntTotal': 1304,
'connectTime': 0.020499,
'fullMonth': 'no',
'month': 9,
'outputLen': 22698.299999999999,
'readTime': 0.19828799999999999,
'resolveTime': 0.006633,
'responseTime': 0.22542100000000001,
'speed': 865.24300000000005,
'ts': 1441317601,
'year': 2015},
{ 'availability': 99.8536,
'checktime': '2015-09-05',
'cntErr': 2,
'cntOk': 1364,
'cntTotal': 1366,
'connectTime': 0.029406999999999999,
'fullMonth': 'no',
'month': 9,
'outputLen': 22242.700000000001,
'readTime': 0.24193600000000001,
'resolveTime': 0.006313,
'responseTime': 0.27765600000000001,
'speed': 694.45500000000004,
'ts': 1441404001,
'year': 2015},
{ 'availability': 99.926500000000004,
'checktime': '2015-09-06',
'cntErr': 1,
'cntOk': 1360,
'cntTotal': 1361,
'connectTime': 0.025794000000000001,
'fullMonth': 'no',
'month': 9,
'outputLen': 21889.700000000001,
'readTime': 0.23766899999999999,
'resolveTime': 0.020286999999999999,
'responseTime': 0.28375,
'speed': 695.35199999999998,
'ts': 1441490401,
'year': 2015}],
'status': 'deactive',
'sum': { 'avgAvailability': 99.901983000000001,
'avgConnectTime': 0.028018999999999999,
'avgOutputLen': 22266.200000000001,
'avgReadTime': 0.238844,
'avgResolveTime': 0.010139,
'avgResponseTime': 0.27700200000000003,
'avgSpeed': 709.98916699999995,
'errCnt': 8,
'maxAvailability': 100.0,
'minAvailability': 99.706999999999994,
'sumCnt': 8070,
'sumConnectTime': 0.16811599999999999,
'sumOutputLen': 133597.20000000001,
'sumReadTime': 1.433063,
'sumResolveTime': 0.060833999999999999,
'sumResponseTime': 1.662013,
'sumSpeed': 4259.9350000000004},
'timeSchemeId': 955,
'timeSchemeName': 'Interval 1min',
'timeout': 3,
'timeoutErr': 3,
'timeoutWarn': 1,
'timezone': 1,
'timezoneId': 37,
'timezoneName': 'Belgrade, Bratislava, Budapest, Ljubljana, Prague',
'timezoneNick': 'europe/belgrade',
'tsCreate': 1420066800,
'tsMax': 1441490401,
'tsMin': 1441058401,
'tsUpdate': 1420066800,
'url': 'http://www.seznam.cz',
'urlNice': 'www.seznam.cz',
'week': [ { 'avgAvailability': 99.901983000000001,
'avgConnectTime': 0.028018999999999999,
'avgOutputLen': 22266.200000000001,
'avgReadTime': 0.238844,
'avgResolveTime': 0.010139,
'avgResponseTime': 0.27700200000000003,
'avgSpeed': 709.98916699999995,
'errCnt': 8,
'found': 6,
'sumAvailability': 599.41189999999995,
'sumCnt': 8070,
'sumConnectTime': 0.16811599999999999,
'sumOutputLen': 133597.20000000001,
'sumReadTime': 1.433063,
'sumResolveTime': 0.060833999999999999,
'sumResponseTime': 1.662013,
'sumSpeed': 4259.9350000000004,
'tsMax': 1441490401,
'tsMin': 1441058401,
'weekNo': 35}]},
'found': 6,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

sourceStatMonthlyList

Monthly statistics of resources / web sites

GET /api/sourceStatMonthlyList
array sourceStatMonthlyList(  sourceId, history )
dict sourceStatMonthlyList(  sourceId, history )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
history integer int int History (max. the number of turkey)

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceStatMonthlyList?api_key=${APIKEY}&sourceId=0&history=12"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceStatMonthlyList( $sourceId=0, $history=12 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceStatMonthlyList( sourceId=0, history=12 )
pprint.pprint( ret )

An example of the output

{ 'data': { 'browser': 'ie10',
'browserFamilyName': 'ie',
'browserId': 1,
'browserName': 'Windows: Internet explorer 10',
'clientId': 985,
'clientName': 'Test1 s.r.o',
'clientPay': 1,
'domainId': 19,
'googleGaProfileId': 0,
'googleGaTsCreate': 0,
'hash': '',
'lastChecktime': 0,
'lastErrChecktime': 1441636430,
'lastErrNo': 0,
'lastErrStatusCode': 612,
'lastErrStatusMessage': 'SSL connection timeout',
'lastIncidentChecktime': 0,
'lastIncidentStatusCode': 0,
'lastIncidentStatusText': '',
'lastOkChecktime': 0,
'lastStatusCode': 0,
'lastStatusMessage': '0',
'lastStatusText': '',
'minAvailability': 99.0,
'name': 'www.seznam.cz',
'paramCacheSet': 0,
'paramCookie': '',
'paramCookieSet': 1,
'paramHeaderOnly': 0,
'paramIPv6': 0,
'paramPasswd': '',
'paramPost': '',
'paramSearch': '',
'paramSearchEq': 0,
'paramServer': '',
'paramServerType': '',
'paramSizeGt': 0,
'paramSizeValue': 0,
'paramUsername': '',
'parentId': '',
'publicStatActive': 0,
'rumIdent': '',
'serviceCheckType': 'name',
'serviceCheckTypeId': 1,
'siuxdbId': 3,
'sourceGroupId': 5960,
'sourceGroupName': 'Skupina zdroju Test1 s.r.o',
'sourceId': 33743,
'sourceType': 'http',
'sourceTypeName': 'HTTP',
'stat': [ { 'availability': 99.901971000000003,
'checktime': 1441058401,
'cntDay': 6,
'cntErr': 8,
'cntOk': 8062,
'cntTotal': 8070,
'connectTime': 0.028018999999999999,
'fullMonth': 'no',
'month': 9,
'monthYear': '2015-09',
'outputLen': 22266.184895999999,
'percent': 99.900867000000005,
'readTime': 0.238844,
'resolveTime': 0.010139,
'responseTime': 0.27700200000000003,
'speed': 709.98909500000002,
'year': 2015},
{ 'availability': 99.789851999999996,
'checktime': 1440108001,
'cntDay': 11,
'cntErr': 32,
'cntOk': 13899,
'cntTotal': 13931,
'connectTime': 0.034026000000000001,
'fullMonth': 'no',
'month': 8,
'monthYear': '2015-08',
'outputLen': 22108.790838000001,
'percent': 99.770296000000002,
'readTime': 0.24665400000000001,
'resolveTime': 0.010606000000000001,
'responseTime': 0.29128500000000002,
'speed': 679.73771499999998,
'year': 2015}],
'status': 'deactive',
'sum': { 'avgAvailability': 99.845911999999998,
'avgConnectTime': 0.031022999999999998,
'avgOutputLen': 22187.487867,
'avgReadTime': 0.24274899999999999,
'avgResolveTime': 0.010371999999999999,
'avgResponseTime': 0.28414400000000001,
'avgSpeed': 694.86340499999994,
'errCnt': 40,
'maxAvailability': 99.901971000000003,
'minAvailability': 99.789851999999996,
'sumCnt': 22001,
'sumConnectTime': 0.062045000000000003,
'sumOutputLen': 44374.975734,
'sumReadTime': 0.48549799999999999,
'sumResolveTime': 0.020745,
'sumResponseTime': 0.56828800000000002,
'sumSpeed': 1389.7268099999999},
'timeSchemeId': 955,
'timeSchemeName': 'Interval 1min',
'timeout': 3,
'timeoutErr': 3,
'timeoutWarn': 1,
'timezone': 1,
'timezoneId': 37,
'timezoneName': 'Belgrade, Bratislava, Budapest, Ljubljana, Prague',
'timezoneNick': 'europe/belgrade',
'tsCreate': 1420066800,
'tsUpdate': 1420066800,
'url': 'http://www.seznam.cz',
'urlNice': 'www.seznam.cz'},
'found': 2,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': { 'browser': 'ie10',
'browserFamilyName': 'ie',
'browserId': 1,
'browserName': 'Windows: Internet explorer 10',
'clientId': 985,
'clientName': 'Test1 s.r.o',
'clientPay': 1,
'domainId': 19,
'googleGaProfileId': 0,
'googleGaTsCreate': 0,
'hash': '',
'lastChecktime': 0,
'lastErrChecktime': 1441636430,
'lastErrNo': 0,
'lastErrStatusCode': 612,
'lastErrStatusMessage': 'SSL connection timeout',
'lastIncidentChecktime': 0,
'lastIncidentStatusCode': 0,
'lastIncidentStatusText': '',
'lastOkChecktime': 0,
'lastStatusCode': 0,
'lastStatusMessage': '0',
'lastStatusText': '',
'minAvailability': 99.0,
'name': 'www.seznam.cz',
'paramCacheSet': 0,
'paramCookie': '',
'paramCookieSet': 1,
'paramHeaderOnly': 0,
'paramIPv6': 0,
'paramPasswd': '',
'paramPost': '',
'paramSearch': '',
'paramSearchEq': 0,
'paramServer': '',
'paramServerType': '',
'paramSizeGt': 0,
'paramSizeValue': 0,
'paramUsername': '',
'parentId': '',
'publicStatActive': 0,
'rumIdent': '',
'serviceCheckType': 'name',
'serviceCheckTypeId': 1,
'siuxdbId': 3,
'sourceGroupId': 5960,
'sourceGroupName': 'Skupina zdroju Test1 s.r.o',
'sourceId': 33743,
'sourceType': 'http',
'sourceTypeName': 'HTTP',
'stat': [ { 'availability': 99.901971000000003,
'checktime': 1441058401,
'cntDay': 6,
'cntErr': 8,
'cntOk': 8062,
'cntTotal': 8070,
'connectTime': 0.028018999999999999,
'fullMonth': 'no',
'month': 9,
'monthYear': '2015-09',
'outputLen': 22266.184895999999,
'percent': 99.900867000000005,
'readTime': 0.238844,
'resolveTime': 0.010139,
'responseTime': 0.27700200000000003,
'speed': 709.98909500000002,
'year': 2015},
{ 'availability': 99.789851999999996,
'checktime': 1440108001,
'cntDay': 11,
'cntErr': 32,
'cntOk': 13899,
'cntTotal': 13931,
'connectTime': 0.034026000000000001,
'fullMonth': 'no',
'month': 8,
'monthYear': '2015-08',
'outputLen': 22108.790838000001,
'percent': 99.770296000000002,
'readTime': 0.24665400000000001,
'resolveTime': 0.010606000000000001,
'responseTime': 0.29128500000000002,
'speed': 679.73771499999998,
'year': 2015}],
'status': 'deactive',
'sum': { 'avgAvailability': 99.845911999999998,
'avgConnectTime': 0.031022999999999998,
'avgOutputLen': 22187.487867,
'avgReadTime': 0.24274899999999999,
'avgResolveTime': 0.010371999999999999,
'avgResponseTime': 0.28414400000000001,
'avgSpeed': 694.86340499999994,
'errCnt': 40,
'maxAvailability': 99.901971000000003,
'minAvailability': 99.789851999999996,
'sumCnt': 22001,
'sumConnectTime': 0.062045000000000003,
'sumOutputLen': 44374.975734,
'sumReadTime': 0.48549799999999999,
'sumResolveTime': 0.020745,
'sumResponseTime': 0.56828800000000002,
'sumSpeed': 1389.7268099999999},
'timeSchemeId': 955,
'timeSchemeName': 'Interval 1min',
'timeout': 3,
'timeoutErr': 3,
'timeoutWarn': 1,
'timezone': 1,
'timezoneId': 37,
'timezoneName': 'Belgrade, Bratislava, Budapest, Ljubljana, Prague',
'timezoneNick': 'europe/belgrade',
'tsCreate': 1420066800,
'tsUpdate': 1420066800,
'url': 'http://www.seznam.cz',
'urlNice': 'www.seznam.cz'},
'found': 2,
'hostname': 'preinstall',
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

sourceStatWeeklyList

Weekly statistics resources / www sites

GET /api/sourceStatWeeklyList
array sourceStatWeeklyList(  sourceId, date )
dict sourceStatWeeklyList(  sourceId, date )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
date string string str A date in the format YYYY-MM-DD

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceStatWeeklyList?api_key=${APIKEY}&sourceId=0&date=2001-01-01"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceStatWeeklyList( $sourceId=0, $date='2001-01-01' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceStatWeeklyList( sourceId=0, date='2001-01-01' )
pprint.pprint( ret )

sourceVideoInfo

The result of the measurement for the video

GET /api/sourceVideoInfo
array sourceVideoInfo( ='', sourceId=0, date=2015-10-07, whatName=session, whatId='' )
dict sourceVideoInfo( ='', sourceId=0, date=2015-10-07, whatName=session, whatId='' )

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/sourceVideoInfo?api_key=${APIKEY}&sourceId=0&date=2015-09-01&whatName=session&whatId="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->sourceVideoInfo( $sourceId=0, $date='2015-09-01', $whatName='session', $whatId='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.sourceVideoInfo( sourceId=0, date='2015-09-01', whatName='session', whatId='' )
pprint.pprint( ret )

Tags

tagAdd Add tag
tagDelete Deletion of the tag
tagInfo Detail of the tag
tagList A list of tags
 
tagReplyAdd Adding tag of the notification
tagReplyList The list of answers on the tags
tagReplyUpdate Adding notes

tagAdd

Add tag

GET /api/tagAdd
array tagAdd(  name, label, flagNotify, flagDeploy )
dict tagAdd(  name, label, flagNotify, flagDeploy )
Name Type Description
api_key string string str The API key
name integer int int ID tag
label string string str Label
flagNotify integer int int Tag for notification
flagDeploy integer int int The Tag for deployment versions

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagAdd?api_key=${APIKEY}&name=&label=default&flagNotify=0&flagDeploy=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagAdd( $name='', $label='default', $flagNotify=0, $flagDeploy=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagAdd( name='', label='default', flagNotify=0, flagDeploy=0 )
pprint.pprint( ret )

tagDelete

Deletion of the tag

GET /api/tagDelete
array tagDelete(  tagId )
dict tagDelete(  tagId )
Name Type Description
api_key string string str The API key
tagId integer int int ID tag

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagDelete?api_key=${APIKEY}&tagId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagDelete( $tagId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagDelete( tagId=0 )
pprint.pprint( ret )

tagInfo

Detail of the tag

GET /api/tagInfo
array tagInfo(  tagId )
dict tagInfo(  tagId )
Name Type Description
api_key string string str The API key
tagId integer int int ID tag

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagInfo?api_key=${APIKEY}&tagId=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagInfo( $tagId=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagInfo( tagId=0 )
pprint.pprint( ret )

tagList

A list of tags

GET /api/tagList
array tagList(  )
dict tagList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'clientId': 0,
'cnt': 0,
'flagDeploy': 0,
'flagNotify': 0,
'label': 'success',
'nickname': 'bgfx',
'tag': 'bugfix',
'tagId': 6,
'tsCreate': 1451229748,
'tsUpdate': 1451229748}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'clientId': 0,
'cnt': 0,
'flagDeploy': 0,
'flagNotify': 0,
'label': 'success',
'nickname': 'bgfx',
'tag': 'bugfix',
'tagId': 6,
'tsCreate': 1451229748,
'tsUpdate': 1451229748}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

tagReplyAdd

Adding tag of the notification

GET /api/tagReplyAdd
array tagReplyAdd(  tagId, sourceId, senderId, dateInt )
dict tagReplyAdd(  tagId, sourceId, senderId, dateInt )
Name Type Description
api_key string string str The API key
tagId integer int int ID tag
sourceId integer int int Source ID
senderId integer int int The ID of the sent notification
dateInt integer int int A date in the format YYYYMMDD

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagReplyAdd?api_key=${APIKEY}&tagId=0&sourceId=0&operatorId=0&senderId=0&date=0"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagReplyAdd( $tagId=0, $sourceId=0, $operatorId=0, $senderId=0, $date=0 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagReplyAdd( tagId=0, sourceId=0, operatorId=0, senderId=0, date=0 )
pprint.pprint( ret )

tagReplyList

The list of answers on the tags

GET /api/tagReplyList
array tagReplyList(  tagId, sourceId, From, step )
dict tagReplyList(  tagId, sourceId, From, step )
Name Type Description
api_key string string str The API key
tagId integer int int ID tag
sourceId integer int int Source ID
From integer int int From the record
step integer int int The number of records on the page

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagReplyList?api_key=${APIKEY}&tagId=0&sourceId=0&From=0&step=20"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagReplyList( $tagId=0, $sourceId=0, $From=0, $step=20 );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagReplyList( tagId=0, sourceId=0, From=0, step=20 )
pprint.pprint( ret )

tagReplyUpdate

Adding notes

GET /api/tagReplyUpdate
array tagReplyUpdate(  tagReplyId, operatorId, comment )
dict tagReplyUpdate(  tagReplyId, operatorId, comment )
Name Type Description
api_key string string str The API key
tagReplyId integer int int ID answers to the tag
operatorId integer int int User ID
comment string string str Note

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/tagReplyUpdate?api_key=${APIKEY}&tagReplyId=0&operatorId=0&comment="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->tagReplyUpdate( $tagReplyId=0, $operatorId=0, $comment='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.tagReplyUpdate( tagReplyId=0, operatorId=0, comment='' )
pprint.pprint( ret )

Time zone

timezoneList The list of the time zones

timezoneList

The list of the time zones

GET /api/timezoneList
array timezoneList(  )
dict timezoneList(  )
Name Type Description
api_key string string str The API key

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/timezoneList?api_key=${APIKEY}"
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->timezoneList( );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.timezoneList( )
pprint.pprint( ret )

An example of the output

{ 'data': [ { 'name': 'West Central Africa',
'timezone': 'africa/algiers',
'timezoneId': 40}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
{ 'data': [ { 'name': 'West Central Africa',
'timezone': 'africa/algiers',
'timezoneId': 40}],
'status': 200,
'statusCode': 'OK',
'statusMessage': 'OK'}
 

Video

 
videoOutputInfo A list of the measured data for the video source

videoOutputInfo

A list of the measured data for the video source

GET /api/videoOutputInfo
array videoOutputInfo(  sourceId, date, limit, FromId, outputId, countrys, checkpointIds, dataView, videoId )
dict videoOutputInfo(  sourceId, date, limit, FromId, outputId, countrys, checkpointIds, dataView, videoId )
Name Type Description
api_key string string str The API key
sourceId integer int int ID resources / websites, etc sourceList()
date string string str A date in the format YYYY-MM-DD
limit integer int int Max. the number of results
fromId integer int int From what ID, we'll display the data
outputId integer int int ID detail
countrys array array list ID of the countries of the control points, for which I want to see results, etc countryList()
checkpointIds array array list The ID of the control point from which I want to see results, etc checkpointList()
dataView string string str The type of view (short/all)
videoId string string str The identification of the video

Example

export APIKEY="[YOUR_API_KEY]"
curl -X GET -H 'Content-Type: application/json' "https://restapi.esiux.com/api/videoOutputInfo?api_key=${APIKEY}&sourceId=0&date=2015-09-01&limit=2000&FromId=0&outputId=0&countrys*=&countrys*=&checkpointIds*=&checkpointIds*=&dataView=all&videoId="
// visit https://github.com/eSiUX/siux-php
require_once('siuxlib.php');

$api = "[YOUR_API_KEY]";
$siux = new SiUXclient($auth=$api);
$ret = $siux->videoOutputInfo( $sourceId=0, $date='2015-09-01', $limit=2000, $FromId=0, $outputId=0, $countrys=array(), $checkpointIds=array(), $dataView='all', $videoId='' );
print_r( $ret );
# visit https://github.com/eSiUX/siux-python
import siuxlib, pprint

api = "[YOUR_API_KEY]"
siux = siuxlib.SiUXclient( auth=api )
ret = siux.videoOutputInfo( sourceId=0, date='2015-09-01', limit=2000, FromId=0, outputId=0, countrys=[], checkpointIds=[], dataView='all', videoId='' )
pprint.pprint( ret )

Use


Learn the ins and outs of our API and get started.


Use

Documentation


Get everything you need to build on top of our API.


Documentation

Library


Find our API translated to your preferred language.


Library

Changelog


Refer to the overview of the latest changes and news in our system.


Changelog