Global Reports Overview

Fetch aggregate metrics across all campaigns of the customer.

GET /reports

Retrieves global aggregate delivery and engagement metrics (Sent, Bounced, Delivered, Opened, Clicked, Unsubscribed) summed across all campaigns belonging to the customer, plus a paginated list of all campaigns with their individual stats.

Query Parameters

Parameter	Type	Status	Description
per_page	Integer	Optional	Number of campaigns to return in the list per page (Default: `15`).
page	Integer	Optional	The page number of results to fetch (Default: `1`).

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/reports?per_page=1" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Overview statistics retrieved successfully.",
    "totals": {
        "sent": 25000,
        "bounced": 180,
        "delivered": 24820,
        "opened": 8200,
        "clicked": 3400,
        "unsubscribed": 110,
        "complained": 12,
        "replied": 320,
        "open_rate": 32.8,
        "click_rate": 13.6,
        "bounce_rate": 0.72
    },
    "campaigns": [
        {
            "id": 8,
            "uuid": "9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4",
            "campaign_name": "Summer Promotion 2026",
            "campaign_type": "regular",
            "status": "sent",
            "send_at": "2026-08-21T09:00:00.000000Z",
            "sents": 1500,
            "bounces": 12,
            "delivereds": 1488,
            "opens": 450,
            "clicks": 180,
            "unsubscribes": 5,
            "replies": 25,
            "complaints": 2,
            "open_rate": 30,
            "click_rate": 12,
            "bounce_rate": 0.8
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 10,
        "per_page": 1,
        "total": 10
    }
}