API Reference

Get statistics

get
https://campaign-api.omni.chat/v1/stats/

Retrieves campaign results for a period informed by parameter. If the period is not informed, the last 7 days will be considered.

Returns the following information grouped by campaign:

  • sent: total messages sent in the period.
  • delivered: total messages delivered in the period.
  • read: total messages read in the period.
  • error: total messages failed in the period.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The earliest date for which data should be returned. Date should be formatted as ISO 8601 (YYYY-MM-DDTHH:mm:ss).

string

The latest date for which data should be returned. Date should be formatted as ISO 8601 (YYYY-MM-DDTHH:mm:ss).

string

Time zone used in dates, a list of time zones supported can be found here (https://timezonedb.com/time-zones) in the Time Zone column, by default the value is America/Sao_Paulo

Responses

Updated 14 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 14 days ago