Get Criteria Metadata

This endpoint provides a list of criteria across all workspaces in an organization along with the organization level criteria.

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

Returns the catalog of scoring guidelines — called criteria in the API — configured for your organization. Use this to understand exactly which rules Vidmob is evaluating your creatives against, and how those rules are structured.

What a criterion contains

Each record in the response includes:

  • name — Human-readable guideline name (e.g. "Human Presence", "Brand Name or Logo Early")
  • rule — The specific rule being evaluated (e.g. "Brand name or logo shown in first 2 seconds")
  • channel — The platform this criterion applies to
  • weight — Numeric importance: higher weight means more impact on the rolled-up channel score
  • considerationMANDATORY or OPTIONAL (legacy field; use weight for new integrations)
  • criteriaGroups — Group memberships for this criterion (e.g. "Brand Standards", "Attention")
  • creativeTypes — Asset types this criterion applies to (e.g. VIDEO, IMAGE)

Filtering the catalog

The request body accepts several optional filters:

{
  "workspaces": [45914],
  "channels": ["META", "TIKTOK"],
  "globalOnly": false
}
FilterBehavior
workspacesReturns criteria for specific workspaces. Mutually exclusive with globalOnly.
channelsReturns only criteria for the specified channels.
criteriaGroupsReturns only criteria in the specified group UUIDs.
globalOnly: trueReturns only org-level criteria shared across all workspaces.

Criteria groups

Group membership is only returned by this endpoint — it is not included in the scores response. If your integration displays scores alongside group context (e.g. "Brand Standards: 3 of 5 passed"), fetch this catalog once at setup time and cache it as reference data.

Pagination

Use perPage (max 100) and offset query parameters to page through large catalogs. A typical org has dozens to hundreds of criteria across all channels.

Query Params
int32
Defaults to 10

Pagination parameter to set page size

int32
Defaults to 0

Pagination parameter to specify offset from zero.

Body Params
workspaces
array of int32s

Limit response to list of workspace IDs provided. Mutually exclusive with globalOnly parameter.

workspaces
channels
array of strings

Limit response to include criteria from list of channels provided.

channels
string
enum

Filter criteria by consideration. Accepted values are MANDATORY or OPTIONAL

Allowed:
criteriaGroups
array of strings

Filter criteria to those belonging to provided list of criteria group UUIDs.

criteriaGroups
boolean
Defaults to false

Limit response to include only organization level criteria. Mutually exclusive with workspaces parameter.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json