get https://api.vcita.biz/v1/partners/reports/engagements
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
The engagement object will include the following fields:
| Field | Description |
|---|---|
| created_at | The creation time of the conversation. |
| business_responded | Whether the conversation includes messages by the business. used to determine whether the business responded to the contact request by a client. Business responded =1, Business didn't respond =0. |
| engagement_id | An internal ID of the engagement. |
| lead_type | The type of the initial message that started this conversation. e.g. "meeting", "internally", "payment", "message", "document". |
| business_id | An internal ID of the business account. |
| business_nickname | The nickname of the business account. |
| source_type | The source type of the engagement. indicates how the engagement started. (e.g. contact_form, livesite_widget etc). |
| website_url | If relevant, the URL the client contacted the business from. |
| channel | If relevant, the lead channel. |
| campaign | If relevant, the campaign source of the lead. |
| title | The engagement title. |
| updated_at | The last time the business or a client responded on this engagement. |
| client_first_name | The first name of the client. |
| client_last_name | The last name of the client. |
| client_id | The client unique id. |
You can try it by clicking the next button!
