The Watcher Requests API empowers you to watch your client interactions. Requests are accessible for 10 days.
| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the watcher request. |
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. |
request.headers |
object |
Header key/value 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. |
response.errorMessage |
integer |
Body of the response. |
watcher |
object |
Information of the source watcher. |
watcher.id |
string |
Identifier of the watcher. |
watcher.name |
string |
Name 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 |
created |
object |
The created date of the watcher error. |
created.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
created.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
sent |
object |
The sent date of the watcher error. |
sent.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
sent.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
objectEvent |
string |
Event on the object. Values: "created", "updated", "deleted", "merged". |
status |
string |
Status of the request. Values: "pending", "success", "failed". |
Authentication is required to execute this request. Please refer to Authentication for more.
{watcherRequestId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
watcherRequestId |
string |
Watcher request identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Returns an entry of the watcher request list.
Authentication is required to execute this request. Please refer to Authentication for more.
{watcherRequestId}| Parameter name | Value | Description |
|---|---|---|
watcherRequestId |
string |
Watcher request identifier. |
Do not supply a request body with this method.
If successful, this method returns a Watcher request resource in the response body.
Returns entries on the watcher request list.
Authentication is required to execute this request. Please refer to Authentication for more.
| 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. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure: