PreviewRule

curl --request POST \
  --url https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "matcher": {
    "attributes": {
      "facets": {
        "dataPlatformTypes": [],
        "entityTypes": [],
        "packages": [
          "<string>"
        ],
        "kinds": [
          "<string>"
        ]
      },
      "names": [
        "<string>"
      ],
      "annotationMatches": [
        {
          "equals": "<string>",
          "key": "<string>"
        }
      ]
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "category": "<string>",
  "priority": 0,
  "sampleSize": 500
}
'

import requests

url = "https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview"

payload = {
    "matcher": { "attributes": {
            "facets": {
                "dataPlatformTypes": [],
                "entityTypes": [],
                "packages": ["<string>"],
                "kinds": ["<string>"]
            },
            "names": ["<string>"],
            "annotationMatches": [
                {
                    "equals": "<string>",
                    "key": "<string>"
                }
            ]
        } },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "category": "<string>",
    "priority": 0,
    "sampleSize": 500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    matcher: {
      attributes: {
        facets: {
          dataPlatformTypes: [],
          entityTypes: [],
          packages: ['<string>'],
          kinds: ['<string>']
        },
        names: ['<string>'],
        annotationMatches: [{equals: '<string>', key: '<string>'}]
      }
    },
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    title: '<string>',
    category: '<string>',
    priority: 0,
    sampleSize: 500
  })
};

fetch('https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'matcher' => [
        'attributes' => [
                'facets' => [
                                'dataPlatformTypes' => [
                                                                
                                ],
                                'entityTypes' => [
                                                                
                                ],
                                'packages' => [
                                                                '<string>'
                                ],
                                'kinds' => [
                                                                '<string>'
                                ]
                ],
                'names' => [
                                '<string>'
                ],
                'annotationMatches' => [
                                [
                                                                'equals' => '<string>',
                                                                'key' => '<string>'
                                ]
                ]
        ]
    ],
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'title' => '<string>',
    'category' => '<string>',
    'priority' => 0,
    'sampleSize' => 500
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview"

	payload := strings.NewReader("{\n  \"matcher\": {\n    \"attributes\": {\n      \"facets\": {\n        \"dataPlatformTypes\": [],\n        \"entityTypes\": [],\n        \"packages\": [\n          \"<string>\"\n        ],\n        \"kinds\": [\n          \"<string>\"\n        ]\n      },\n      \"names\": [\n        \"<string>\"\n      ],\n      \"annotationMatches\": [\n        {\n          \"equals\": \"<string>\",\n          \"key\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"title\": \"<string>\",\n  \"category\": \"<string>\",\n  \"priority\": 0,\n  \"sampleSize\": 500\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"matcher\": {\n    \"attributes\": {\n      \"facets\": {\n        \"dataPlatformTypes\": [],\n        \"entityTypes\": [],\n        \"packages\": [\n          \"<string>\"\n        ],\n        \"kinds\": [\n          \"<string>\"\n        ]\n      },\n      \"names\": [\n        \"<string>\"\n      ],\n      \"annotationMatches\": [\n        {\n          \"equals\": \"<string>\",\n          \"key\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"title\": \"<string>\",\n  \"category\": \"<string>\",\n  \"priority\": 0,\n  \"sampleSize\": 500\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"matcher\": {\n    \"attributes\": {\n      \"facets\": {\n        \"dataPlatformTypes\": [],\n        \"entityTypes\": [],\n        \"packages\": [\n          \"<string>\"\n        ],\n        \"kinds\": [\n          \"<string>\"\n        ]\n      },\n      \"names\": [\n        \"<string>\"\n      ],\n      \"annotationMatches\": [\n        {\n          \"equals\": \"<string>\",\n          \"key\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"title\": \"<string>\",\n  \"category\": \"<string>\",\n  \"priority\": 0,\n  \"sampleSize\": 500\n}"

response = http.request(request)
puts response.read_body

{
  "matchedCount": 123,
  "affectedCount": 123,
  "newlyCategorisedCount": 123,
  "reassignedCount": 123,
  "unchangedCount": 123,
  "affectedEntityIds": [
    "<string>"
  ],
  "affectedEntityIdsTruncated": true,
  "higherPriorityRuleCount": 123,
  "explicitCategoryCount": 123,
  "sameCategoryCount": 123,
  "explicitCategoryEntityIds": [
    "<string>"
  ],
  "explicitCategoryEntityIdsTruncated": true
}

synq.entities.checks.v2.ChecksCategorisationRulesService

PreviewRule

Report what a candidate rule would change, without saving it.

The candidate is slotted into the workspace’s live rule set — replacing an existing rule when id names one — and the whole resolution is run over every check, so scope, priority, explicit categories and producer-declared categories are all honoured. The response separates the candidate’s raw reach from its real effect, which are rarely the same number.

Preview a rule before saving it: one that matches broadly can recategorise a large part of a workspace in a single sweep.

POST

api

entities

checks

categorisation-rules

preview

PreviewRule

curl --request POST \
  --url https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "matcher": {
    "attributes": {
      "facets": {
        "dataPlatformTypes": [],
        "entityTypes": [],
        "packages": [
          "<string>"
        ],
        "kinds": [
          "<string>"
        ]
      },
      "names": [
        "<string>"
      ],
      "annotationMatches": [
        {
          "equals": "<string>",
          "key": "<string>"
        }
      ]
    }
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "category": "<string>",
  "priority": 0,
  "sampleSize": 500
}
'

import requests

url = "https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview"

payload = {
    "matcher": { "attributes": {
            "facets": {
                "dataPlatformTypes": [],
                "entityTypes": [],
                "packages": ["<string>"],
                "kinds": ["<string>"]
            },
            "names": ["<string>"],
            "annotationMatches": [
                {
                    "equals": "<string>",
                    "key": "<string>"
                }
            ]
        } },
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "category": "<string>",
    "priority": 0,
    "sampleSize": 500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    matcher: {
      attributes: {
        facets: {
          dataPlatformTypes: [],
          entityTypes: [],
          packages: ['<string>'],
          kinds: ['<string>']
        },
        names: ['<string>'],
        annotationMatches: [{equals: '<string>', key: '<string>'}]
      }
    },
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    title: '<string>',
    category: '<string>',
    priority: 0,
    sampleSize: 500
  })
};

