This API query provides insight into the delivery of notification campaigns (including the Marketing Suite and notifications sent via API). It provides useful information on reach.
| Filter Base | { "queryName": "<query_name>", "limit": "<total_records_to_return>", "timeZone": "<time_zone>" , "startDate": "<init_date_yyyy-mm-dd HH:mm:ss>", "endDate": "<end_date_yyyy-mm-dd HH:mm:ss>" } |
|---|---|
| Custom Filters | { “flow”: “<workflow_name_or_botid>” } |
Metrics
| Name | Description |
|---|---|
| Created Date | Time interval of analysis based on the creation date of notifications |
| Customer Name | The customer company that owns the flows. |
| Flow | It helps to understand which of our flows the information corresponds to. |
| Notification Template | Name of the message template, the format that you can use over and over again to message users once they have opted-in and given your app permission to send them messages. |
| Notification Category | |
| Notification Status | |
| Invalid Numbers | Users who have invalid numbers, so it was not possible to send or deliver Notification messages. Includes notifications with invalid number state and notifications with error state and invalid number description. |
| Omitted | Users who have omitted numbers and don't allow sending or delivering Notification messages |
| Sent | Notification messages that were correctly sent to the Audience users |
| Delivered | Notification messages that were correctly sent and delivered to the Audience users |
| Read | Notifications messages that were correctly read (two blue checks) to the audience users |
| Error | Notifications messages that returned an error and were not correctly delivered nor read |
| Sent To Whatsapp | Temporary internal status when the notification is sent to Whatsapp prior to being sent to the client. |
| Created | Temporary initial status, when the notification is just created on the Yalo platform, without having tried to send it to WA. It happens at the beginning of the process of sending notifications to all users. |