Browse Scoring Guidelines

Use this when you want to inspect or pre-cache the catalog of guidelines (criteria) that apply to your organization — for example, to render a guideline reference UI, or to look up the rule definitions that your integration's scores are evaluated against.

POST /v1/scoring/criteria/metadata
Content-Type: application/json
Authorization: Bearer <api-key>

{
  "workspaces": [45914],
  "globalOnly": false
}

Request body:

Field	Type	Notes
`workspaces`	number[]	Filter to specific workspace IDs.
`channels`	string[]	Filter by channel identifier.
`criteriaGroups`	string[]	Filter by criterion-group UUIDs.
`consideration`	string	`MANDATORY` or `OPTIONAL`.
`globalOnly`	boolean	If `true`, only return organization-level (global) criteria.

Pagination is supplied via the offset and perPage query parameters. Default perPage = 10, max perPage = 100.

Pagination metadata in the response:

{
  "pagination": {
    "offset": 0,
    "perPage": 50,
    "nextOffset": 50,
    "totalSize": 254
  }
}

Full criterion object:

{
  "id": 94673,
  "name": "Human Presence",
  "rule": "Human(s) featured anytime",
  "channel": "META",
  "consideration": "MANDATORY",
  "bestPractice": false,
  "criteriaGroups": [
    { "id": "8dad24fd-95a7-41fb-a202-bd9a493c9ffa", "name": "Brand Standards" }
  ],
  "creativeTypes": ["IMAGE", "VIDEO", "ANIMATED_IMAGE"],
  "weight": 1,
  "dateCreated": "2024-07-19T17:14:21.000Z",
  "organizationCriteria": false,
  "usesProminence": false,
  "person": { "email": "[email protected]", "firstName": "Jane", "lastName": "Doe" },
  "workspace": { "id": 45914, "name": "Acme Inc." }
}