Engagements Report

Overview

Query for a list of all the conversations (a.k.a engagements) for a given date range. Conversations will be sorted by date of creation. The GET request will be answered by a JSON containing an array of engagement objects.

Available for Directory tokens only.

Authentication

Uses HTTP Token authentication. Format: Authorization: Token token="{DIRECTORY_TOKEN}"

The token must be a Doorkeeper OAuth token with directory scope.

Query Params
string

The business UID (alphanumeric string like '88pzdbz1hmkdoel4') to filter engagements for a specific business.

date
required

yyyy-mm-dd

date
required

yyyy-mm-dd

Headers
string
required

HTTP Token authentication. Format: Token token="{DIRECTORY_TOKEN}". The token must have directory scope.

Responses

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json