Sign in
ALERTS_V1

List Rules

Paginated list of alert/report rules.

get/api/v1/alerts/rules

Query parameters

rule_typestring nullable

'alert' or 'report'

'alert' or 'report'

platformstring nullable

'snowflake' or 'databricks'

'snowflake' or 'databricks'

statusstring nullable
categorystring nullable
sourcestring nullable

'metric' or 'playground_report'

'metric' or 'playground_report'

searchstring nullable
pageinteger

Page number

Page number

sizeinteger

Page size

Page size

Response

Successful Response

totalinteger nullable required
pageinteger nullable required
sizeinteger nullable required
pagesinteger nullable

Changes

Changed in 2 of the 28 revisions of this API.747

  • 6aa0788aa5dc746See the full diff
    • ▲

      the response property items/items/entity_type became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/items/metric_config became optional for the status 200

      response-property-became-optional

    • ▲

      the response property items/items/platform became optional for the status 200

      response-property-became-optional

    • ▲

      response property items/items/entity_type list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property items/items/platform list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      the items/items/metric_config response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property items/items/metric_config/metric_name from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property items/items/metric_config/category from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/items/metric_config/filters from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/items/metric_config/params from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/items/metric_config/team_id from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter source

      new-optional-request-parameter

    • ○

      added the optional property items/items/content_scope to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/session_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/source to the response with the 200 status

      response-optional-property-added

    • ○

      added MetricConfig subschema #2 to the items/items/metric_config response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added the required property items/items/last_run/anyOf[subschema #1: RunResponse]/destinations to the response with the 200 status

      response-required-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a71fce1f5c261See the full diff
    • ○

      added the optional property items/items/metric_config/team_id to the response with the 200 status

      response-optional-property-added