get
https://partner.gupshup.io/partner/bizgate/app//template-analytics/metrics//compare
Returns side-by-side metrics that compare a base template against one or more other templates over the same time window.
Request parameters
Path parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| appId | Identifier of the WhatsApp app the call acts on. | 6f414190-d45c-4671-bca1-fb6c3018cb13 | String | Required |
| gsTemplateId | Gupshup identifier of the message template. | tpl-1002 | String | Required |
Query parameters
| Key | Description | Values | Data Type | Required/Optional |
|---|---|---|---|---|
| start | Start of the reporting window, as a Unix timestamp in seconds. | 1720203204 | Integer | Required |
| end | End of the reporting window, as a Unix timestamp in seconds. | 1721088316 | Integer | Required |
| templateList | Template identifiers to compare. | — | Array | Required |
Sample cURL — Template comparison across templates.
curl --request GET \
--url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/template-analytics/metrics/tpl-1002/compare?start=1720203204&end=1721088316&templateList=<templateList>' \
--header 'Authorization: Bearer <UT>' \
--header 'Accept: application/json'Sample success response (200)
{
"status": "success",
"data": {
"data": [
{
"metric": "BLOCK_RATE",
"order_by_relative_metric": [
"6f414190-aaaa",
"6f414190-bbbb"
],
"type": "RELATIVE"
},
{
"metric": "MESSAGE_SENDS",
"number_values": [
{
"key": "6f414190-aaaa",
"value": 12450
},
{
"key": "6f414190-bbbb",
"value": 9832
}
],
"type": "NUMBER_VALUES"
},
{
"metric": "TOP_BLOCK_REASON",
"string_values": [
{
"key": "6f414190-aaaa",
"value": "NO_LONGER_NEEDED"
},
{
"key": "6f414190-bbbb",
"value": "SPAM"
}
],
"type": "STRING_VALUES"
}
]
}
}Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…