fetch('https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'matcher' => [
        'attributes' => [
                'facets' => [
                                'dataPlatformTypes' => [
                                                                
                                ],
                                'entityTypes' => [
                                                                
                                ],
                                'packages' => [
                                                                '<string>'
                                ],
                                'kinds' => [
                                                                '<string>'
                                ]
                ],
                'names' => [
                                '<string>'
                ],
                'annotationMatches' => [
                                [
                                                                'equals' => '<string>',
                                                                'key' => '<string>'
                                ]
                ]
        ]
    ],
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'title' => '<string>',
    'category' => '<string>',
    'priority' => 0,
    'sampleSize' => 500
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview"

	payload := strings.NewReader("{\n  \"matcher\": {\n    \"attributes\": {\n      \"facets\": {\n        \"dataPlatformTypes\": [],\n        \"entityTypes\": [],\n        \"packages\": [\n          \"<string>\"\n        ],\n        \"kinds\": [\n          \"<string>\"\n        ]\n      },\n      \"names\": [\n        \"<string>\"\n      ],\n      \"annotationMatches\": [\n        {\n          \"equals\": \"<string>\",\n          \"key\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"title\": \"<string>\",\n  \"category\": \"<string>\",\n  \"priority\": 0,\n  \"sampleSize\": 500\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"matcher\": {\n    \"attributes\": {\n      \"facets\": {\n        \"dataPlatformTypes\": [],\n        \"entityTypes\": [],\n        \"packages\": [\n          \"<string>\"\n        ],\n        \"kinds\": [\n          \"<string>\"\n        ]\n      },\n      \"names\": [\n        \"<string>\"\n      ],\n      \"annotationMatches\": [\n        {\n          \"equals\": \"<string>\",\n          \"key\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"title\": \"<string>\",\n  \"category\": \"<string>\",\n  \"priority\": 0,\n  \"sampleSize\": 500\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/v2/checks/categorisation-rules/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"matcher\": {\n    \"attributes\": {\n      \"facets\": {\n        \"dataPlatformTypes\": [],\n        \"entityTypes\": [],\n        \"packages\": [\n          \"<string>\"\n        ],\n        \"kinds\": [\n          \"<string>\"\n        ]\n      },\n      \"names\": [\n        \"<string>\"\n      ],\n      \"annotationMatches\": [\n        {\n          \"equals\": \"<string>\",\n          \"key\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"title\": \"<string>\",\n  \"category\": \"<string>\",\n  \"priority\": 0,\n  \"sampleSize\": 500\n}"

response = http.request(request)
puts response.read_body

{
  "matchedCount": 123,
  "affectedCount": 123,
  "newlyCategorisedCount": 123,
  "reassignedCount": 123,
  "unchangedCount": 123,
  "affectedEntityIds": [
    "<string>"
  ],
  "affectedEntityIdsTruncated": true,
  "higherPriorityRuleCount": 123,
  "explicitCategoryCount": 123,
  "sameCategoryCount": 123,
  "explicitCategoryEntityIds": [
    "<string>"
  ],
  "explicitCategoryEntityIdsTruncated": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

matcher

attributes · object

required

Which checks the candidate would apply to.

attributes
expression

Show child attributes

string<uuid> | null

Set to an existing rule's id to preview an edit to it — the candidate replaces that rule during resolution, so the result reflects the change rather than the addition of a second rule. Omit to preview a new rule.

dimension

enum<string>

The dimension the candidate would categorise along.

Available options:

CATEGORY_DIMENSION_UNSPECIFIED,

CATEGORY_DIMENSION_TECHNICAL,

CATEGORY_DIMENSION_GOVERNANCE

scope

enum<string>

Scope the candidate would be saved with. Defaults to RULE_SCOPE_WORKSPACE.

Available options:

RULE_SCOPE_UNSPECIFIED,

RULE_SCOPE_GLOBAL,

RULE_SCOPE_WORKSPACE

title

string

Title the candidate would be saved with. Does not affect the outcome.

Maximum string length: 200

Response

200 - application/json

Success

matchedCount

Checks whose predicate the candidate matches at all — its raw reach, whether or not it ends up winning them.

affectedCount

Checks whose effective category on the candidate's dimension would actually change. This is the rule's real impact. It equals newly_categorised_count + reassigned_count, and matched_count equals this plus unchanged_count.

newlyCategorisedCount

Of the affected checks, how many have no category on this dimension today.

reassignedCount

Of the affected checks, how many already have a different category that the candidate would take over. Worth a second look before saving.

unchangedCount

Checks the candidate matches whose effective category would not change. The three fields below say why, and add up to this one.

affectedEntityIds

string[]

A sample of the affected checks, ordered by entity id.

affectedEntityIdsTruncated

boolean

True when the sample was cut short by sample_size.

higherPriorityRuleCount

Of the unchanged checks, how many a rule of higher priority already wins, so the candidate never gets to assign anything. Raise the candidate's priority to take these over.

explicitCategoryCount

Of the unchanged checks, how many carry a category set explicitly on the check, or declared by the tool that produced it. Either outranks every rule, so these are the checks the candidate looks like it covers and does not — no priority will win them. Clear the explicit category to hand a check back to the rules.

sameCategoryCount

Of the unchanged checks, how many the candidate does win, assigning the category the check already has. Nothing to do about these; the rule is simply agreeing with what is there.

explicitCategoryEntityIds

string[]

A sample of the checks counted in explicit_category_count, ordered by entity id — the ones worth showing a customer, because a rule that reads as covering them does not.

explicitCategoryEntityIdsTruncated

boolean

True when that sample was cut short by sample_size.

Get Started

Alerts

Monitors

Monitors Types

Reconciliations

Data Products

Scout AI

Ownership

Incidents

Analytics

Query activity

Lineage

BI Integrations

Data Warehouse Integrations

Transactional databases

Code Integrations

dbt Integrations

SQLMesh Integrations

Coalesce Integrations

Orchestration Tool Integrations

Alerting Integrations

Catalogs

Google Cloud Integrations

Admin

Security

Support

Developer API

PreviewRule

Authorizations

Body

Response