Campaign Reports

Retrieve aggregate delivery and engagement metrics for a specific campaign.

GET /campaigns/{uuid}/reports

Retrieves aggregate statistics for a specific campaign, including sent emails count, bounced emails count, delivered count (Sent - Bounces), opens count, links clicks count, and unsubscribes.

URL Parameters

Parameter	Type	Status	Description
uuid	String (UUID or ID)	Required	The unique UUID or physical numeric ID of the campaign.

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/campaigns/9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4/reports" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Campaign metrics retrieved successfully.",
    "data": {
        "campaign_id": 8,
        "campaign_uuid": "9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4",
        "campaign_name": "Summer Promotion 2026",
        "subject": "Get 20% off all plans this summer!",
        "status": "sent",
        "send_at": "2026-08-21T09:00:00.000000Z",
        "metrics": {
            "sent": 1500,
            "bounced": 12,
            "delivered": 1488,
            "opened": 450,
            "clicked": 180,
            "unsubscribed": 5,
            "replied": 25,
            "complained": 2,
            "open_rate": 30.00,
            "click_rate": 12.00,
            "bounce_rate": 0.80
        }
    }
}