Aggregate support operation candidates

POST

/api/admin/support-ops/aggregate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/support-ops/aggregate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "resource": "User", "group_by": [ "status" ], "selector": { "field": "status", "op": "eq", "value": "active" } }'

Return privacy-preserving grouped counts for a support operation selector.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Aggregate support operation candidates without exposing individual records.

Media type application/json

object

resource

required

string

selector

object

key

additional properties

group_by

required

Array<string>

Example

{
  "resource": "User",
  "group_by": [
    "status"
  ],
  "selector": {
    "field": "status",
    "op": "eq",
    "value": "active"
  }
}

Responses

200

Privacy-preserving aggregate result.

Media type application/json

object

resource

required

string

groups

required

Array<object>

object

key

object

key

additional properties

count

integer format: int64

suppressed_groups

required

integer format: int64

privacy

required

object

min_count

integer format: int64

low_count_suppressed

boolean

count_precision

integer format: int64

count_exact

boolean

complementary_suppression

boolean

Example

{
  "resource": "User",
  "groups": [
    {
      "key": {
        "status": "active"
      },
      "count": 120
    }
  ],
  "suppressed_groups": 0,
  "privacy": {
    "min_count": 10,
    "count_precision": 10,
    "count_exact": false,
    "low_count_suppressed": false,
    "complementary_suppression": false
  }
}

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"
}