Skip to main content
GET
Read WhatsApp analytics

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Query Parameters

metric
enum<string>
required
Available options:
messaging,
pricing,
conversation,
calls,
templates,
template_groups,
groups
start
string<date>
required
end
string<date>
required
phone_number_id
string

Which number. Defaults to your default number.

granularity
enum<string>
Available options:
half_hour,
day,
daily,
month,
monthly
phone_numbers[]
string[]
country_codes[]
string[]
dimensions[]
string[]
metric_types[]
string[]
pricing_categories[]
string[]
pricing_types[]
string[]
product_types[]
string[]
directions[]
string[]
templates[]
string[]

Template names, for templates.

ids[]
string[]

Meta ids, for templates, template_groups and groups.

Response

The report.

metric
string
granularity
string | null
data_points
object[]

WhatsApp's data points, unchanged.

waba_id
string