Skip to main content
POST
Live 24h cap-effectiveness analytics

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
account
string

Space-separated account id(s) to scope to.

institution
string

Space-separated institution id(s) to scope to (takes precedence over account).

usersearch
string

Case-insensitive substring matched against member email / first / last name to narrow the membership tally.

accountType
string

Restrict the membership tally to members with this account type.

Response

Cap-effectiveness report.

success
boolean
data
object[]
totals
object
generatedAt
string<date-time>