WhatsApp Business Management API

We are making changes to the WhatsApp Business Platform pricing model. See Pricing Updates on the WhatsApp Business Platform.

Template Comparison

You can compare two templates by examining how often each one is sent, which one has the lower ratio of blocks to sends, and each template's top reason for being blocked.

Requirements

Limitations

  • Only two templates can be compared at a time.
  • Both templates must be in the same WhatsApp Business Account.
  • Templates must have been sent at least 1,000 times in the queries specified timeframe.
  • Timeframes are limited to 7, 30, 60 and 90 day lookbacks from the time of the request.

Comparing Templates

Use the WhatsApp Message Template > Compare endpoint to target one template and compare it with another.

Request Syntax

GET /<WHATSAPP_MESSAGE_TEMPLATE_ID>/compare
  ?template_ids=[<TEMPLATE_IDS]
  &start=<START>
  &end=<END>

Query Parameters

PlaceholderDescription

<WHATSAPP_MESSAGE_TEMPLATE_ID>

ID of the WhatsApp Message Template to target.

<TEMPLATE_IDS>

ID of the WhatsApp Message Template to compare the target to.

<START>

UNIX timestamp indicating start of timeframe. See Timeframes.

<END>

UNIX timestamp indicating end of timeframe. See Timeframes.

Timeframes

Timeframes are limited to 7, 30, 60 and 90 day lookbacks from the time of the request. To define a timeframe, set your end date to the current time as a UNIX timestamp, then subtract the number of days for your desired timeframe, in seconds, from that value:

  • Subtract 604800 for a 7 day window.
  • Subtract 2592000 for a 30 day window.
  • Subtract 5184000 for a 60 day window.
  • Subtract 7776000 for a 90 day window.

Response

Upon success, the API will return a list of WhatsApp Business Template Comparison nodes describing each template's block rate, number of times sent, and top reason for being blocked.

{
  "data": [
    {
      "metric": "BLOCK_RATE",
      "type": "RELATIVE",
      "order_by_relative_metric": [<ORDER_BY_RELATIVE_METRIC>]
    },
    {
      "metric": "MESSAGE_SENDS",
      "type": "NUMBER_VALUES",
      "number_values": [<NUMBER_VALUES>]
    },
    {
      "metric": "TOP_BLOCK_REASON",
      "type": "STRING_VALUES",
      "string_values": [<STRING_VALUES>]
    }
  ]
}

Response Contents

PlaceholderDescription

<ORDER_BY_RELATIVE_METRIC>

Array of template ID strings, in increasing order of block rate (ratio of blocks to sends).

<NUMBER_VALUES>

Array of message send number value objects. Objects have the following properties:


  • key — String. WhatsApp Message Template ID.
  • value — Integer. Number of times sent in a template message.

<STRING_VALUES>

Array of top block reason string value objects. Objects have the following properties:


  • key — String. WhatsApp Message Template ID.
  • value — String. Top block reason.

Block reasons can be:


  • NO_LONGER_NEEDED
  • NO_REASON
  • NO_REASON_GIVEN
  • NO_SIGN_UP
  • OFFENSIVE_MESSAGES
  • OTHER
  • OTP_DID_NOT_REQUEST
  • SPAM
  • UNKNOWN_BLOCK_REASON

See the View metrics for your WhatsApp Business message template help center topic for descriptions of these reasons.

Sample Request

curl -X GET 'https://graph.facebook.com/v21.0/5289179717853347/compare?template_ids=[1533406637136032]&start=1674844791182&end=1674845395982' \
-H 'Authorization: Bearer EAAJB...'

Sample Response

{
  "data": [
    {
      "metric": "BLOCK_RATE",
      "type": "RELATIVE",
      "order_by_relative_metric": [
        "1533406637136032",
        "5289179717853347"
      ]
    },
    {
      "metric": "MESSAGE_SENDS",
      "type": "NUMBER_VALUES",
      "number_values": [
        {
          "key": "5289179717853347",
          "value": 1273
        },
        {
          "key": "1533406637136032",
          "value": 1042
        }
      ]
    },
    {
      "metric": "TOP_BLOCK_REASON",
      "type": "STRING_VALUES",
      "string_values": [
        {
          "key": "5289179717853347",
          "value": "UNKNOWN_BLOCK_REASON"
        },
        {
          "key": "1533406637136032",
          "value": "UNKNOWN_BLOCK_REASON"
        }
      ]
    }
  ]
}