Skip to main content
GET
Get metrics by origin

Authorizations

Authorization
string
header
required

API token in the sk_live_… format.

Query Parameters

page
integer
default:1

Page number, starting at 1. An invalid value is treated as 1.

Required range: x >= 1
perPage
integer
default:20

Number of items per page. The maximum depends on the environment (default 100).

Required range: 1 <= x <= 100
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[]
meta
object
Example: