Skip to main content
POST
/
public
/
v1
/
funnel
/
velocity
Funnel velocity
curl --request POST \
  --url http://app.stairoids.com/api/public/v1/funnel/velocity \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "startDate": 1717200000000,
  "endDate": 1719792000000,
  "icpIds": [
    123
  ],
  "accountListIds": [
    123
  ]
}
'
{
  "currentPeriodCount": 128,
  "previousPeriodCount": 97,
  "percentageChange": 31.9
}

Authorizations

​
X-Api-Key
string
header
required

Your organization's public API key. Manage it at GET /api/user/public-api-key.

Body

application/json

Time-window and segment filter for analytics endpoints.

​
startDate
integer<int64>

Window start, epoch millis. Omit both startDate and endDate for the default recent window.

Example:

1717200000000

​
endDate
integer<int64>

Window end, epoch millis.

Example:

1719792000000

​
icpIds
integer<int64>[]

Restrict to these ICP ids. Null or empty = all ICPs.

Restrict to these ICP ids. Null or empty = all ICPs.

​
accountListIds
integer<int64>[]

Restrict to these account-list ids. Null or empty = all lists.

Restrict to these account-list ids. Null or empty = all lists.

Response

OK

A current-vs-previous-period trend metric.

​
currentPeriodCount
integer<int32>

Count in the current period.

Example:

128

​
previousPeriodCount
integer<int32>

Count in the previous period of equal length.

Example:

97

​
percentageChange
number<double>

Percentage change vs the previous period.

Example:

31.9