コンテンツにスキップ
Authrim

Preview a support operation cohort

POST
/api/admin/support-ops/cohorts/preview
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/support-ops/cohorts/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "resource": "User", "selector": { "field": "status", "op": "eq", "value": "active" }, "intent": { "action": "suspend", "support_case_id": "CASE-123" } }'

Preview matched, actionable, and blocked counts for a support operation selector without saving a cohort.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Describe a privacy-preserving support operation cohort selector and intended action.

Media type application/json
object
resource
required
string
selector
required
object
key
additional properties
intent
object
action
string
support_case_id
string
Example 
{
  "resource": "User",
  "selector": {
    "field": "status",
    "op": "eq",
    "value": "active"
  },
  "intent": {
    "action": "suspend",
    "support_case_id": "CASE-123"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Support operation cohort or preview.

Media type application/json
object
cohort_id
string
resource
string
intended_action
Any of:
string
matched_count
Any of:
integer format: int64
actionable_count
Any of:
integer format: int64
blocked_count
Any of:
integer format: int64
blocked_reasons
Array<string>
blocked_reasons_suppressed
boolean
privacy
object
min_count
integer format: int64
low_count_suppressed
boolean
count_precision
integer format: int64
count_exact
boolean
complementary_suppression
boolean
snapshot_status
string
snapshot_job_id
Any of:
string
snapshot_error
Any of:
string
expires_at
integer format: int64
selector_hash
string
risk
object
key
additional properties
support_case_id
Any of:
string
created_at
integer format: int64
Example 
{
  "cohort_id": "cohort_123",
  "resource": "User",
  "intended_action": "suspend",
  "matched_count": 120,
  "actionable_count": 118,
  "blocked_count": 2,
  "blocked_reasons": [
    "not_active"
  ],
  "blocked_reasons_suppressed": false,
  "privacy": {
    "min_count": 10,
    "low_count_suppressed": false
  },
  "snapshot_status": "completed",
  "snapshot_job_id": null,
  "expires_at": 1770086400000,
  "selector_hash": "sha256:abc123",
  "risk": {
    "min_count": 10,
    "matched_count": 120,
    "low_count_suppressed": false,
    "uses_sensitive_field": false,
    "risk_level": "medium",
    "approval_required": true
  }
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}