GuidesRecipesAPI Reference
API Reference
Select productLog inHelp centre

Retrieves WhatsApp conversation analytics

get
https://{region}-api.dotdigital.com/cpaas/analytics/whatsapp/conversations
Query Params
wabaIds
array of strings

The ids of the WhatsApp Business Account to get conversation analytics for

wabaIds
date-time
required

The date time to query up to (but not including) in ISO 8601 format UTC

date-time
required

The date time to query from in ISO 8601 format UTC

string
enum

The time period to aggregate by

Allowed:
phoneNumbers
array of strings

An array of phone numbers for which to retrieve analytics. If not provided, all phone numbers added to the WABA are included

phoneNumbers
conversationCategories
array of strings

A list of conversation categories. If not provided, results for all conversation categories are retrieved.

conversationCategories
dimensions
array of strings

A list of breakdowns to apply to metrics. If not provided, results are retrieved without any breakdowns

dimensions
Responses

400

Validation errors were found

404

The API Space was not

Updated 6 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago