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

# Get dashboard alert rules id

> Requires scopes: eval:read



## OpenAPI

````yaml /api-reference/openapi.json get /api/dashboard-alert-rules/{id}
openapi: 3.1.2
info:
  title: EvalGate API
  version: 18.12.0
  description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
  - url: https://evalgate.com
    description: Production
  - url: http://localhost:3000
    description: Local
security: []
paths:
  /api/dashboard-alert-rules/{id}:
    get:
      tags:
        - dashboard alert rules
      summary: Get dashboard alert rules id
      description: 'Requires scopes: eval:read'
      operationId: get_dashboard_alert_rules_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetApiDashboardAlertRulesIdResponse200ApplicationJson
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
components:
  schemas:
    GetApiDashboardAlertRulesIdResponse200ApplicationJson:
      type: object
      properties:
        rule:
          type: object
          properties:
            id:
              type: string
            organizationId:
              $ref: '#/components/schemas/OrganizationId'
            ruleKey:
              type: string
            name:
              type: string
            ownerId:
              type: string
            currentVersionId:
              oneOf:
                - type: 'null'
                - type: string
            enabled:
              type: boolean
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
          additionalProperties: false
          required:
            - id
            - organizationId
            - ruleKey
            - name
            - ownerId
            - currentVersionId
            - enabled
            - createdAt
            - updatedAt
        version:
          type: object
          properties:
            id:
              type: string
            organizationId:
              $ref: '#/components/schemas/OrganizationId'
            alertRuleId:
              type: string
            version:
              type: number
            metricDefinitionId:
              type: string
            operator:
              type: string
            thresholdJson:
              type: object
              properties:
                value:
                  type: number
                upperValue:
                  type: number
                forConsecutive:
                  type: number
                resolveAfterConsecutive:
                  type: number
              additionalProperties: false
              required:
                - value
                - forConsecutive
                - resolveAfterConsecutive
            evaluationWindow:
              oneOf:
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - relative
                    timezone:
                      type: string
                    lookbackSeconds:
                      type: number
                  additionalProperties: false
                  required:
                    - type
                    - timezone
                    - lookbackSeconds
                - type: object
                  properties:
                    type:
                      type: string
                      enum:
                        - absolute
                    timezone:
                      type: string
                    from:
                      type: string
                    to:
                      type: string
                  additionalProperties: false
                  required:
                    - type
                    - timezone
                    - from
                    - to
            dedupeWindowSeconds:
              type: number
            severity:
              type: string
            deliveryConfig:
              type: object
              properties:
                webhook:
                  type: boolean
                notification:
                  type: boolean
              additionalProperties: false
              required:
                - webhook
                - notification
            contentHash:
              type: string
            createdBy:
              type: string
            createdAt:
              type: string
              format: date-time
          additionalProperties: false
          required:
            - id
            - organizationId
            - alertRuleId
            - version
            - metricDefinitionId
            - operator
            - thresholdJson
            - evaluationWindow
            - dedupeWindowSeconds
            - severity
            - deliveryConfig
            - contentHash
            - createdBy
            - createdAt
        state:
          type: object
          properties:
            alertRuleId:
              type: string
            organizationId:
              $ref: '#/components/schemas/OrganizationId'
            state:
              type: string
            revision:
              type: number
            consecutiveBreaches:
              type: number
            consecutiveHealthy:
              type: number
            lastValue:
              oneOf:
                - type: 'null'
                - type: object
                  properties:
                    status:
                      oneOf:
                        - type: string
                          enum:
                            - failed
                        - type: string
                          enum:
                            - success
                        - type: string
                          enum:
                            - partial
                    value:
                      oneOf:
                        - type: 'null'
                        - type: number
                    knownCount:
                      type: number
                    unknownCount:
                      type: number
                    evidenceIds:
                      type: array
                      items:
                        type: string
                    warnings:
                      type: array
                      items:
                        type: string
                    errorCode:
                      type: string
                  additionalProperties: false
                  required:
                    - status
                    - value
                    - knownCount
                    - unknownCount
                    - evidenceIds
                    - warnings
            lastEvaluatedAt:
              oneOf:
                - type: 'null'
                - type: string
                  format: date-time
            lastTransitionAt:
              oneOf:
                - type: 'null'
                - type: string
                  format: date-time
            lastDedupeKey:
              oneOf:
                - type: 'null'
                - type: string
          additionalProperties: false
          required:
            - alertRuleId
            - organizationId
            - state
            - revision
            - consecutiveBreaches
            - consecutiveHealthy
            - lastValue
            - lastEvaluatedAt
            - lastTransitionAt
            - lastDedupeKey
      additionalProperties: false
      required:
        - rule
        - version
        - state
    OrganizationId:
      type: string
      format: uuid
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - INVALID_REFERENCE
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - FEATURE_LIMIT_REACHED
                - NO_ORG_MEMBERSHIP
                - SHARE_REVOKED
                - SHARE_EXPIRED
                - SHARE_UNAVAILABLE
                - PROVIDER_KEY_MISSING
                - PROVIDER_KEY_EXPIRED
                - PROVIDER_RATE_LIMITED
                - PROVIDER_UNAUTHORIZED
                - PROVIDER_UNAVAILABLE
                - AGENT_HANDOFF_INVALID
                - AGENT_HANDOFF_EXPIRED
                - AGENT_HANDOFF_DENIED
                - AGENT_HANDOFF_CONSUMED
                - PAYLOAD_TOO_LARGE
                - METHOD_NOT_ALLOWED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
            redaction:
              type: object
              properties:
                applied:
                  type: boolean
                  enum:
                    - true
                fieldCount:
                  type: integer
                  minimum: 0
                secretCount:
                  type: integer
                  minimum: 0
              required:
                - applied
                - fieldCount
                - secretCount
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
        WWW-Authenticate:
          description: >-
            Bearer challenge. Agent-facing routes include the RFC 9728
            resource_metadata URL.
          schema:
            type: string
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
        Retry-After:
          description: Delay in seconds before retrying when present.
          schema:
            type: integer
            minimum: 1
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: EvalGate API key
      description: >-
        Organization-scoped EvalGate API key. Discover the supported agent
        scopes at /.well-known/oauth-protected-resource. Per-operation grants
        are listed in x-evalgate-required-scopes; OpenAPI bearer security
        requirement arrays remain empty as required for non-OAuth schemes.
      x-evalgate-scopes-supported:
        - eval:read
        - eval:write
        - objectives:read
        - objectives:write
        - runs:read
        - runs:write
        - traces:read
        - traces:write
        - exports:download
        - reports:write
        - prompt:publish
        - scorer:publish
        - red_team:read
        - red_team:run
        - red_team:approve
        - docs:read
        - agent:read
        - agent:execute
        - resources:read
        - resources:write
        - contexts:read
        - contexts:write
        - observations:write
        - checks:read
        - checks:run
        - standards:read
        - standards:write
        - standards:approve
        - grants:read
        - grants:write
        - admin:keys
        - admin:workspace
        - admin:org
      x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource

````

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