List audiences

get

https://campaign-api.omni.chat/v1/audiences/#dynamic

Retrieves the details of audiences by paging the dataset, taking the limit, startDate, endDate and tokenPagination as query parameters. The audiences will be returned sorted by createdAt in descending order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

number

specifies the number of results to be returned from the call. If not specified, the default limit value is 100. The max limit value is also 100.

startDate

string

date formatted as ISO 8601 (YYYY-MM-DDTHH:mm:ss) where the query will start the search, by default the value is one week ago from the current date.

endDate

string

date formatted as ISO 8601 (YYYY-MM-DDTHH:mm:ss) where the search will end, by default the value is the current date.

status

string

enum

audience status.

Allowed:

tokenPagination

string

used to get the next page, if null, the request will search by the beginning. For each request, the tokenPagination will be returned in the response.

timeZone

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

200Success

401Unauthorized

500Internal Server Error