API reference · Account

Get a report

Sent, delivered and failed totals for a date range.

GET/v1/reports/summary

Bearer API key
Rate limit 300 / min
Returns 200 OK
Needs the Billing permission · free

GET /v1/reports/summary

curl https://api.talks.africa/v1/reports/summary \
  -H "Authorization: Bearer $TALKS_KEY"

{
  "period": "2026-11-01..2026-11-13",
  "total_sent": 128402,
  "total_delivered": 126731,
  "total_failed": 1671,
  "delivery_rate_percent": 98.7,
  "total_credits_used": 162880
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Parameters

start_datestringoptional
YYYY-MM-DD
end_datestringoptional
YYYY-MM-DD

Response fieldsResponse

total_sent · total_delivered · total_failed
Counts
delivery_rate_percent
Delivered ÷ sent
total_credits_used
Credits spent

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?