Reporting API

Reporting API Reference

The Reporting API empowers you to access all of your Agendize reporting data.


Call-to-Actions

Gets engagement actions details.

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/reporting/actionDetails

Parameters

Parameter name Value Description
Required query parameters
status string Gets registrations by status.
startDate datetime Upper bound (exclusive) for a call's start 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 call's end 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", "chat", "call", "pim".

Response

{ "id": {string}, "date": { "dateTime": {string}, "timeZone", {string} }, "destination": {string}, "tool": { "id": {string}, "name": {string}, "type": {string} } }
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", "chat", "call", "pim".