Skip to main content
GET
Get CRM summary

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

boardId
integer

Limits the metrics to one board. Without the parameter, it considers every board you can see.

dateFrom
string<date>

Start of the period analysed. The day starts in your company's time zone.

dateTo
string<date>

End of the period analysed. The day ends at 23:59:59 in your company's time zone.

won
enum<string>
default:all

Filters by card status: won won, lost lost, inProgress in progress, all all of them.

Available options:
all,
won,
lost,
inProgress

Response

200 - application/json

OK

data
object

Funnel summary within the applied filters. A card with no outcome has won: null and is counted in totalCardsInProgress, as neither won nor lost.