Skip to main content
POST
/
api
/
monitors
/
custom-monitors
/
v1
/
config-changes
ConfigChangesOverview
curl --request POST \
  --url https://developer.synq.io/api/monitors/custom-monitors/v1/config-changes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configIds": [
    "<string>"
  ],
  "monitors": [
    {
      "anomalyEngine": {
        "sensitivity": "SENSITIVITY_UNSPECIFIED"
      },
      "customNumeric": {
        "metricAggregation": "<string>"
      },
      "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>",
      "severity": "SEVERITY_UNSPECIFIED",
      "description": "<string>",
      "configId": "<string>",
      "source": "SOURCE_APP",
      "timezone": "<string>"
    }
  ]
}
'
{
  "monitorsManagedByApp": [
    {
      "anomalyEngine": {
        "sensitivity": "SENSITIVITY_UNSPECIFIED"
      },
      "customNumeric": {
        "metricAggregation": "<string>"
      },
      "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>",
      "severity": "SEVERITY_UNSPECIFIED",
      "description": "<string>",
      "configId": "<string>",
      "source": "SOURCE_APP",
      "timezone": "<string>"
    }
  ],
  "monitorsManagedByOtherConfigs": [
    {
      "anomalyEngine": {
        "sensitivity": "SENSITIVITY_UNSPECIFIED"
      },
      "customNumeric": {
        "metricAggregation": "<string>"
      },
      "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>",
      "severity": "SEVERITY_UNSPECIFIED",
      "description": "<string>",
      "configId": "<string>",
      "source": "SOURCE_APP",
      "timezone": "<string>"
    }
  ],
  "monitorsToCreate": [
    {
      "anomalyEngine": {
        "sensitivity": "SENSITIVITY_UNSPECIFIED"
      },
      "customNumeric": {
        "metricAggregation": "<string>"
      },
      "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>",
      "severity": "SEVERITY_UNSPECIFIED",
      "description": "<string>",
      "configId": "<string>",
      "source": "SOURCE_APP",
      "timezone": "<string>"
    }
  ],
  "monitorsToDelete": [
    {
      "anomalyEngine": {
        "sensitivity": "SENSITIVITY_UNSPECIFIED"
      },
      "customNumeric": {
        "metricAggregation": "<string>"
      },
      "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>",
      "severity": "SEVERITY_UNSPECIFIED",
      "description": "<string>",
      "configId": "<string>",
      "source": "SOURCE_APP",
      "timezone": "<string>"
    }
  ],
  "monitorsUnchanged": [
    {
      "anomalyEngine": {
        "sensitivity": "SENSITIVITY_UNSPECIFIED"
      },
      "customNumeric": {
        "metricAggregation": "<string>"
      },
      "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>",
      "severity": "SEVERITY_UNSPECIFIED",
      "description": "<string>",
      "configId": "<string>",
      "source": "SOURCE_APP",
      "timezone": "<string>"
    }
  ],
  "monitorsChangesOverview": [
    {
      "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "originDefinition": {
        "anomalyEngine": {
          "sensitivity": "SENSITIVITY_UNSPECIFIED"
        },
        "customNumeric": {
          "metricAggregation": "<string>"
        },
        "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>",
        "severity": "SEVERITY_UNSPECIFIED",
        "description": "<string>",
        "configId": "<string>",
        "source": "SOURCE_APP",
        "timezone": "<string>"
      },
      "newDefinition": {
        "anomalyEngine": {
          "sensitivity": "SENSITIVITY_UNSPECIFIED"
        },
        "customNumeric": {
          "metricAggregation": "<string>"
        },
        "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>",
        "severity": "SEVERITY_UNSPECIFIED",
        "description": "<string>",
        "configId": "<string>",
        "source": "SOURCE_APP",
        "timezone": "<string>"
      },
      "changes": "<string>",
      "changesDeltaJson": "<string>",
      "shouldReset": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
configIds
string[]
​
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 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

Response

200 - application/json

Success

​
monitorsManagedByApp
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 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

​
monitorsManagedByOtherConfigs
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 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

​
monitorsToCreate
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 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

​
monitorsToDelete
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 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

​
monitorsUnchanged
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 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

​
monitorsChangesOverview
ChangeOverview · object[]