ListCheckCategories

ListCheckCategories

curl --request POST \
  --url https://developer.synq.io/api/entities/v2/checks/categories/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ruleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "technicalCategories": [
    "<string>"
  ],
  "governanceCategories": [
    "<string>"
  ],
  "attributes": {
    "dataPlatformTypes": [],
    "entityTypes": [],
    "packages": [
      "<string>"
    ],
    "kinds": [
      "<string>"
    ]
  },
  "entityIds": [
    "<string>"
  ],
  "pagination": {
    "cursor": "<string>",
    "pageSize": 1
  }
}
'

import requests

url = "https://developer.synq.io/api/entities/v2/checks/categories/list"

payload = {
    "ruleIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "technicalCategories": ["<string>"],
    "governanceCategories": ["<string>"],
    "attributes": {
        "dataPlatformTypes": [],
        "entityTypes": [],
        "packages": ["<string>"],
        "kinds": ["<string>"]
    },
    "entityIds": ["<string>"],
    "pagination": {
        "cursor": "<string>",
        "pageSize": 1
    }
}
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({
    ruleIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    technicalCategories: ['<string>'],
    governanceCategories: ['<string>'],
    attributes: {
      dataPlatformTypes: [],
      entityTypes: [],
      packages: ['<string>'],
      kinds: ['<string>']
    },
    entityIds: ['<string>'],
    pagination: {cursor: '<string>', pageSize: 1}
  })
};

fetch('https://developer.synq.io/api/entities/v2/checks/categories/list', 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/categories/list",
  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([
    'ruleIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'technicalCategories' => [
        '<string>'
    ],
    'governanceCategories' => [
        '<string>'
    ],
    'attributes' => [
        'dataPlatformTypes' => [
                
        ],
        'entityTypes' => [
                
        ],
        'packages' => [
                '<string>'
        ],
        'kinds' => [
                '<string>'
        ]
    ],
    'entityIds' => [
        '<string>'
    ],
    'pagination' => [
        'cursor' => '<string>',
        'pageSize' => 1
    ]
  ]),
  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/categories/list"

	payload := strings.NewReader("{\n  \"ruleIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"technicalCategories\": [\n    \"<string>\"\n  ],\n  \"governanceCategories\": [\n    \"<string>\"\n  ],\n  \"attributes\": {\n    \"dataPlatformTypes\": [],\n    \"entityTypes\": [],\n    \"packages\": [\n      \"<string>\"\n    ],\n    \"kinds\": [\n      \"<string>\"\n    ]\n  },\n  \"entityIds\": [\n    \"<string>\"\n  ],\n  \"pagination\": {\n    \"cursor\": \"<string>\",\n    \"pageSize\": 1\n  }\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/categories/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ruleIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"technicalCategories\": [\n    \"<string>\"\n  ],\n  \"governanceCategories\": [\n    \"<string>\"\n  ],\n  \"attributes\": {\n    \"dataPlatformTypes\": [],\n    \"entityTypes\": [],\n    \"packages\": [\n      \"<string>\"\n    ],\n    \"kinds\": [\n      \"<string>\"\n    ]\n  },\n  \"entityIds\": [\n    \"<string>\"\n  ],\n  \"pagination\": {\n    \"cursor\": \"<string>\",\n    \"pageSize\": 1\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/v2/checks/categories/list")

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  \"ruleIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"technicalCategories\": [\n    \"<string>\"\n  ],\n  \"governanceCategories\": [\n    \"<string>\"\n  ],\n  \"attributes\": {\n    \"dataPlatformTypes\": [],\n    \"entityTypes\": [],\n    \"packages\": [\n      \"<string>\"\n    ],\n    \"kinds\": [\n      \"<string>\"\n    ]\n  },\n  \"entityIds\": [\n    \"<string>\"\n  ],\n  \"pagination\": {\n    \"cursor\": \"<string>\",\n    \"pageSize\": 1\n  }\n}"

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

