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. Filtering, sorting, banding and paging all happen in Revenium. The three band counts describe the whole roster and ignore search, band, page and size, so filtering to one band does not change the counts for the other two.

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

ID of the team that owns this data.

Query Params
string
required

Revenium identifier 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, the warning or limit level shown for each person or department: BLOCKED, WARNED, UNDER or ALL.

string

Sort field: PERCENT, SPEND, NAME or LAST_EVENT.

string

A check, not a selector. SUBSCRIBER or DEPARTMENT. It must match the rule's own grouping, otherwise the call returns 422.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 2 months 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 about 2 months ago

Did this page help you?