API Reference

Get paginated list of campaigns

get
https://api.chatarmin.com/api/public/campaigns
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 1

The page number for pagination.

integer
Defaults to 10

The number of items per page for pagination.

string
enum

Return metrics grouped per day or month. When set, pagination is ignored for the query and all items are returned.

Allowed:
date

Start of the date range (used with groupBy). Defaults to 30 days before endDate.

date

End of the date range (used with groupBy). Defaults to today.

boolean
Defaults to true

Set to false to omit the orders arrays from the response. Revenue and order counts are still returned. Recommended for accounts with large order volumes.

Responses

Updated about 7 hours ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 7 hours ago

Did this page help you?