API Reference
Log In
API Reference

Get one page of a rule's roster

get
https://api.revenium.ai/profitstream/v2/api/ai/enforcement-rules//roster

The people, or the departments, one enforcement rule is measuring, with each one's spend, cap, band and last event. Filtered, sorted, banded and paged on the server, so a client never has to read the whole team's compiled payload to render one rule's roster. The three band counts describe the whole roster and ignore search, band, page and size, so pressing one band tile cannot zero the other two.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Revenium hashid of the team the rule belongs to.

Query Params
string
required

Revenium hashid of the rule whose roster to read.

int32
Defaults to 0

Zero based page index.

int32
Defaults to 25

Rows per page, 1 to 200.

Case insensitive substring over a row's key, label and email. Narrows the rows and the total together.

string

Narrow to one band: BLOCKED, WARNED, UNDER or ALL.

string

Sort field: PERCENT, SPEND, NAME or LAST_EVENT.

string

A guard, not a selector. SUBSCRIBER or ORG_UNIT. Sending one that does not match the rule's own grouping is refused, so a People tab cannot silently render department rows.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*

Updated 6 days ago

Did this page help you?