Agendize Watchers API

Watcher Errors API Reference

The Watcher Errors API empowers you to watch your client interactions.


Resource representation

{ "id": {string}, "owner": { "id": {string}, "userName": {string} }, "request": { "body": "{string}", "address": "{string}" }, "response": { "body": {string}, "statusCode": {integer}, "errorMessage": {string} }, "watcher": { "id": {string}, "address": {string}, "objectType": {string} }, "date": { "dateTime": "{string}", "timeZone": "{string}" } }
Parameter name Value Description
id string Identifier of the watcher error.
owner object Owner account of the watcher error.
owner.id string Identifier of the owner account.
owner.userName string user name of the owner account.
request object Request of the watch.
request.body string Body of request.
request.address string Address of the request.
response object Response of the watch.
response.body string Body of request.
response.statusCode integer Status code of the response.
response.errorMessage integer Error message of the response.
watcher object Information of the source watcher.
watcher.id string Identifier of the watcher.
watcher.address integer Address of the watcher.
watcher.objectType string Type of the watcher's object. values: 'schedulingCompany', 'callTracking', 'clickToCall'.
watcher.selfLink string URL link to the watcher resource description
date object The date of the watcher error.
date.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
date.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company.

Delete

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

DELETE https://api.agendize.com/api/2.3/watchers/errors/{watcherErrorId}

Parameters

Parameter name Value Description
Path parameters
watcherErrorId string Watcher error identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.


Get

Returns an entry of the watcher list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/watchers/errors/{watcherErrorId}

Parameters

Parameter name Value Description

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Watcher error resource in the response body.


List

Returns entries on the watcher list.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/watchers/errors

Parameters

Parameter name Value Description
Optional query parameters
startDate datetime Upper bound (exclusive) for watcher error time (as a RFC 3339 timestamp) to filter by. Optional.
endDate datetime Lower bound (exclusive) for watcher error time (as a RFC 3339 timestamp) to filter by. Optional.
watcherId datetime An identifier of a watcher. Optional.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure: