Skip to main content
POST
Rank companies by intent score

Authorizations

X-Api-Key
string
header
required

Your organization's public API key.

Body

application/json

Filter + time window for the cool-score (time-windowed) ranking.

stageIds
integer<int64>[]

Funnel stage ids to include. Empty = all stages.

Funnel stage ids to include. Empty = all stages.

icpIds
integer<int64>[]

ICP ids to include. Empty = all ICPs.

ICP ids to include. Empty = all ICPs.

labelIds
integer<int64>[]

Label ids to include. Empty = all labels.

Label ids to include. Empty = all labels.

unLabeledOnly
boolean

Return only companies with no Label attached (entries with tag=false); Tags don't count. OR-combines with labelIds.

Example:

false

unTaggedOnly
boolean

Return only companies with no Tag attached (entries with tag=true); Labels don't count. OR-combines with labelIds.

Example:

false

employeePersonaIds
integer<int64>[]

Employee-persona ids to restrict to. Empty = no persona filter.

Employee-persona ids to restrict to. Empty = no persona filter.

startDate
integer<int64>

Window start, epoch millis. Omit both startDate and endDate to rank by stored all-time score.

Example:

1717200000000

endDate
integer<int64>

Window end, epoch millis.

Example:

1719792000000

listId
integer<int64>

Restrict to a single account-list id. Null = all lists.

page
integer<int32>
default:0

Zero-based page index.

Example:

0

size
integer<int32>
default:50

Page size (clamped to 100).

Example:

50

Response

OK

A page of results.

data
object[]

The items on this page.

page
integer<int32>

Zero-based page index.

Example:

0

size
integer<int32>

Requested page size.

Example:

20

totalElements
integer<int64>

Total number of matching items across all pages.

Example:

137

totalPages
integer<int32>

Total number of pages.

Example:

7