PlusVibe.ai
  1. Analytics
PlusVibe.ai
  • PlusVibe.ai API Documentation
  • Workspace
    • Get workspaces
      GET
    • Add a new workspace
      POST
  • Campaign
    • Create a new campaign
      POST
    • Create a new subsequence
      POST
    • List campaigns (deprecated)
      GET
    • List all campaigns
      GET
    • Get campaign name
      GET
    • Get campaign status
      GET
    • Get campaign email accounts
      GET
    • Get campaign emails
      GET
    • Set campaign name
      POST
    • Set campaign Schedules
      POST
    • Activate campaign
      POST
    • Pause campaign
      POST
  • Lead
    • Add leads to a campaign
      POST
    • Add leads to a subsequence campaign
      POST
    • Get or search for lead
      GET
    • Delete leads from a campaign
      POST
    • Lead Variable/Label Update or Add
      POST
    • Fetch workspace leads
      GET
    • Update the status of a lead
      POST
  • Email Account
    • List all email accounts in the workspace
    • Get email account status
    • Check account vitals
    • Enable Email account warmup
    • Pause Email account warmup
    • Delete Email account
    • Get Warmup Stats (Individual Account)
    • Get Warmup Stats (Workspace-Level)
    • Bulk Add SMTP Accounts
  • Analytics
    • Get campaign summary
      GET
    • Get campaign count (deprecated)
      GET
    • Get campaign stats
      GET
    • Get all campaigns statistics
      GET
  • Unibox
    • Get emails
    • Get count of unread emails
    • Reply to an email
    • Forward an existing email
    • Mark email read
  • Blocklist
    • Get entries in the blocklist
    • Adds entries to the blocklist
    • Delete entries in the blocklist
  • Webhook
    • PlusVibe Webhook Overview
    • Sample Payload - FIRST_EMAIL_REPLIES, ALL_EMAIL_REPLIES, ALL_POSITIVE_REPLIES
    • Sample Payload - LEAD_MARKED_AS_INTERESTED
    • Sample Payload - EMAIL_SENT
    • Add a new webhook
    • List webhooks
    • Delete webhook(s)
  • Tag
    • List Tags
  • For Email Infra Provider Partner
    • List workspaces
    • Initiate Google OAuth login flow
    • Initiate Microsoft OAuth login flow
    • Bulk Add SMTP Accounts (via Username and Password)
  1. Analytics

Get campaign stats

GET
https://api.plusvibe.ai/api/v1/analytics/campaign/stats
Analytics
Retrieve detailed statistics for a specific campaign or all campaigns within a workspace. Users can track metrics such as lead count, completion status, contact interactions, and more to gain insights into campaign performance and engagement levels. This section provides valuable data for analyzing and optimizing marketing strategies.
Get the statistics for a campaign or all campaigns
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plusvibe.ai/api/v1/analytics/campaign/stats?workspace_id&start_date' \
--header 'x-api-key;'
Response Response Example
200 - Example 1
{
    "0": {
        "_id": "6708335e989304cbe094646e",
        "camp_name": "Campagin 1",
        "status": "COMPLETED",
        "lead_count": 3088,
        "completed_lead_count": 3088,
        "lead_contacted_count": 3087,
        "new_completed_lead_count": 300,
        "new_lead_contacted_count": 250,
        "sent_count": 8585,
        "unique_opened_count": 0,
        "replied_count": 234,
        "bounced_count": 67,
        "unsubscribed_count": 0,
        "created_at": "2024-10-10T20:04:46.742Z",
        "positive_reply_count": 123,
        "opportunity_val": 61500,
        "start_date": "2024-10-01T00:00:00.000Z",
        "end_date": "2024-11-04T23:59:59.999Z",
        "opportunity_val_per_count": 500
    },
    "1": {
        "_id": "66facebf131507b299c5016f",
        "camp_name": "Campaign 2",
        "status": "COMPLETED",
        "lead_count": 986,
        "completed_lead_count": 986,
        "lead_contacted_count": 946,
        "new_completed_lead_count": 946,
        "new_lead_contacted_count": 946,
        "sent_count": 2283,
        "unique_opened_count": 0,
        "replied_count": 113,
        "bounced_count": 33,
        "unsubscribed_count": 0,
        "created_at": "2024-09-30T16:15:59.541Z",
        "positive_reply_count": 77,
        "opportunity_val": 38500,
        "start_date": "2024-10-01T00:00:00.000Z",
        "end_date": "2024-11-04T23:59:59.999Z",
        "opportunity_val_per_count": 500
    }
}

Request

