Skip to main content

refreshFilterVersion

Validates a recordings filter, migrates it to the target version, and returns it as a JSON-encoded string. With version 2 as the only version, this returns the validated filter re-encoded, so it can check a payload before saving it. Use recordingsCriteriaDefinition for the criteria catalog. Requires recordings view access.

refreshFilterVersion(
  version: Int
  filters: String!
): String

Arguments​

refreshFilterVersion.version ● Int scalar​

Filter version; 2 is the only supported version and is used when omitted, null, 0, or negative. Other values return an error.

refreshFilterVersion.filters ● String! non-null scalar​

JSON-encoded string. Envelope: {"version":2,"operator":"AND","conditions":[...]}, where operator is uppercase AND or OR and conditions is a non-empty list of nested groups or leaves. A leaf has criteria, comparison only when the criterion takes one, and value or values (plus multiple_values where required). Call recordingsCriteriaDefinition for the criteria catalog; the recordings-filter skill is the long-form reference. Example: {"version":2,"operator":"AND","conditions":[{"criteria":"date_range","value":{"special":"last 30 days"}}]}

Type​

String scalar​

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.