WhatsApp Analytics

WhatsApp Analytics

Retrieve WhatsApp conversation analytics

get

Fetch conversation analytics for a specified WhatsApp business account

Path parameters

whatsapp_business_account_idstringRequired

ID of the WhatsApp business account

Query parameters

startinteger · int64Optional

The start date for the date range you are retrieving analytics for.

Example: 1724101200

endinteger · int64Optional

The end date for the date range you are retrieving analytics for.

Example: 1724706000

granularitystring · enumOptional

The granularity by which you would like to retrieve the analytics.

Example: DAILYPossible values:

phone_numbersstring[]Optional

An array of phone numbers for which you would like to retrieve analytics.

Example: ["966920019103"]

dimensionsarray · enumOptional

List of breakdowns you would like to apply to your metrics.

Example: ["CONVERSATION_CATEGORY","CONVERSATION_TYPE","COUNTRY"]Possible values:

Responses

200

Analytics were fetched Successfully.

application/json

400

Invalid request parameters

application/json

500

Analytics Fetch Failed

application/json

get

/api/whatsapp/analytics/conversations/{whatsapp_business_account_id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/analytics/conversations/{whatsapp_business_account_id} HTTP/1.1
Accept: */*

{
  "All Conversations": {
    "total": 10,
    "marketing": 2,
    "utility": 1,
    "authentication": 3,
    "authenticationInternational": 1,
    "service": 3
  },
  "Free Conversations": {
    "total": 3,
    "freeTier": 2,
    "freeEntryPoint": 1
  },
  "Paid Conversations": {
    "total": 4,
    "marketing": 1,
    "utility": 1,
    "authentication": 1,
    "authenticationInternational": 1,
    "service": 0
  },
  "Approximate Charges": {
    "total": "$0.00",
    "marketing": "$0.00",
    "utility": "$0.00",
    "authentication": "$0.00",
    "authenticationInternational": "$0.00",
    "service": "$0.00"
  }
}

Retrieve WhatsApp conversation analytics

get

Fetch conversation analytics for a specified WhatsApp business account

Path parameters

whatsapp_business_account_idstringRequired

ID of the WhatsApp business account

Query parameters

startinteger · int64Optional

The start date for the date range you are retrieving analytics for.

Example: 1724101200

endinteger · int64Optional

The end date for the date range you are retrieving analytics for.

Example: 1724706000

granularitystring · enumOptional

The granularity by which you would like to retrieve the analytics.

Example: DAILYPossible values:

phone_numbersstring[]Optional

An array of phone numbers for which you would like to retrieve analytics.

Example: ["966920019103"]

dimensionsstring · enumOptional

List of breakdowns you would like to apply to your metrics.

Example: CONVERSATION_CATEGORY, CONVERSATION_TYPE, COUNTRYPossible values:

Responses

200

Analytics were fetched Successfully.

No content

400

Invalid request parameters

application/json

500

Analytics Fetch Failed

application/json

get

/api/whatsapp/analytics/conversations-data-points/{whatsapp_business_account_id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/analytics/conversations-data-points/{whatsapp_business_account_id} HTTP/1.1
Accept: */*

No content

Retrieve WhatsApp message analytics data points

get

Fetch message analytics data points for a specified WhatsApp business account

Path parameters

whatsapp_business_account_idstringRequired

ID of the WhatsApp business account

Query parameters

startinteger · int64Optional

The start date for the date range you are retrieving analytics for.

Example: 1724101200

endinteger · int64Optional

The end date for the date range you are retrieving analytics for.

Example: 1724706000

granularitystring · enumOptional

The granularity by which you would like to retrieve the analytics.

Example: DAYPossible values:

Responses

200

Analytics were fetched Successfully.

application/json

data_points_oneobject[]Optional

data_points_twoobject[]Optional

400

Validation Error(s)

application/json

500

Analytics Fetch Failed

application/json

get

/api/whatsapp/analytics/messages-data-points/{whatsapp_business_account_id}

HTTPcURLJavaScriptPython

GET /api/whatsapp/analytics/messages-data-points/{whatsapp_business_account_id} HTTP/1.1
Accept: */*

{
  "data_points_one": [
    {}
  ],
  "data_points_two": [
    {}
  ]
}

Retrieve template analytics

get

Fetches analytics data for specified templates within a date range.

Path parameters

whatsapp_business_account_idstringRequired

WhatsApp Business Account ID

Query parameters

startinteger · int64Optional

Start timestamp (UTC midnight)

endinteger · int64Optional

End timestamp (UTC midnight)

granularitystring · enumOptional

Data granularity (e.g., DAILY)

Possible values:

template_idsinteger[]Required

Array of template IDs

product_typestring · enumOptional

Product type

Possible values:

Responses

200

Successful operation

application/json

successbooleanOptional

messagestringOptional

400

Validation Error(s)

application/json

500

Analytics fetch failed

application/json

get

/api/whatsapp/{whatsapp_business_account_id}/template-analytics

HTTPcURLJavaScriptPython

GET /api/whatsapp/{whatsapp_business_account_id}/template-analytics?template_ids=1 HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "text",
  "data": {
    "total_sent": 1,
    "total_delivered": 1,
    "total_read": 1,
    "read_rate": 1,
    "data_points": [
      {
        "template_id": "text",
        "start": 1,
        "end": 1,
        "sent": 1,
        "delivered": 1,
        "read": 1,
        "cost": [
          {
            "type": "text",
            "value": 1
          }
        ]
      }
    ]
  }
}