• User Guide
  • Developer Docs
Frequently visited sections What is verloop?, FAQ Overview?

Outreach Report

Outreach Reports provide detailed performance data for individual outreach campaigns. These reports allow users to evaluate campaign effectiveness, audience engagement, and other critical metrics at a granular level.

Time Period Selection: Reports can be generated for specific time periods, including Daily, Weekly, Monthly, or Adhoc intervals.

Scheduling Options: Reports can be scheduled for regular delivery or downloaded on-demand. Recurring reports reduce the need for manual downloads.

How to Schedule and Download Reports

Generating Outreach-Specific Reports

To generate reports specific to a single outreach campaign, follow these steps:

  1. Locate the Outreach:
    Navigate to the outreach dashboard and find the outreach campaign for which you want to generate a report.
  2. Access the Report Options:
    Click on the three-dot menu associated with the outreach. Select the “Generate Report” option. 

After selecting the outreach, provide a unique name for the report. This name helps identify the report when it is delivered via email or webhook.

  1. Choose the Type of Report:
    • Adhoc Reports:
      Select the “Adhoc” option to generate a one-time report for a specified date range.
  • Scheduled Reports:
    For recurring reports, select the frequency:
    • Daily: Generates a report with daily data.
    • Weekly: Generates a report summarizing weekly data. Here, You can specify the day of the week (e.g., Monday, Wednesday) for the report to be generated.
    • Monthly: Provides a monthly summary. Upon selection, on the 1st day of every month, the report will be generated. 
  1. Note: The available frequencies depend on the type of outreach. For example:
    • Weekly outreach campaigns do not support daily report generation, as data will remain the same for all 7 days.
    • Monthly outreach campaigns do not support daily or weekly report frequencies.
  1. Set Delivery Preferences:
    • Enter the email addresses to which the report should be sent. You can provide multiple email IDs, separated by commas.
    • Optionally, add a webhook URL if you want the report to be sent directly to an external system.
  1. Finalize and Save:
    Click on “Generate”, to generate or schedule your report.
    • For scheduled reports, the system will deliver the report automatically based on the chosen frequency.
  • You can also see the report by going to settings>chats>reports. Here you edit the reports as per your needs.

Delivery Status Based on Outreach State

The availability of reports depends on the outreach’s current status:

  • Drafts: Reports cannot be generated or scheduled for draft outreaches.
  • Published Campaigns: Reports can be generated or scheduled once the outreach is in progress or completed.
  • In-Progress, Completed, or Paused Campaigns: Reports will contain data relevant to the specified time range.

Headers in Outreach Report

  1. To        
  2. From        
  3. Channel        
  4. Status        
  5. CampaignName        
  6. CampaignID        
  7. RecipeID – Recipe ID which was triggered
  8. CreatedAt – Timestamp of when this campaign was executed   
  9. DialedAt – Timestamp of when this campaign was scheduled
  10. ReceivedAt – Timestamp of when this campaign was received by users 
  11. CompletedAt  – Timestamp of when this campaign was completed   
  12. SentAt – Timestamp of when this campaign was sent
  13. DeliveredAt – Timestamp of when this campaign was delivered
  14. ReadAt – Timestamp of when this campaign was read by users
  15. RepliedAt – Timestamp of when this campaign was replied by users 
  16. FailedAt  – Timestamp of when this campaign failed to be sent
  17. ExpiredAt  – Timestamp of when this campaign expired
  18. ErrorMessage – Error messages, if the campaign is not successful
    1. errors reported by WhatsApp 
    2. errors reported by Verloop.io API or the BSPs. Example invalid phone number etc.
  19. CustomVariables – Recipe variable and the value stored in it for the reply given by the visitor to the campaign template  
  20. CustomTemplateParameters       
  21. CustomActionParameters
  22. Published By

The Published By column in Outreach Reports and Data Tables identifies the user or system entity that initiated the outreach. This field is visible in the dashboard, Excel downloads, and API responses, ensuring consistency across all interfaces.

  • How It Works:
    1. For new outreaches, the system records the name of the user who publishes the outreach as the trigger.
    2. This name is displayed in the Published By column across the dashboard, reports, and API responses.
    3. If a super admin triggers the outreach, the field will display “System Admin.”
  • Important Note:
    The Published By column is applicable only to new outreaches published after this update. For outreaches created prior to this implementation, this field will not populate with data.

RecipeID

The Recipe ID serves as a unique identifier for a specific recipe. It plays a crucial role in identifying and distinguishing the updated recipe from a list of available recipes. These IDs are particularly useful in differentiating between WhatsApp recipes and web recipes.

CreatedAt

