WhatsAble
Get Started
GuidesAPI Reference
API v1Analytics

Count the template sends of a period

gethttps://api.whatsable.app/v1/analytics/templates
Build a request to copy

This page never sends a request. Fill in the fields, then copy the request and run it from your server.

Request
curl -X GET 'https://api.whatsable.app/v1/analytics/templates?from=string&to=string&time_zone=string'

Counts the messages sent with each template from from to to: sent, delivered, read and failed, with the read rate. The numbers are the ones the Analytics page of the dashboard shows.

A key on every number may leave out number_id and counts the whole organization. A key limited to some numbers must name one of them in number_id, otherwise 403 number_not_allowed_for_key.

Authorization

bearerAuth
headerAuthorizationBearer <nfy_live_<32 characters>>

An API key from Settings > API keys, sent as Authorization: Bearer <key>.

Query Parameters

from*string

The first day, YYYY-MM-DD, in time_zone.

Match^\d{4}-\d{2}-\d{2}$
to*string

The last day, YYYY-MM-DD, in time_zone. At most 90 days after from, counting both.

Match^\d{4}-\d{2}-\d{2}$
time_zone*string

The IANA time zone the days are read in, such as America/Argentina/Buenos_Aires.

Length1 <= length <= 64
number_id?string

Only this number. A key limited to some numbers must name one of them; a key on every number may leave it out for the whole organization.

Length1 <= length <= 64

Response Body

The templates sent in the period.

application/json
  1. response

Template sends for a period, per template. The same numbers as the Templates section of the dashboard's Analytics page.

object*string
from*string

The first day, as requested.

to*string

The last day, as requested.

time_zone*string
number_id*|

The number counted, or null for every number of the organization.

templates*array<>

Each template sent in the period, most sent first. A deleted template's messages are not counted.

Example Request
curl -X GET 'https://api.whatsable.app/v1/analytics/templates?from=string&to=string&time_zone=string'
Example Response
{  "object": "template_analytics",  "from": "2026-10-01",  "to": "2026-10-02",  "time_zone": "America/Argentina/Buenos_Aires",  "number_id": null,  "templates": [    {      "template_id": "cm2v8t1a00001qz8h2b3c4d5e",      "name": "order_shipped",      "language": "en_US",      "total_sent": 40,      "sent": 39,      "delivered": 38,      "read": 30,      "failed": 1,      "read_rate": 0.7692    }  ]}

Count the messages of a period GET

Counts the messages sent, delivered, read, failed and received from `from` to `to`, by day or by week. The numbers are the ones the Analytics page of the dashboard shows.

Count the conversations of a period GET

Counts the conversations and contacts that started from `from` to `to`, and how fast the team or the bot answered the customer first. The numbers are the ones the Analytics page of the dashboard shows.