PlusVibe.ai

Get campaign summary

GET

https://api.plusvibe.ai/api/v1/analytics/campaign/summary

Analytics

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.plusvibe.ai/api/v1/analytics/campaign/summary?workspace_id&campaign_id' \
--header 'x-api-key;'

Response Example

200 - Example 1

{
    "campaign_id": "66b447598f6dd99f7f7b5c0a",
    "campaign_name": "New Product Launch",
    "completed": 150,
    "contacted": 300,
    "leads_who_read": 200,
    "leads_who_replied": 30,
    "bounced": 12,
    "unsubscribed": 8
}

Request

Query Params

workspace_id

string

required

Workspace ID

Default:

Example:

65f3c92d3dbe5dbb35374a9a

campaign_id

string

required

Campaign ID

Default:

Example:

66b447598f6dd99f7f7b5c0a

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

campaign_id

string

optional

Campaign ID

Example:

66b447598f6dd99f7f7b5c0a

campaign_name

string

optional

The name of the campaign.

Example:

New Product Launch

completed

integer <int32>

optional

The number of leads that have completed the campaign process.

Example:

150

contacted

integer <int32>

optional

The number of leads that have been contacted during the campaign.

Example:

300

leads_who_read

integer <int32>

optional

The number of leads who opened the emails sent during the campaign.

Example:

200

leads_who_replied

integer <int32>

optional

The number of leads who replied to the emails sent during the campaign.

Example:

bounced

integer <int32>

optional

The number of emails that bounced back and were not delivered.

Example:

unsubscribed

integer <int32>

optional

The number of leads who unsubscribed from the campaign.

Example:

🟠400Bad Request

🔴500Server Error

Modified at 2025-05-24 05:40:10

Bulk Add SMTP Accounts

Get campaign count (deprecated)