Insights
Read the insights overview
Return the headline messaging numbers for a period.
Returns messages sent and received, conversations opened, and delivery quality for the period. Use it to answer "how did we do this week" in a single call before drilling into the other insights endpoints. Defaults to the last 7 days; the range cannot exceed 90 days, which is Meta's limit. Read-only and rate-limited to 20 calls per minute.
query Parameters
startDateUnix seconds, start of the period. Defaults to 7 days ago.
Unix seconds, start of the period. Defaults to 7 days ago.
endDateUnix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
Unix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
granularityBucket size for the series.
Bucket size for the series.
phoneNumberIdRestrict to one number, id from channels.phoneNumbers.
Restrict to one number, id from channels.phoneNumbers.
Read the insights overview › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead message volume
Return message counts broken down over the period.
Returns message volume by interval and direction for the period, from Meta's analytics. Use it to spot a drop or a spike before digging into individual conversations. Defaults to the last 7 days, maximum 90. Read-only and rate-limited to 20 calls per minute. Answers 400 no_waba_connected when no WhatsApp Business Account is linked.
query Parameters
startDateUnix seconds, start of the period. Defaults to 7 days ago.
Unix seconds, start of the period. Defaults to 7 days ago.
endDateUnix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
Unix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
granularityBucket size for the series.
Bucket size for the series.
phoneNumberIdRestrict to one number, id from channels.phoneNumbers.
Restrict to one number, id from channels.phoneNumbers.
Read message volume › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead conversation analytics
Return conversation counts and their billing categories for the period.
Returns how many conversations opened in the period and how they were categorised for billing. Use it to understand messaging cost and workload. Defaults to the last 7 days, maximum 90. Read-only and rate-limited to 20 calls per minute.
query Parameters
startDateUnix seconds, start of the period. Defaults to 7 days ago.
Unix seconds, start of the period. Defaults to 7 days ago.
endDateUnix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
Unix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
granularityBucket size for the series.
Bucket size for the series.
phoneNumberIdRestrict to one number, id from channels.phoneNumbers.
Restrict to one number, id from channels.phoneNumbers.
Read conversation analytics › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead template performance
Return per-template delivery and read counts for the period.
Returns how each WhatsApp template performed — sent, delivered, read and clicked. Use it to see which template actually reaches people before committing to another broadcast. Defaults to the last 7 days, maximum 90. endDate must also fall within the last 90 days, which is how far back Meta keeps template analytics; an older one answers 400 invalid_date_range. Read-only and rate-limited to 20 calls per minute.
query Parameters
startDateUnix seconds, start of the period. Defaults to 7 days ago.
Unix seconds, start of the period. Defaults to 7 days ago.
endDateUnix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
Unix seconds, end of the period. Must be later than startDate, and the range cannot exceed 90 days (Meta's limit).
granularityBucket size for the series.
Bucket size for the series.
phoneNumberIdRestrict to one number, id from channels.phoneNumbers.
Restrict to one number, id from channels.phoneNumbers.
Read template performance › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successRead the workspace summary
Return the dashboard summary — customer counts, message totals and channel health.
Returns the workspace-level numbers the dashboard shows for a time range: customers, messages, and how the connected channels are doing. Use it as a single orientation call at the start of a session. Unlike the insights endpoints this reads our own database rather than Meta, so it works without a WhatsApp Business Account. Read-only and rate-limited to 20 calls per minute.
query Parameters
timeRangeRolling window to summarise. Defaults to 7d.
Rolling window to summarise. Defaults to 7d.
Read the workspace summary › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successGet dashboard statistics
Return the headline dashboard figures for a date range.
Returns the same headline numbers as the web dashboard: conversation, message and customer counts and response metrics. Use it for a quick account health summary; use the insights.* operations for narrower breakdowns. Aggregates many tables, so it is rate limited as expensive. Read-only. Results may be cached for up to a minute.
query Parameters
startDateStart of the range, ISO-8601 date or time. Send together with endDate; omitted means the default window.
Start of the range, ISO-8601 date or time. Send together with endDate; omitted means the default window.
endDateEnd of the range, ISO-8601 date or time. Send together with startDate.
End of the range, ISO-8601 date or time. Send together with startDate.
whatsappPhoneNumberIdOnly this WhatsApp number, id from channels.phoneNumbers. Omit for all numbers.
Only this WhatsApp number, id from channels.phoneNumbers. Omit for all numbers.
Get dashboard statistics › Responses
The API key is missing, malformed, expired, or its owner is inactive.
successGet customer insights
Return the dashboard customer breakdown: new, returning and active customers.
Returns the customer-side dashboard figures (growth, engagement and segments). Use it to understand who is writing in. Aggregates many rows, so it is rate limited as expensive. Read-only. Results may be cached for up to two minutes.
query Parameters
whatsappPhoneNumberIdOnly this WhatsApp number, id from channels.phoneNumbers. Omit for all numbers.
Only this WhatsApp number, id from channels.phoneNumbers. Omit for all numbers.
Get customer insights › Responses
The API key is missing, malformed, expired, or its owner is inactive.
success