Skip to Content
API ReferenceWhatsAppConversation Analytics

Conversation Analytics

Counts conversations for a WABA, with optional breakdowns by category, type, direction, country, or phone number. Same WhatsApp Cloud API field passthrough as Message Analytics.

Cost is not returned by this endpoint — Meta stopped surfacing it for businesses billed through a partner as of July 1 2023. For dollar amounts, use your Splashify /billing/deductions ledger.

GET /api/v25.0/{WABA_ID}?fields=conversation_analytics.start(<unix>).end(<unix>).granularity(<granularity>)
Authorization: Bearer pk_live_<your-key>

Customer-scoped alias

GET /api/v1/partner/customers/{customer_id}/whatsapp/analytics/conversations?fields=…

Query parameters

Single fields= blob:

fields=conversation_analytics.start(<unix>).end(<unix>).granularity(<HALF_HOUR|DAILY|MONTHLY>)
       [.phone_numbers([...])]
       [.metric_types([CONVERSATION])]
       [.conversation_categories([AUTHENTICATION,MARKETING,SERVICE,UTILITY])]
       [.conversation_types([FREE_ENTRY,FREE_TIER,REGULAR])]
       [.conversation_directions([BUSINESS_INITIATED,USER_INITIATED])]
       [.dimensions(["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY","PHONE"])]
FieldRequiredNotes
startyesUNIX timestamp
endyesUNIX timestamp
granularityyesHALF_HOUR / DAILY / MONTHLY
phone_numbersnoLimit to specific numbers; omit for all on the WABA
metric_typesnoCONVERSATION is the only reliable value for partners
conversation_categoriesnoFilter to a subset of AUTHENTICATION / MARKETING / SERVICE / UTILITY
conversation_typesnoFREE_ENTRY / FREE_TIER / REGULAR
conversation_directionsnoBUSINESS_INITIATED / USER_INITIATED
dimensionsnoBreak the counts down by CONVERSATION_CATEGORY, CONVERSATION_DIRECTION, CONVERSATION_TYPE, COUNTRY, PHONE

Response — 200

{
  "conversation_analytics": {
    "data": [
      {
        "data_points": [
          {
            "start":                 1693506600,
            "end":                   1696098600,
            "conversation":          1,
            "phone_number":          "912240289385",
            "country":               "KW",
            "conversation_type":     "REGULAR",
            "conversation_category": "MARKETING"
          }
        ]
      }
    ]
  },
  "id": "115344761664057"
}

Errors

Same matrix as Message Analytics.

cURL

curl -X GET \
  "https://api.splashifypro.com/api/v25.0/$WABA_ID?fields=conversation_analytics.start(1693506600).end(1706725800).granularity(MONTHLY).dimensions(%5B%22CONVERSATION_CATEGORY%22%2C%22CONVERSATION_TYPE%22%2C%22COUNTRY%22%2C%22PHONE%22%5D)" \
  -H "Authorization: Bearer $SPLASHIFY_API_KEY"
Message AnalyticsTemplate Analytics