> ## 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. # Get alerting summary > Returns project-wide counts and status summaries for alert rules and instances, plus the latest scheduled evaluation activity. Takes no filters. Required API key permission: `observe:alerts:read`. ## OpenAPI ````yaml /api-reference/openapi/observe.yaml get /observe/alertSummary 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/alertSummary: get: tags: - ObserveAlert summary: Get alerting summary description: >- Returns project-wide counts and status summaries for alert rules and instances, plus the latest scheduled evaluation activity. Takes no filters. Required API key permission: `observe:alerts:read`. operationId: ObserveAlertSummaryGet responses: '200': description: Alerting summary for the project. content: application/json: schema: $ref: '#/components/schemas/observeAlertSummary' default: $ref: '#/components/responses/error' security: - bearerAuth: - observe:alerts:read components: schemas: observeAlertSummary: type: object description: > Project-wide alerting totals, unaffected by any filter the caller has applied elsewhere. required: - ruleTotals - instanceTotals properties: ruleTotals: $ref: '#/components/schemas/observeAlertRuleTotals' instanceTotals: $ref: '#/components/schemas/observeAlertInstanceTotals' lastEvaluatedMs: type: integer format: int64 description: > The most recent evaluation attempt across the project's rules. Absent when no rule has ever been attempted - which is the one thing the counts alone cannot say, because zero alerts because nothing is wrong looks exactly like zero alerts because nothing is running. observeAlertRuleTotals: type: object description: > How many of the project's alert rules sit in each status. Every field is present, zero included, so a client can render the set without checking which keys exist. required: - active - paused - unhealthy - total properties: active: type: integer description: Rules the evaluation runner picks up. paused: type: integer description: Rules that exist but are not evaluated. unhealthy: type: integer description: > Rules whose last evaluation attempt failed. Counted separately from active and paused rather than alongside them, because health is a second axis and not a third status: an unhealthy rule is also an active one, and adding the three together would double-count it. total: type: integer description: Every rule in the project, whatever its status. observeAlertInstanceTotals: type: object description: > How many of a rule's alert instances sit in each status, counted over all of them rather than over a page of them. This is what lets a rule row say "2 of 12 firing" without the client reading a single instance - and what keeps that number from quietly becoming "2 of however many were fetched" once a rule groups into more instances than one page holds. Every field is present, zero included, so a client can render the set without checking which keys exist. Counts include every instance the rule currently has. required: - normal - pending - firing - noData - error - total properties: normal: type: integer description: Instances whose value is within the thresholds. pending: type: integer description: >- Instances that are breaching but have not yet satisfied the rule's `for` duration. firing: type: integer description: Instances that are breaching and have fired. noData: type: integer description: >- Instances with no value this evaluation - no rows, an empty denominator, or a group under the sample gate. Not the same as zero. error: type: integer description: > Instances in an error state. Currently always 0: a failure that stops a rule evaluating is recorded on the rule as lastErrorReason rather than against its instances, because no instance was reached. The field exists so this set matches the alert instance status vocabulary one-to-one. total: type: integer description: >- Every instance of the rule, whatever its status. Provided so the common "N instances" label needs no addition client-side. 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. ````