API Reference

Get paginated list of flows

get
https://api.chatarmin.com/api/public/flows
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get all flows from an Chatarmin Account.

Pagination

page - At what page to start (default 1)

limit - Limit per page (default 10)

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

When set to 'day' or 'month', response items include metrics array (performance per day or month). Omit for default flow list with aggregate totals.

Allowed:
date

Start of date range (ISO date). Only applied when groupBy is used. If omitted with groupBy, no date filter is applied.

date

End of date range (ISO date). Only applied when groupBy is used. If omitted with groupBy, no date filter is applied.

Responses

Updated 9 days ago

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

Updated 9 days ago