Get SMS campaign stats

GET

https://api.hive.co/v2/campaigns/sms/:campaign_id/stats/

GET

/v2/campaigns/sms/:campaign_id/stats/

curl https://api.hive.co/v2/campaigns/sms/campaign_id/stats/ \
     -H "X-Partner-Id: X-Partner-Id" \
     -H "Authorization: Bearer <token>"

{
  "campaign_id": "string",
  "stats_refreshed_at": "2024-01-15T09:30:00Z",
  "stats": {
    "counts": {
      "sent": 0,
      "delivered": 0,
      "clicked": 0,
      "failed": 0,
      "opted_out": 0,
      "opted_in": 0,
      "undeliverable": 0
    },
    "rates": {
      "delivery_rate": 1.1,
      "click_rate": 1.1,
      "opt_out_rate": 1.1,
      "failed_rate": 1.1
    },
    "revenue": {
      "ecommerce": {
        "num_orders": 0,
        "total_revenue": 0
      },
      "ticketing": {
        "num_orders": 0,
        "total_revenue": 0
      },
      "total": {
        "num_orders": 0,
        "total_revenue": 0
      }
    }
  }
}

Engagement and revenue stats for a single SMS campaign. stats is null until the campaign’s cached stats have been computed. SMS has no open tracking, so clicks are the engagement signal.

Authentication

AuthorizationBearer

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

Path parameters

campaign_idstringRequired

Response

campaign_idstring

stats_refreshed_atdatetime or null

statsobject or null

Explicit, versioned view over the stats dict assembled by SMSCampaignsService. The cached subdocuments are never passed through, so internal key changes can't break API consumers.

Errors

404

Not Found Error

Authentication

Path parameters

Headers

Response

Errors