When a message is created but not yet queued, it means that the message has been generated or composed but has not entered the queue for delivery or processing. At this stage, the message exists in a pre-queued state, ready to be scheduled or processed based on the defined criteria or conditions.

DialedAt

The date and time when the dial was attempted for Voice AI outreach refer to the specific moment when an automated call was initiated as part of Voice AI-based outreach activities. It indicates the exact date and time when the system made an attempt to establish a voice connection with the intended recipient.

ReceivedAt

The “received at” date and time for Voice AI KPIs signifies the specific timestamp when a user received an incoming call as part of the Voice AI outreach campaign.

CompletedAt

The “completedAt” date and time for Voice AI KPIs represents the specific timestamp when a call was successfully completed and registered as hang-up. It indicates the exact moment when the call ended and all communication between the Voice AI system and the user ceased.

SentAt

The “sentAt” date and time for WhatsApp (WA) message campaigns represents the specific timestamp when the campaign messages were sent to the recipients. It indicates the exact moment when the campaign was initiated and the messages were dispatched to the intended audience through the Outreach platform.

DeliveredAt

The “deliveredAt” date and time for WhatsApp (WA) messages represents the specific timestamp when the message was successfully delivered to the recipient’s device. It indicates the exact moment when the message reached the intended recipient on WhatsApp and was marked as “delivered”

ReadAt

The “readAt” date and time for WhatsApp (WA) messages represent the specific timestamp when the recipient reads the message. It indicates the exact moment when the recipient opened and viewed the message on their WhatsApp application, triggering the “read” status.

RepliedAt

The “repliedAt” date and time for WhatsApp (WA) messages represents the specific timestamp when the recipient replied to the message. It indicates the exact moment when the recipient sent a response or replied to the message on their WhatsApp application.

FailedAt

The “FailedAt” date and time for WhatsApp (WA) messages represents the specific timestamp when the sending of the message failed. It indicates the exact moment when the system encountered an error or issue while attempting to deliver the message to the recipient’s device, resulting in a failed delivery status.

ExpiredAt

The “ExpiredAt” date and time for WhatsApp (WA) messages represents the specific timestamp when the message expired. It indicates the exact moment when the message reached its designated expiration time and was no longer valid for delivery to the recipient.

ErrorMessage

The “ErrorMessage” field captures the specific error message received from the META or the call provider during the outreach process. This message indicates any errors or issues encountered while attempting to send the WhatsApp message or make a voice call. It serves as valuable information for troubleshooting and debugging purposes, allowing the team to identify the root cause of the error and resolve any technical or configuration issues.

ConversationURL

The “ConversationURL” refers to the associated URL of a conversation. This URL is typically provided in relation to a specific conversation or communication exchange.

CustomVariables

Any custom template variables added to track outreach campaign successes.

CustomTemplateParameters

CustomTemplateParameters refer to the specific values assigned to the placeholders inside a template. These placeholders act as variables that can be dynamically replaced with relevant information when the template is used. 

For example, consider a template that says, “Hey {{1}}, here is your {{coupon code}}.” In this case, the Custom Template Parameters would be {{1}} = “Jashvant” and {{coupon code}} = “ABCDEFG”. When this template is used, the placeholders are replaced with the assigned values, resulting in a personalised message such as, “Hey Jashvant, here is your ABCDEFG.”

CustomActionParameters

CustomActionParameters refer to any quick replies or call-to-action (CTA) buttons that are included as part of a template. These quick replies or buttons provide predefined response options or actions for the recipient of the message. 

For example, if a template contains quick replies like “Yes” or “No” as response options, or CTA buttons like “Shop Now” or “Learn More,” the values of these quick replies or buttons will be listed under the CustomActionParameters column. This column captures the specific options or actions available to the recipient when interacting with the template.

Status Code – WhatsApp Message

WA STATUSDescription
SentWhen a message is sent successfully to the user.
ActiveOnce a message has been successfully delivered to the user and has not expired.
DeliveredWhen a message has been delivered to the user.
ReadWA message read by the end user.
RepliedThe user replied to the outreach message.
FailedFailed to send message to user for reasons marked in the code
Expired Message gets overridden due to receiving a second campaign while there is a previous campaign that is still in active status

Status Code – Voice

Call StatusDescription
CreatedWhen the call is created but not queued yet
QueuedOnce a call is placed in the queue for dialling
DroppedIf the call was dropped by Verloop without attempting a dial. It can happen when a number is DND, a rule on the associated outreach expects this number to be not reached out to,  etc.
DiallingWhen the number is being dialled or trying to connect
RingingCall is ringing
Updated on December 4, 2024

Was this article helpful?

Related Articles

Schedule a demo

Get Started with Verloop.io