ALERTS_V1

List Rules

Changed on

Paginated list of alert/report rules.

get/api/v1/alerts/rules

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/api/v1/alerts/rules
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

rule_typestring nullable

'alert' or 'report'

platformstring nullable

'snowflake' or 'databricks'

statusstring nullable
categorystring nullable
sourcestring nullable

'metric' or 'playground_report'

searchstring nullable
pageinteger

Page number

sizeinteger

Page size

Response

Successful Response

totalinteger nullable required
pageinteger nullable required
sizeinteger nullable required
pagesinteger nullable

Changes

  • 70e0a3e5cb0dRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 6aa0788aa5dcRevision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

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

    • breaking

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

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added the new optional query request parameter source

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added the required property //// to the response with the status