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

# Create dashboard alert rules evaluate

> Requires scopes: runs:write



## OpenAPI

````yaml /api-reference/openapi.json post /api/dashboard-alert-rules/{id}/evaluate
openapi: 3.1.0
info:
  title: EvalGate API
  version: 3.7.6
  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}/evaluate:
    post:
      tags:
        - dashboard alert rules
      summary: Create dashboard alert rules evaluate
      description: 'Requires scopes: runs:write'
      operationId: post_dashboard_alert_rules_id_evaluate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiDashboardAlertRulesIdEvaluateRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiDashboardAlertRulesIdEvaluateResponse200ApplicationJson
        '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'
      security:
        - bearerAuth:
            - runs:write
components:
  schemas:
    PostApiDashboardAlertRulesIdEvaluateRequest:
      type: object
      properties:
        evaluatedAt:
          type: string
        bypassCache:
          oneOf:
            - type: boolean
              enum:
                - false
            - type: boolean
              enum:
                - true
      additionalProperties: false
    PostApiDashboardAlertRulesIdEvaluateResponse200ApplicationJson:
      type: object
      properties:
        previous:
          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
        transition:
          type: object
          properties:
            state:
              oneOf:
                - type: string
                  enum:
                    - resolved
                - type: string
                  enum:
                    - error
                - type: string
                  enum:
                    - pending
                - type: string
                  enum:
                    - normal
                - type: string
                  enum:
                    - firing
                - type: string
                  enum:
                    - insufficient_data
            transitioned:
              type: boolean
            breached:
              oneOf:
                - type: 'null'
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
            consecutiveBreaches:
              type: number
            consecutiveHealthy:
              type: number
            reason:
              type: string
          additionalProperties: false
          required:
            - state
            - transitioned
            - breached
            - consecutiveBreaches
            - consecutiveHealthy
            - reason
        event:
          type: object
          properties:
            id:
              type: string
            createdAt:
              type: string
              format: date-time
            organizationId:
              $ref: '#/components/schemas/OrganizationId'
            fromState:
              type: string
            toState:
              type: string
            evidenceJson:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
            alertRuleId:
              type: string
            thresholdJson:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
            alertRuleVersionId:
              type: string
            metricCacheId:
              oneOf:
                - type: 'null'
                - type: string
            dedupeKey:
              type: string
            observedValue:
              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
          additionalProperties: false
          required:
            - id
            - createdAt
            - organizationId
            - fromState
            - toState
            - evidenceJson
            - alertRuleId
            - thresholdJson
            - alertRuleVersionId
            - metricCacheId
            - dedupeKey
            - observedValue
        metric:
          type: object
          properties:
            cacheId:
              type: string
            cached:
              type: boolean
            definitionId:
              type: string
            definitionHash:
              type: string
            window:
              type: object
              properties:
                from:
                  type: string
                to:
                  type: string
                timezone:
                  type: string
              additionalProperties: false
              required:
                - from
                - to
                - timezone
            result:
              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
            series:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  bucket:
                    type: string
                  group:
                    type: object
                    additionalProperties:
                      type: string
                  result:
                    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
                additionalProperties: false
                required:
                  - key
                  - bucket
                  - group
                  - result
            evidence:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: string
                total:
                  type: number
                truncated:
                  type: boolean
              additionalProperties: false
              required:
                - ids
                - total
                - truncated
          additionalProperties: false
          required:
            - cacheId
            - cached
            - definitionId
            - definitionHash
            - window
            - result
            - series
            - evidence
      additionalProperties: false
      required:
        - previous
        - transition
        - event
        - metric
    OrganizationId:
      type: string
      format: uuid
    JsonValue:
      oneOf:
        - type: 'null'
        - type: boolean
        - type: number
        - type: string
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - NO_ORG_MEMBERSHIP
                - CROSS_ORG_REFERENCE
                - INCOMPLETE
                - MALFORMED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key or Session Token

````