> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corbado.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List alert rule types

> Lists the alert rule types that can be created, described for the authenticated project. The rule builder renders itself from this: `available` says whether the project has the data the type reads, and `dimensions` are the keys a rule of that type can be grouped by here, including the project's own time-series tags. A type with `available` false, or a `groupBy` key not listed here, is rejected when the rule is saved.

Required API key permission: `observe:alerts:read`.



## OpenAPI

````yaml /api-reference/openapi/observe.yaml get /observe/alertRuleTypes
openapi: 3.1.1
info:
  version: 1.0.0
  title: Corbado API
  description: >
    # Introduction

    This documentation gives an overview of all Corbado API calls to implement
    authentication observe.
  contact:
    name: Corbado team
    email: support@corbado.com
    url: https://www.corbado.com
servers:
  - url: https://api.cloud.corbado.io/v1
security:
  - bearerAuth: []
tags:
  - name: ObserveFlow
    description: Flow search and related APIs
    x-group: Journeys and users
  - name: ObserveSubFlow
    description: Subflow search and related APIs
    x-group: Journeys and users
  - name: ObserveUser
    description: User search and related APIs
    x-group: Journeys and users
  - name: ObserveClientEnv
    description: Client environment search APIs
    x-group: Journeys and users
  - name: ObserveTimeSeries
    description: Time series query APIs
    x-group: Metrics and funnels
  - name: ObserveFunnel
    description: Historical funnel metrics, dictionaries and coverage.
    x-group: Metrics and funnels
  - name: ObserveEvent
    description: Event ingestion and event feed APIs
    x-group: Events
  - name: ObserveError
    description: Named authentication errors and recommendations.
    x-group: Error management
  - name: ObserveErrorFlavour
    description: Error variants and their impact on authentication outcomes.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: Annotation APIs (dated notes for analytics context)
    x-group: Annotations
  - name: ObserveTableExport
    description: Table export file listing and download APIs
    x-group: Data exports
  - name: ObserveTimeSeriesExport
    description: Time-series export generation and downloads.
    x-group: Data exports
  - name: ObserveDataExport
    description: Data export APIs
    x-group: User data
  - name: ObserveDataDeletionJob
    description: Data deletion job APIs
    x-group: User data
  - name: ObserveFlowTypeDefinition
    description: Flow type definitions used in authentication journeys.
    x-group: Catalogs and labels
  - name: ObserveCatalog
    description: Catalog APIs
    x-group: Catalogs and labels
  - name: OpenAPI
    description: Downloadable API specification
  - name: ProjectOperationExecution
    description: Project-scoped operation history and pipeline health
  - name: ObserveClassification
    description: Flow and subflow classification APIs
  - name: ObserveIntegrationStats
    description: Integration stats APIs
  - name: ObserveTimeSeriesPrecalculation
    description: Time series precalculation APIs
  - name: ObserveIDList
    x-group: Saved ID lists
    description: Stored ID-list selection APIs
  - name: ObserveDataContext
    description: Schema-loose data context APIs for agent and debugging tooling
  - name: ObserveData
    description: Observe data administration APIs
  - name: ObserveTrackingStats
    description: Tracking ingestion stats APIs
  - name: ObserveExperiment
    x-group: Experiments
    description: Experiment catalog and run APIs
  - name: ObserveDataPolicy
    description: >-
      Project data policy catalogue (retention selected by the SDK's
      meta.dataPolicy code)
  - name: ObserveMetadata
    x-group: Metadata
    description: Authenticator metadata APIs (FIDO MDS + passkey AAGUID)
  - name: ObservePasskey
    x-group: Passkey analysis
    description: Observed passkey search and cohort analysis.
paths:
  /observe/alertRuleTypes:
    get:
      tags:
        - ObserveAlert
      summary: List alert rule types
      description: >-
        Lists the alert rule types that can be created, described for the
        authenticated project. The rule builder renders itself from this:
        `available` says whether the project has the data the type reads, and
        `dimensions` are the keys a rule of that type can be grouped by here,
        including the project's own time-series tags. A type with `available`
        false, or a `groupBy` key not listed here, is rejected when the rule is
        saved.


        Required API key permission: `observe:alerts:read`.
      operationId: ObserveAlertRuleTypeList
      responses:
        '200':
          description: Alert rule types, ordered by ruleType.
          content:
            application/json:
              schema:
                type: array
                maxItems: 100
                items:
                  $ref: '#/components/schemas/observeAlertRuleType'
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:alerts:read
components:
  schemas:
    observeAlertRuleType:
      type: object
      required:
        - ruleType
        - label
        - measures
        - available
        - dimensions
      properties:
        ruleType:
          type: string
          enum:
            - login_success_rate
          description: >-
            Identifies the type; this is what a rule of this type stores in
            ruleType.
        label:
          type: string
          description: Human-readable name of the type, for the type picker.
        measures:
          type: string
          description: >-
            What the type measures, as a short phrase (e.g. "completed logins /
            engaged logins").
        available:
          type: boolean
          description: >-
            Whether this project has the data this type reads. Rules of an
            unavailable type cannot be saved.
        dimensions:
          type: array
          maxItems: 100
          description: >-
            Keys a rule of this type can be grouped by for this project. Empty
            when available is false.
          items:
            $ref: '#/components/schemas/observeAlertRuleTypeDimension'
    observeAlertRuleTypeDimension:
      type: object
      required:
        - key
        - name
      properties:
        key:
          type: string
          description: >-
            What a rule stores in groupBy, and what comes back as a label key on
            its instances.
        name:
          type: string
          description: Display name for the grouping picker.
    errorRspV2:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              description: Error message
              type: string
              example: Validation failed
            details:
              description: Validation error details per field
              type: array
              items:
                type: object
                required:
                  - field
                  - message
                properties:
                  field:
                    description: Field name that failed validation
                    type: string
                    example: projectID
                  message:
                    description: Validation error message
                    type: string
                    example: required
  responses:
    error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorRspV2'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an Observe API key from the management console. The key selects the
        project and must grant the permission listed on the operation. Keep this
        key on your server.

````