Transactional WhatsAppTransactional 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)

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Query parameters

limitlongOptionalDefaults to 2500
Number limitation for the result returned
offsetlongOptionalDefaults to 0
Beginning point in the list to retrieve from
startDatestringOptional

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

endDatestringOptional

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

dayslongOptional

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

contactNumberstringOptionalformat: "mobile"

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

eventenumOptional
Filter the report for a specific event type
sortenumOptionalDefaults to desc

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

Allowed values:

Response

WhatsApp events report
eventslist of objects or null

Errors