GET /whatsapp/statistics/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)

Servers

Query parameters

Name Type Required Description
endDate String No

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

days Integer No

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

limit Integer No

Number limitation for the result returned

Default value: 2500

sort String No

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

Valid values:

  • "desc"
  • "asc"

Default value: "desc"

event String No

Filter the report for a specific event type

Valid values:

  • "sent"
  • "read"
  • "soft-bounce"
  • "error"
  • "reply"
  • "unsubscribe"
  • "delivered"
startDate String No

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

offset Integer No

Beginning point in the list to retrieve from

Default value: 0

contactNumber String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.