Query Params
workspace_id
string 
required
The ID of the workspace associated with the campaign.
Default:
Example:
65f3c92d3dbe5dbb35374a9a
campaign_id
string 
optional
Campaign ID (If not passed, the endpoint will return all campaigns of the workspace)
Default:
Example:
66b447598f6dd99f7f7b5c0a
start_date
string <date>
required
The start date of the analytics period.
Default:
Example:
2024-06-21
end_date
string <date>
optional
The optional end date of the analytics period.
Default:
Example:
2024-06-30
Header Params
x-api-key
string 
required
Your PlusVibe.ai account's API Key
Default:
Example:
your-api-key

Responses

🟢200OK
application/json
Successful operation
Body
0
object 
optional
_id
string 
optional
The unique identifier for the campaign.
Example:
6708335e989304cbe094646e
camp_name
string 
optional
The name of the campaign.
Example:
Campagin 1
status
string 
optional
The current status of the campaign.
Example:
COMPLETED
lead_count
number 
optional
The total number of leads in the campaign.
Example:
3088
completed_lead_count
number 
optional
The number of leads that have been successfully completed since the launch of the campaign
Example:
3088
lead_contacted_count
number 
optional
Total number of leads contacted within the given time frame, including those previously engaged in earlier steps
Example:
3087
new_completed_lead_count
number 
optional
The number of leads that have been successfully completed during the given time frame
Example:
300
new_lead_contacted_count
number 
optional
The number of unique leads contacted for the first time within the given time frame
Example:
250
sent_count
number 
optional
The total number of emails sent in the campaign.
Example:
8585
unique_opened_count
number 
optional
The number of unique recipients who opened the campaign.
replied_count
number 
optional
The number of recipients who replied to the campaign.
Example:
234
bounced_count
number 
optional
The number of emails that bounced back from the campaign.
Example:
67
unsubscribed_count
number 
optional
The number of recipients who unsubscribed from the campaign.
created_at
string 
optional
The date and time when the campaign was created.
Example:
2024-10-10T20:04:46.742Z
positive_reply_count
number 
optional
The number of recipients who replied positively to the campaign.
Example:
123
opportunity_val
number 
optional
The total value of opportunities from the campaign.
Example:
61500
start_date
string 
optional
The start date of the analytics period.
Example:
2024-10-01T00:00:00.000Z
end_date
string 
optional
The optional end date of the analytics period.
Example:
2024-11-04T23:59:59.999Z
opportunity_val_per_count
number 
optional
The value of opportunities per positive reply
Example:
500
1
object 
optional
A placeholder for a specific parameter that is not explicitly defined.
_id
string 
optional
The unique identifier for the campaign.
Example:
66facebf131507b299c5016f
camp_name
string 
optional
The name of the campaign.
Example:
Campaign 2
status
string 
optional
The current status of the campaign.
Example:
COMPLETED
lead_count
number 
optional
The total number of leads in the campaign.
Example:
986
completed_lead_count
number 
optional
The number of leads that have been successfully completed since the launch of the campaign
Example:
986
lead_contacted_count
number 
optional
Total number of leads contacted within the given time frame, including those previously engaged in earlier steps
Example:
946
new_completed_lead_count
number 
optional
The number of leads that have been successfully completed during the given time frame
Example:
946
new_lead_contacted_count
number 
optional
The number of unique leads contacted for the first time within the given time frame
Example:
946
sent_count
number 
optional
The total number of emails sent in the campaign.
Example:
2283
unique_opened_count
number 
optional
The number of unique recipients who opened the campaign.
replied_count
number 
optional
The number of recipients who replied to the campaign.
Example:
113
bounced_count
number 
optional
The count of emails that bounced back from recipients.
Example:
33
unsubscribed_count
number 
optional
The count of recipients who unsubscribed from the campaign.
created_at
string 
optional
The date and time when the campaign stats were created.
Example:
2024-09-30T16:15:59.541Z
positive_reply_count
number 
optional
The number of recipients who replied positively to the campaign.
Example:
77
opportunity_val
number 
optional
The total value of opportunities linked to the campaign.
Example:
38500
start_date
string 
optional
The start date of the campaign statistics.
Example:
2024-10-01T00:00:00.000Z
end_date
string 
optional
The optional end date of the analytics period.
Example:
2024-11-04T23:59:59.999Z
opportunity_val_per_count
number 
optional
The value of opportunities per positive reply
Example:
500
🟠400Bad Request
🔴500Server Error
Modified at 2025-05-24 05:40:10
Previous
Get campaign count (deprecated)
Next
Get all campaigns statistics
Built with