PlusVibe.ai
  1. Email Account
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
    • Get email account status
      GET
    • Check account vitals
      POST
    • Enable Email account warmup
      POST
    • Pause Email account warmup
      POST
    • Delete Email account
      POST
    • Get Warmup Stats (Individual Account)
      GET
    • Get Warmup Stats (Workspace-Level)
      GET
    • Bulk Add SMTP Accounts
      POST
  • Analytics
    • Get campaign summary
    • Get campaign count (deprecated)
    • Get campaign stats
    • Get all campaigns statistics
  • 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. Email Account

Get Warmup Stats (Workspace-Level)

GET
https://api.plusvibe.ai/api/v1/account/warmup-stats
Email Account
Returns warmup metrics (inbox, spam, promotion) for all email accounts in a workspace over a given date range if email_acc_id is not provided.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.plusvibe.ai/api/v1/account/warmup-stats?workspace_id&start_date&end_date'
Response Response Example
200 - Example 1
{
    "status": "success",
    "emailAcc": {
        "google_percent": "99.2",
        "other_percent": "99.9",
        "microsoft_percent": "99.4",
        "total_inbox_sent": 10980,
        "total_spam_sent": 65,
        "total_promotion_sent": 0,
        "total_warmup_sent": 11045,
        "inbox_percent": "99.4",
        "spam_percent": "0.6",
        "promotion_percent": "0.0",
        "chart_data": [
            {
                "date": "7 Feb 25",
                "dt": "2025-02-07",
                "inbox": 683,
                "spam": 28,
                "promotion": 0
            }
        ],
        "total_inboxes": 40,
        "total_domains": 14,
        "email_domain_detail": {
            "plusvibeainow.com": 2,
            "tryplusvibeai.com": 3,
            "findplusvibeai.com": 3
        }
    }
}

Request

Query Params
workspace_id
string 
required
The ID of the workspace.
Default:
Example:
6509f7691205283f2a78f98c
start_date
string <date>
required
The start date for the warmup stats (inclusive). Must be in YYYY-MM-DD format.
Default:
Example:
2025-02-01
end_date
string <date>
required
The end date for the warmup stats (inclusive). Must be in YYYY-MM-DD format.
Default:
Example:
2025-02-28
Header Params
x-api-key
string 
optional
Your PlusVibe.ai account's API Key
Default:
Example:
your-api-key

Responses

🟢200OK
application/json
Successfully retrieved workspace-level warmup stats
Body
status
string 
optional
Example:
success
emailAcc
object 
optional
google_percent
string 
optional
Percentage of emails to Google inboxes that landed in the inbox.
Example:
99.2
other_percent
string 
optional
Percentage of emails to non-Google/Microsoft inboxes that landed in the inbox.
Example:
99.9
microsoft_percent
string 
optional
Percentage of emails to Microsoft inboxes that landed in the inbox.
Example:
99.4
total_inbox_sent
integer 
optional
Total number of emails that landed in the inbox during the warmup period.
Example:
10980
total_spam_sent
integer 
optional
Total number of emails that landed in spam during the warmup period.
Example:
65
total_promotion_sent
integer 
optional
Total number of emails that landed in promotions during the warmup period.
Example:
0
total_warmup_sent
integer 
optional
Total number of warmup emails sent across the workspace.
Example:
11045
inbox_percent
string 
optional
Percentage of total emails that landed in the inbox.
Example:
99.4
spam_percent
string 
optional
Percentage of total emails that landed in spam.
Example:
0.6
promotion_percent
string 
optional
Percentage of total emails that landed in the promotions folder.
Example:
0.0
chart_data
array [object {5}] 
optional
Daily breakdown of inbox/spam/promotion counts across all email accounts in the workspace.
total_inboxes
integer 
optional
Total number of recipient inboxes used across all email accounts.
Example:
40
total_domains
integer 
optional
Total number of recipient domains used across all email accounts.
Example:
14
email_domain_detail
object 
optional
Breakdown of email volumes by domain.
🟠400Bad Request
🟠401Unauthorized
🔴500Server Error
Modified at 2025-05-24 05:40:10
Previous
Get Warmup Stats (Individual Account)
Next
Bulk Add SMTP Accounts
Built with