Skip to content
Wazapin
Esc
navigateopen⌘Jpreview

Get template analytics

POST/v1/channels/{channelID}/analytics/templates
Authorization
bearerAuthbearerAuthrequired
or
apiKeyAuthapiKeyAuthrequired
Path parameters
channelIDstringrequired
Channel ID
Request body
requiredapplication/json
endinteger<int64>required
End timestamp (Unix epoch)
metric_typesstring[] | null
Metric types to retrieve
startinteger<int64>required
Start timestamp (Unix epoch)
template_idsstring[] | nullrequired
Template IDs (1-10)
min items 1 · max items 10
Responses
200OK
dataTemplateAnalyticsDataItem[] | null
Show properties
Array of TemplateAnalyticsDataItem
data_pointsTemplateAnalyticsPointItem[] | null
Show properties
Array of TemplateAnalyticsPointItem
clickedTemplateClickedItem[] | null
Show properties
Array of TemplateClickedItem
button_contentstring
countinteger<int64>
typestring
costTemplateCostMetricItem[] | null
Show properties
Array of TemplateCostMetricItem
typestring
valuenumber<double>
deliveredinteger<int64>
endinteger<int64>
readinteger<int64>
repliedinteger<int64>
sentinteger<int64>
startinteger<int64>
template_idstring
granularitystring
product_typestring
400Bad Request
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
401Unauthorized
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
403Forbidden
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
404Not Found
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
422Unprocessable Entity
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
500Internal Server Error
errorErrorBodyrequired
Show properties
codestringrequired
detailsErrorDetail[] | null
Show properties
Array of ErrorDetail
codestring
fieldstring
locationstring
messagestringrequired
messagestringrequired
request_idstring
Request
curl -X POST "/v1/channels/string/analytics/templates" \
  -H "Content-Type: application/json" \
  -d '{
  "end": 0,
  "metric_types": [
    "string"
  ],
  "start": 0,
  "template_ids": [
    "string"
  ]
}'
Response
{
  "data": [
    {
      "data_points": [
        {
          "clicked": [
            {
              "button_content": "string",
              "count": 0,
              "type": "string"
            }
          ],
          "cost": [
            {
              "type": "string",
              "value": 0
            }
          ],
          "delivered": 0,
          "end": 0,
          "read": 0,
          "replied": 0,
          "sent": 0,
          "start": 0,
          "template_id": "string"
        }
      ],
      "granularity": "string",
      "product_type": "string"
    }
  ]
}