Preview matching users and learning paths

POST

/assignment-rules/preview

AssignmentRules

Runs the rule's user and target JSON Logic against the workspace and returns aggregate counts plus a small sample of matched IDs. Uses the same evaluation engine as the actual rule processor, so the preview number cannot drift from the count produced at assignment time.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Preview result

Bodyapplication/json

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/assignment-rules/preview' \
--header 'Content-Type: application/json' \
--data '{
    "targetType": "survey",
    "usersMatchCondition": {
        "==": [
            1,
            1
        ]
    },
    "targetsPool": [
        "string"
    ],
    "targetsMatchCondition": {
        "==": [
            1,
            1
        ]
    }
}'

Response Example

{
    "totalMatchedUsers": 0,
    "sampleMatchedUserIds": [
        "string"
    ],
    "totalMatchedTargets": 0,
    "sampleMatchedTargetIds": [
        "string"
    ],
    "estimatedAssignments": 0,
    "truncated": true
}

Modified at 2026-09-10 08:52:11

List latest assignmentRule history across the workspace

Archive assignment rule