The Reporting API empowers you to access all of your Agendize reporting data.
Gets engagement actions details.
Authentication is required to execute this request. Please refer to Authentication for more.
Parameter name | Value | Description |
---|---|---|
Required query parameters | ||
startDate |
datetime |
Upper bound (exclusive) for a action time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by start time. |
endDate |
string |
Lower bound (exclusive) for a action time (as a RFC 3339 timestamp) to filter by. Optional. The default is not to filter by end time. |
toolId |
string |
Id of the tool. |
toolType |
datetime |
Type of the tool. Values: "scheduling", "call", "pim". |
Parameter name | Value | Description |
---|---|---|
Required Properties | ||
id |
string |
The identifier of the tool. |
date |
object |
The time of the action. |
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. |
destination |
object |
Destination of the action. Depends of the tools. Can by an email adresse or a mobile phone number. |
tool |
object |
The tool used. |
tool.id |
string |
Identifier of the tool. |
tool.name |
string |
Name of the tool. |
tool.type |
string |
Type of the tool. Values: "scheduling", "call", "pim". |