ListMonitors

GET /api/monitors/custom-monitors/v1

ListMonitors

cURL

curl --request GET \
  --url https://developer.synq.io/api/monitors/custom-monitors/v1 \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://developer.synq.io/api/monitors/custom-monitors/v1"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://developer.synq.io/api/monitors/custom-monitors/v1', 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/monitors/custom-monitors/v1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://developer.synq.io/api/monitors/custom-monitors/v1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/monitors/custom-monitors/v1")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/monitors/custom-monitors/v1")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "pageInfo": {
    "totalCount": 123,
    "count": 123,
    "lastId": "<string>"
  },
  "monitors": [
    {
      "anomalyEngine": {},
      "categoryDistribution": {
        "field": "<string>",
        "topKLimit": 1
      },
      "daily": {
        "minutesSinceMidnight": 719,
        "delayNumDays": 1,
        "onlyScheduleDelay": true
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "monitoredId": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "name": "<string>",
      "timePartitioning": {
        "expression": "<string>",
        "interval": "<string>"
      },
      "segmentation": {
        "expression": "<string>",
        "includeValues": {
          "values": [
            "<string>"
          ]
        },
        "excludeValues": {
          "values": [
            "<string>"
          ]
        }
      },
      "filter": "<string>",
      "description": "<string>",
      "configId": "<string>",
      "timezone": "<string>",
      "sqlSource": {
        "sql": "<string>"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Query Parameters

integrationIds · string[]

monitoredAssetPaths · string[]

monitorIds · string[]

source · string[] · deprecated

configIds · string[] · deprecated

configsFilter.ids · string[]

sources · enum<string>[]

Available options: SOURCE_APP, SOURCE_API

pagination.cursor · string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize · integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

pageInfo · PageInfo · object · required

Paging information.

Show child attributes

monitors · MonitorDefinition · object[]

filter_not_supported_for_table_stats // filter is not supported for table stats monitors segmentation_not_supported_for_field_stats_and_table_stats // Segmentation is not supported for field stats and table stats monitors sql_source_not_supported_for_table_stats // sql_source is not supported for table stats monitors time_partitioning_required_for_non_table_stats // time_partitioning is required when table_stats is not set, and must not be set when table_stats is set

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

MonitorDefinition

Show child attributes