> ## 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 groups

> Lists the label sets a rule grouped by the given dimensions would currently see, each with how much data it carried over the last seven days, ordered by that count descending. The rule builder's filter picker renders itself from this: the values are exactly what evaluation writes into an alert's labels, so a filter made of them matches. Only rule types that support filters answer; currently flow_volume and subflow_volume, whose variant is the flow or subflow type.

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



## OpenAPI

````yaml /api-reference/openapi/observe.yaml get /observe/alertRuleGroups
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: ObserveIdentifier
    description: Identifier search over submitted identifiers
    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: ObserveFinding
    description: Curated findings that explain errors, their impact and who has to act.
    x-group: Error management
  - name: ObserveAlert
    description: Authentication alert rules, instances and history.
    x-group: Alert management
  - name: ObserveAnnotation
    description: >-
      Annotations, the project's memory (what is true about the data and how to
      read it)
    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: ObserveProbe
    description: Raw probe capture items (internal autocapture diagnostics)
  - name: ObserveTelemetry
    description: Raw SDK/integration diagnostic telemetry
  - 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/alertRuleGroups:
    get:
      tags:
        - ObserveAlert
      summary: List alert rule groups
      description: >-
        Lists the label sets a rule grouped by the given dimensions would
        currently see, each with how much data it carried over the last seven
        days, ordered by that count descending. The rule builder's filter picker
        renders itself from this: the values are exactly what evaluation writes
        into an alert's labels, so a filter made of them matches. Only rule
        types that support filters answer; currently flow_volume and
        subflow_volume, whose variant is the flow or subflow type.


        Required API key permission: `observe:alerts:read`.
      operationId: ObserveAlertRuleGroupList
      parameters:
        - name: ruleType
          in: query
          required: true
          description: The rule type whose data is grouped.
          schema:
            type: string
            enum:
              - flow_volume
              - subflow_volume
          x-oapi-codegen-extra-tags:
            validate: required,oneof=flow_volume subflow_volume
        - name: variant
          in: query
          required: false
          description: >-
            The type's variant - the flow type for flow_volume. Required for a
            type with variants.
          schema:
            type: string
          x-oapi-codegen-extra-tags:
            validate: omitempty,max=64
        - name: groupBy
          in: query
          required: true
          description: >
            Comma-separated dimension keys to group by, as listed by the rule
            types call - dimension names, never columns or tag slots.
          schema:
            type: string
            example: application,country
          x-oapi-codegen-extra-tags:
            validate: required,max=1024
      responses:
        '200':
          description: >-
            Label sets with data, ordered by their count descending. At most
            200.
          content:
            application/json:
              schema:
                type: array
                maxItems: 200
                items:
                  $ref: '#/components/schemas/observeAlertRuleGroup'
        default:
          $ref: '#/components/responses/error'
      security:
        - bearerAuth:
            - observe:alerts:read
components:
  schemas:
    observeAlertRuleGroup:
      type: object
      description: >
        One label set a grouped rule would see, with how much data it carried
        over the listed range. The labels are in evaluation's own vocabulary, so
        a rule filter made of them matches.
      required:
        - labels
        - count
      properties:
        labels:
          type: object
          additionalProperties:
            type: string
          description: One value for every requested groupBy dimension.
        count:
          type: number
          format: double
          description: The data the label set carried over the range, summed.
    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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.