WhatsApp Broadcast Report — POST /api/v1/broadcast-report

Use this endpoint to retrieve delivery and engagement statistics for all WhatsApp broadcasts you have sent through your Botsify bot within a given date range. The report includes metrics such as the number of messages sent, delivered, read, and failed, giving you visibility into the reach and effectiveness of your campaigns. Supply your bot API key in the request body or via the X-Api-Key header, along with your desired date window.

Request

string

required

Your bot’s API key. You may alternatively supply this value in the X-Api-Key request header instead of the body.

string

required

The start of the reporting period in YYYY-MM-DD format (e.g., 2024-01-01).

string

required

The end of the reporting period in YYYY-MM-DD format (e.g., 2024-01-31). Must be greater than or equal to start_date.

Example Request

curl --request POST \
  --url https://app.botsify.com/api/v1/whatsapp-broadcast-report \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: YOUR_BOT_API_KEY' \
  --data '{
    "apikey": "BOT_KEY",
    "start_date": "2024-01-01",
    "end_date": "2024-01-31"
  }'

Response

A successful request returns a JSON object containing a list of broadcast campaign reports for the specified date range. Each record includes the broadcast identifier, the template used, the number of messages sent, delivered, read, and any failures. Aggregate totals for the period are also included.

{
  "start_date": "2024-01-01",
  "end_date": "2024-01-31",
  "broadcasts": [
    {
      "broadcast_id": "bcast_20240110_001",
      "template": "welcome_message",
      "sent": 500,
      "delivered": 487,
      "read": 320,
      "failed": 13,
      "sent_at": "2024-01-10T14:00:00Z"
    },
    {
      "broadcast_id": "bcast_20240120_002",
      "template": "order_confirmation",
      "sent": 210,
      "delivered": 205,
      "read": 198,
      "failed": 5,
      "sent_at": "2024-01-20T10:30:00Z"
    }
  ],
  "totals": {
    "sent": 710,
    "delivered": 692,
    "read": 518,
    "failed": 18
  }
}

Authorization

Bots & Agents

Agent Versions

Messaging

Users & Analytics

WhatsApp

WhatsApp Broadcast Report — POST /api/v1/broadcast-report

Request

Example Request

Response

​Request

​Example Request

​Response

Request

Example Request

Response