{
  "categories": [
    {
      "entityId": "<string>",
      "technical": {
        "category": "<string>",
        "override": "<string>",
        "ruleId": "<string>",
        "ruleTitle": "<string>",
        "computed": {
          "category": "<string>",
          "ruleId": "<string>",
          "ruleTitle": "<string>"
        }
      },
      "governance": {
        "category": "<string>",
        "override": "<string>",
        "ruleId": "<string>",
        "ruleTitle": "<string>",
        "computed": {
          "category": "<string>",
          "ruleId": "<string>",
          "ruleTitle": "<string>"
        }
      },
      "check": {
        "name": "<string>",
        "fullName": [
          "<string>"
        ],
        "package": "<string>",
        "kind": "<string>",
        "isPlatformNative": true,
        "description": "<string>",
        "checkedEntityIds": [
          "<string>"
        ],
        "annotations": {}
      },
      "etag": "<string>",
      "updatedBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

POST

api

entities

checks

categories

list

ListCheckCategories

curl --request POST \
  --url https://developer.synq.io/api/entities/v2/checks/categories/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ruleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "technicalCategories": [
    "<string>"
  ],
  "governanceCategories": [
    "<string>"
  ],
  "attributes": {
    "dataPlatformTypes": [],
    "entityTypes": [],
    "packages": [
      "<string>"
    ],
    "kinds": [
      "<string>"
    ]
  },
  "entityIds": [
    "<string>"
  ],
  "pagination": {
    "cursor": "<string>",
    "pageSize": 1
  }
}
'

import requests

url = "https://developer.synq.io/api/entities/v2/checks/categories/list"

payload = {
    "ruleIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "technicalCategories": ["<string>"],
    "governanceCategories": ["<string>"],
    "attributes": {
        "dataPlatformTypes": [],
        "entityTypes": [],
        "packages": ["<string>"],
        "kinds": ["<string>"]
    },
    "entityIds": ["<string>"],
    "pagination": {
        "cursor": "<string>",
        "pageSize": 1
    }
}
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({
    ruleIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    technicalCategories: ['<string>'],
    governanceCategories: ['<string>'],
    attributes: {
      dataPlatformTypes: [],
      entityTypes: [],
      packages: ['<string>'],
      kinds: ['<string>']
    },
    entityIds: ['<string>'],
    pagination: {cursor: '<string>', pageSize: 1}
  })
};

fetch('https://developer.synq.io/api/entities/v2/checks/categories/list', 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/categories/list",
  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([
    'ruleIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'technicalCategories' => [
        '<string>'
    ],
    'governanceCategories' => [
        '<string>'
    ],
    'attributes' => [
        'dataPlatformTypes' => [
                
        ],
        'entityTypes' => [
                
        ],
        'packages' => [
                '<string>'
        ],
        'kinds' => [
                '<string>'
        ]
    ],
    'entityIds' => [
        '<string>'
    ],
    'pagination' => [
        'cursor' => '<string>',
        'pageSize' => 1
    ]
  ]),
  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/categories/list"

	payload := strings.NewReader("{\n  \"ruleIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"technicalCategories\": [\n    \"<string>\"\n  ],\n  \"governanceCategories\": [\n    \"<string>\"\n  ],\n  \"attributes\": {\n    \"dataPlatformTypes\": [],\n    \"entityTypes\": [],\n    \"packages\": [\n      \"<string>\"\n    ],\n    \"kinds\": [\n      \"<string>\"\n    ]\n  },\n  \"entityIds\": [\n    \"<string>\"\n  ],\n  \"pagination\": {\n    \"cursor\": \"<string>\",\n    \"pageSize\": 1\n  }\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/categories/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ruleIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"technicalCategories\": [\n    \"<string>\"\n  ],\n  \"governanceCategories\": [\n    \"<string>\"\n  ],\n  \"attributes\": {\n    \"dataPlatformTypes\": [],\n    \"entityTypes\": [],\n    \"packages\": [\n      \"<string>\"\n    ],\n    \"kinds\": [\n      \"<string>\"\n    ]\n  },\n  \"entityIds\": [\n    \"<string>\"\n  ],\n  \"pagination\": {\n    \"cursor\": \"<string>\",\n    \"pageSize\": 1\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/entities/v2/checks/categories/list")

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  \"ruleIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"technicalCategories\": [\n    \"<string>\"\n  ],\n  \"governanceCategories\": [\n    \"<string>\"\n  ],\n  \"attributes\": {\n    \"dataPlatformTypes\": [],\n    \"entityTypes\": [],\n    \"packages\": [\n      \"<string>\"\n    ],\n    \"kinds\": [\n      \"<string>\"\n    ]\n  },\n  \"entityIds\": [\n    \"<string>\"\n  ],\n  \"pagination\": {\n    \"cursor\": \"<string>\",\n    \"pageSize\": 1\n  }\n}"

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

