Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Transactional WhatsApp

Get all your WhatsApp activity (unaggregated events)

This endpoint will show the unaggregated statistics for WhatsApp activity (30 days by default if startDate and endDate or days is not passed. The date range can not exceed 90 days)

get/whatsapp/statistics/events

Query parameters

limitinteger

Number limitation for the result returned

offsetinteger

Beginning point in the list to retrieve from

startDatestring

Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate

endDatestring

Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate

daysinteger

Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate'

contactNumberstring mobile

Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)

event'sent' | 'delivered' | 'read' | 'error' | 'unsubscribe' | 'reply' | 'soft-bounce'

Filter the report for a specific event type

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Response

WhatsApp events report

Example response

{
  "events": [
    {
      "contactNumber": "919876543210",
      "date": "2017-03-12T12:30:00.000+0000",
      "messageId": "23befbae-1505-47a8-bd27-e30ef739f32c",
      "event": "delivered",
      "reason": "23befbae-1505-47a8-bd27-e30ef739f32c",
      "body": "Hi! I am a reply",
      "mediaUrl": "https://example.com/media.png",
      "senderNumber": "919876543210"
    }
  ]
}