Collector

Collector endpoints allow you to manage the survey collectors that distribute surveys to respondents through various channels (e.g., Email, SMS, WhatsApp, Widget, etc.).

Key functionalities:

• Create collectors: Define a new collector with associated survey and distribution parameters.
• Add contacts: Introduce recipient contacts (individually or via groups) to your collector for survey distribution.
• View and update collectors: Retrieve collector details, update configurations or close them.
• View statistics and analytics: Get insights into collector performance, including response counts, distribution statistics, and score analytics.

📄️ Create a new collector

Create a new collector that will distribute a given survey to contacts through a specified channel (e.g., Email, SMS, WhatsApp, or Widget).

📄️ List collectors

Retrieve a paginated list of collectors associated with the current department. You can filter by survey, status, type, and apply search queries.

📄️ Retrieve collector details

Get the details of a specific collector by its unique identifier.

📄️ Update an existing collector

Update configuration details of an existing collector such as message text, sender information, open/close dates, and associated rules.

📄️ Delete a collector

Mark a collector as deleted. The collector will no longer be considered active or listed in queries.

📄️ Add multiple contacts to a collector

Add a batch of contacts and/or contact groups to an existing collector. The collector will then initiate message sends according to its configuration (e.g. sending survey invites).

📄️ Add a single contact to a collector

Add a single contact (with optional dynamic parameters) and/or a single group to an existing collector. This triggers the collector’s configured message sending logic.

📄️ Export collector analytics to Excel

Queue an asynchronous task to export the collector’s analytics data to an Excel spreadsheet. The exported data can then be downloaded or further processed.