Engagive API documentation

Channels · WhatsApp · Campaigns

Reporting

Base URL & auth

  • Prefix: /api/business/public on https://api.engagive.io (full base: https://api.engagive.io/api/business/public).
  • Header: Authorization: Bearer <token> — create the token under Profile → API access token in the business app.
  • See also: Authentication, Errors & responses.

Inspect recipients, aggregate delivery analytics, and campaign event history after launch.

GET

List recipients

Required permission: WhatsApp Campaigns — View

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/recipients
Example success response (JSON)
{
  "success": true,
  "data": [
    {
      "id": 1,
      "contact_id": 42,
      "status": "sent",
      "phone_number": "923001234567"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalCount": 1,
    "totalPages": 1
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/recipients?page=1&pageSize=20
GET

Campaign analytics

Required permission: WhatsApp Campaigns — View

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/analytics
Example success response (JSON)
{
  "success": true,
  "statusCode": 200,
  "data": {
    "total_recipients": 250,
    "counts_pending": 10,
    "counts_queued": 0,
    "counts_sending": 0,
    "counts_sent": 200,
    "counts_delivered": 180,
    "counts_read": 90,
    "counts_failed": 5,
    "counts_retrying": 0,
    "counts_skipped": 0,
    "counts_replied": 2,
    "counts_cancelled": 0
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/analytics
GET

Campaign events

Required permission: WhatsApp Campaigns — View

Audit/event log for the campaign (launch, pause, etc.).

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/events
Example success response (JSON)
{
  "success": true,
  "data": [
    {
      "id": 1,
      "event_type": "launched",
      "created_at": "2026-08-05T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 20,
    "totalCount": 1,
    "totalPages": 1
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/events?page=1&pageSize=20