Agendize Developers API

Reporting API

Custom Reports

Resource representation

{ "id": {string}, "name": {string}, "tools": [ { "id": {string}, "name": {string} } ], "widgets": [ { "id": {string} } ] }
Parameter name Value Description
id string Identifier of the custom report.
name string Name of the custom report.
tools list Tools selected in the report.
tools[].id string Id of the tool.
widgets list Report widgets contained in the report.
widgets[].id string Id of the widget. Available widget ids :
  • total.engagment
  • summary
  • collected
  • buttons
  • calls.duration
  • calls.details
  • calls.days
  • call.summary
  • call.status
  • calltracking
  • calltracking.duration
  • calltracking.days
  • calltracking.summary
  • calltracking.attempt
  • application.effectiveness
  • medias
  • engagment.days
  • engagment.hours
  • forms
  • forms.drafts
  • forms.summary
  • countries
  • scheduling.details
  • scheduling.staff
  • scheduling.services
  • scheduling.sources
  • scheduling.resources
  • scheduling.companies
  • scheduling.occupancy
  • scheduling.reliability
  • scheduling.activity
  • scheduling.activity.changes
  • scheduling.staff.services
  • emails.summary
  • queue.summary

Delete

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/reporting/reports/{reportId}

Parameters

Parameter name Value Description
Path parameters
reportId string Custom report identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

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

Request

HTTP Request

GET https://api.agendize.com/api/2.0/reporting/reports/{reportId}

Parameters

Parameter name Value Description
Path parameters
reportId string Custom report identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Custom Report resource in the response body.

List

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

Request

HTTP Request

GET https://api.agendize.com/api/2.0/reporting/reports

Request body

Do not supply a request body with this method.

Response

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

{ items: [Custom Report Resource] }

Insert

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

Request

HTTP Request

POST https://api.agendize.com/api/2.0/reporting/reports

Request body

In the request body, supply a Report Resource with the following properties:

Parameter name Value Description
Required Properties
name string Name of the custom report.
tools string Tools selected in the report.
tools.id string Id of the tool.
widgets string Report widgets contained in the report.
tools.id string Id of the widget.

Response

If successful, this method returns a Custom Report resource in the response body.

Update

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.0/reporting/reports/{reportId}

Parameters

Parameter name Value Description
Path parameters
reportId string Custom report identifier.

Request body

In the request body, supply a Custom Report resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the custom report.
tools string Tools selected in the report.
tools.id string Id of the tool.
widgets string Report widgets contained in the report.
tools.id string Id of the widget.

Response

If successful, this method returns a Custom Report resource in the response body.

Agendize | Support | Status

Last update: Mar 18, 2024 - Copyright © 2024 Agendize. All rights reserved.