{
  "categories": [
    {
      "entityId": "<string>",
      "technical": {
        "category": "<string>",
        "override": "<string>",
        "ruleId": "<string>",
        "ruleTitle": "<string>",
        "computed": {
          "category": "<string>",
          "ruleId": "<string>",
          "ruleTitle": "<string>"
        }
      },
      "governance": {
        "category": "<string>",
        "override": "<string>",
        "ruleId": "<string>",
        "ruleTitle": "<string>",
        "computed": {
          "category": "<string>",
          "ruleId": "<string>",
          "ruleTitle": "<string>"
        }
      },
      "check": {
        "name": "<string>",
        "fullName": [
          "<string>"
        ],
        "package": "<string>",
        "kind": "<string>",
        "isPlatformNative": true,
        "description": "<string>",
        "checkedEntityIds": [
          "<string>"
        ],
        "annotations": {}
      },
      "etag": "<string>",
      "updatedBy": {
        "name": "<string>",
        "email": {
          "userEmail": "jsmith@example.com"
        }
      },
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

technicalFilter

enum<string>

Keep only checks that are, or are not, categorised on the technical dimension.

Available options:

CATEGORISATION_FILTER_UNSPECIFIED,

CATEGORISATION_FILTER_CATEGORISED,

CATEGORISATION_FILTER_UNCATEGORISED

governanceFilter

enum<string>

Keep only checks that are, or are not, categorised on the governance dimension.

Available options:

CATEGORISATION_FILTER_UNSPECIFIED,

CATEGORISATION_FILTER_CATEGORISED,

CATEGORISATION_FILTER_UNCATEGORISED

technicalOverrideFilter

enum<string>

Keep only checks whose technical category was, or was not, set explicitly.

Available options:

OVERRIDE_FILTER_UNSPECIFIED,

OVERRIDE_FILTER_OVERRIDDEN,

OVERRIDE_FILTER_NOT_OVERRIDDEN

governanceOverrideFilter

enum<string>

Keep only checks whose governance category was, or was not, set explicitly.

Available options:

OVERRIDE_FILTER_UNSPECIFIED,

OVERRIDE_FILTER_OVERRIDDEN,

OVERRIDE_FILTER_NOT_OVERRIDDEN

ruleIds

string<uuid>[]

Keep only checks currently categorised by one of these rules, on either dimension. This is the paginated companion to ChecksCategorisationRulesService.ListRuleMatches, which reports exact counts and a sample per rule.

Maximum array length: 100

technicalCategories

string[]

Keep only checks whose effective technical category is one of these.

Maximum array length: 200

Maximum string length: 200

governanceCategories

string[]

Keep only checks whose effective governance category is one of these.

Maximum array length: 200

Maximum string length: 200

attributes

CategorisationFacets · object

Keep only checks with these attributes — the same platform / entity type / package / kind selection a categorisation rule matches on, so a listing can be narrowed to exactly the checks a candidate rule would consider.

Show child attributes

entityIds

string[]

Keep only these checks. Combines with the other filters, so it answers "which of these checks are uncategorised" in a single call.

Maximum array length: 500

Required string length: 1 - 2000

pagination

Pagination · object

Pagination. Defaults to 200 checks per page.

Show child attributes

Response

200 - application/json

Success

Get Started

Alerts

Monitors

Monitors Types

Reconciliations

Data Products

Scout AI

Ownership

Incidents

Analytics

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

Authorizations

Body

Response