Get aggregate campaign stats | Hive API

{
  "campaigns_included": 1,
  "stats_refreshed_at": "2024-01-15T09:30:00Z",
  "stats": {
    "revenue": {
      "ecommerce": {
        "num_orders": 0,
        "total_revenue": 0
      },
      "ticketing": {
        "num_orders": 0,
        "total_revenue": 0
      },
      "total": {
        "num_orders": 0,
        "total_revenue": 0
      }
    },
    "counts": {
      "sent": 0,
      "delivered": 0,
      "opened": 0,
      "clicked": 0,
      "bounced": 0,
      "soft_bounced": 0,
      "spam_complained": 0,
      "unsubscribed": 0
    },
    "rates": {
      "delivery_rate": 1.1,
      "open_rate": 1.1,
      "click_rate": 1.1,
      "bounce_rate": 1.1,
      "spam_complaint_rate": 1.1,
      "unsubscribe_rate": 1.1,
      "estimated_non_prefetched_open_rate": 1.1
    }
  }
}

One set of stats totalled across campaigns. Counts and revenue are summed; rates are recalculated from the summed counts. sent_after is inclusive and sent_before exclusive.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

campaign_idsstringOptional>=1 character

Comma-separated campaign IDs, max 100.

sent_afterdatetimeOptional

sent_beforedatetimeOptional

Response

campaigns_includedinteger

stats_refreshed_atdatetime or null

statsobject or null

Explicit, versioned view over the cached stats blob — the raw blob is never passed through, so internal key changes can’t break API consumers. Sections the campaign has no cached data for serialize as null.

Errors

422

Unprocessable Entity Error

Authentication

Headers

Query parameters

Response

Errors