> ## Documentation Index > Fetch the complete documentation index at: https://docs.fiddler.ai/llms.txt > Use this file to discover all available pages before exploring further. # List of all alert rule summary in the given time_bucket_start and time_bucket_end > List of all alert rule summary in the given time_bucket_start and time_bucket_end ## OpenAPI ````yaml GET /v3/alert-rules/summary openapi: 3.0.3 info: title: Fiddler API - 2.0 description: APIs to interact with Fiddler termsOfService: https://fiddler.ai/about/terms contact: email: support@fiddler.ai license: name: Proprietary url: '2.0' version: '2.0' servers: [] security: - BearerAuth: [] tags: - name: access-key description: CRUD operations for API keys - name: span-v3 - name: aggregation-invalidation-request-v3 description: Endpoints related to retrieving aggregation invalidation requests - name: alert-rules-v3 description: CRUD for Alert Rules, Summary, and Stats APIs - name: application-v3 - name: attribute-v3 - name: auth description: Authentication strategies and login flows - name: baseline-v3 description: CRUD for baseline - name: catalog-v3 description: >- Entity catalog provides paginated, searchable discovery of entity names (attribute keys, agent names, span types, span names) and their distinct values. Powered by ClickHouse materialized views — no worker or PostgreSQL dependency. - name: chart-annotation-v3 description: Endpoints related to retrieving chart annotations - name: chart-v3 description: CRUD for chart - name: queries-v3 description: v3 queries API - name: configuration-v3 description: CRUD for configurations - name: custom-metrics-v3 - name: dimensionality-reduction-v3 - name: environment-v3 description: Endpoints related to environment management - name: evals - name: datasets - name: evaluation-v3 - name: evaluator-v3 - name: rule-evaluators-v3 - name: experiment-v3 - name: explainability-v3 - name: llm_rca-v3 - name: file-upload description: Endpoints related to file uploading. - name: fql-expressions-v3 description: > Endpoints for listing FQL (Fiddler Query Language) functions available for GenAI custom metrics. Used by the frontend for autocomplete and signature hints in the FQL editor. - name: genai-alert-rules-v3 description: CRUD API for GenAI Alert Rules - name: genai-custom-metrics-v3 description: API for GenAI Custom Metrics - name: genai-metrics-v3 description: >- Endpoints for pre-aggregated GenAI metrics. All metric data is pre-aggregated by an hourly ClickHouse refreshable materialized view; no real-time aggregation is performed at request time. - name: guardrails-api description: Endpoints related to retrieving Guardrails specific data - name: ingestion-v3 - name: intercom-api description: Endpoints related to intercom APIs - name: jobs-v3 - name: llm-gateway-v3 - name: auth-login - name: auth-logout - name: metrics-v3 description: Metrics endpoints - name: model-v3 - name: dashboard-v3 - name: model-deployment-v3 - name: monitoring-summary-v3 - name: histograms-v3 - name: organization-roles-v3 description: Update user org role - name: organization-settings-v3 description: Update organization settings such as timezone, email configuration, etc. - name: pagerduty-api description: CRUD for Pagerduty services. - name: project-v3 - name: project-roles-v3 description: Project role assignment management - name: searchable-text-key-v3 description: >- Manage the global searchable text keys table that controls which OTel attribute keys are routed to the full-text-searchable `ValueContent` column in the unified attributes table. Changes propagate to the backing ClickHouse dictionary within 1-2 minutes and affect all tenants. - name: segments-v3 - name: semantic-mapping-v3 description: >- Manage the global semantic name mappings table that maps raw OTel attribute keys to canonical semantic concepts. Changes propagate to the backing ClickHouse dictionary within 1-2 minutes and affect all tenants. - name: server-info-v3 description: Endpoints related to retrieving server information - name: sessions-v3 description: v3 session APIs - name: team-roles-v3 - name: team-v3 - name: traces-v3 description: v3 trace api for monitoring - name: fetch-sessions-v3 description: v3 fetch sessions api for monitoring - name: user-access-key description: > CRUD operations for user API keys. All endpoints are user-scoped — each user can only operate on their own API keys. No one including Org admins have access to other users' API keys. - name: users-v3 - name: version-compatibility-v3 - name: webhooks externalDocs: url: https://docs.fiddler.ai description: Find out more about Fiddler paths: /v3/alert-rules/summary: get: tags: - alert-rules-v3 summary: >- List of all alert rule summary in the given time_bucket_start and time_bucket_end description: >- List of all alert rule summary in the given time_bucket_start and time_bucket_end operationId: getAlertRulesSummary parameters: - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/start_time' - $ref: '#/components/parameters/end_time' responses: '200': description: >- Summary of all alert rules in the given time_bucket_start and time_bucket_end content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginatedApiResponse' - type: object properties: data: type: object properties: items: type: array items: $ref: '#/components/schemas/AlertRuleSummary' '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' components: parameters: filter: name: filter in: query description: Allows you to filter by any field. required: false schema: type: string search: name: search in: query description: Allows you to search by any field. required: false schema: type: string ordering: name: ordering in: query description: >- Allows you to order results by any field. For desc order prefix field name with `-` and provide comman separated values for multiple fields required: false schema: type: string limit: name: limit in: query description: Limit for the pagination required: false schema: type: integer offset: name: offset in: query description: Offset for the pagination required: false schema: type: integer start_time: name: start_time in: query description: requested start time required: true schema: type: string format: date-time end_time: name: end_time in: query description: requested end time required: true schema: type: string format: date-time schemas: PaginatedApiResponse: type: object description: | Response object for paginated API responses. properties: api_version: type: string default: '3.0' enum: - '2.0' - '3.0' description: | API version of the response. kind: type: string default: PAGINATED enum: - PAGINATED description: | Type of response, indicating a paginated response. data: type: object properties: page_size: type: integer default: 10 example: 10 description: | Number of items per page in the response. item_count: type: integer default: 10 example: 10 description: | Number of items in the current page. total: type: integer example: 100 default: 100 description: | Total number of items across all pages. page_count: type: integer default: 10 example: 10 description: | Total number of pages. page_index: type: integer default: 1 example: 1 description: | Current page index. offset: type: integer default: 0 example: 0 description: | Offset of the first item in the current page. AlertRuleSummary: allOf: - type: object required: - id - alert_rule_id - name - metric - priority - bin_size - condition - alert_record_count - alert_value - baseline - threshold_type - latest_alert_record_severity - latest_alert_record_value - latest_alert_time_bucket - latest_alert_feature_name - latest_alert_feature_id - model - project - organization properties: alert_rule_id: type: string format: uuid description: Unique identifier for an Alert Rule. id: type: string format: uuid description: Unique identifier of the latest Alert Record. name: type: string description: Name of an Alert Rule. metric: $ref: '#/components/schemas/MetricCompact' is_fiddler_generated: type: boolean description: >- Boolean indicating whether the Alert Rule is generated by Fiddler. priority: $ref: '#/components/schemas/PriorityEnum' compare_to: $ref: '#/components/schemas/CompareToEnum' bin_size: $ref: '#/components/schemas/BinSizeEnum' condition: type: string description: Metric value comparision (lesser or greater). alert_record_count: type: integer description: >- The number of Alert evaluations that resulted in triggered Alert Records. alert_value: type: number format: float description: >- Value of the metric from the latest triggered Alert Record for the Alert Rule. feature_names: type: array items: type: string description: List of feature names, if specified in the Alert Rule. threshold_type: $ref: '#/components/schemas/ThresholdAlgoEnum' critical_threshold: type: number format: double description: Critical threshold value specified in the Alert Rule. warning_threshold: type: number format: double description: Warning threshold value specified in the Alert Rule. enable_notification: type: boolean description: >- Boolean indicating whether to send notification when an Alert Rule is created. compare_bin_delta: type: integer nullable: true description: >- This field specifies the lookback period for relative comparisons, expressed as a multiple of the chosen time bin size. It determines the historical data timeframe used to evaluate changes in the metric value. latest_alert_record_value: type: number format: float description: >- Value of the metric from the latest triggered Alert Record for the Alert Rule. latest_alert_time_bucket: type: number format: float description: >- Value of the time bucket from the latest triggered Alert Record for the Alert Rule. latest_alert_feature_name: type: string description: >- Name of feature from the latest triggered Alert Record for the Alert Rule. latest_alert_feature_id: type: string description: >- Id of feature from the latest triggered Alert Record for the Alert Rule. latest_threshold: type: number format: float description: >- Value of threshold from the latest triggered Alert Record for the Alert Rule. latest_alert_record_severity: $ref: '#/components/schemas/SeverityEnum' severity: $ref: '#/components/schemas/SeverityEnum' organization: $ref: '#/components/schemas/OrganizationCompact' project: $ref: '#/components/schemas/ProjectCompact' model: $ref: '#/components/schemas/ModelCompact' baseline: nullable: true allOf: - $ref: '#/components/schemas/BaselineCompact' segment: nullable: true allOf: - $ref: '#/components/schemas/SegmentCompact' created_at: type: string format: date-time description: The time when the latest triggered Alert Record is created. updated_at: type: string format: date-time description: The time when the latest triggered Alert Record is updated. created_by: $ref: '#/components/schemas/UserCompact' updated_by: $ref: '#/components/schemas/UserCompact' MetricCompact: type: object title: MetricCompact required: - id - type - display_name - type_display_name properties: id: type: string description: Name for builtin metrics, UUID for custom metrics display_name: type: string type: $ref: '#/components/schemas/MetricTypeEnum' type_display_name: $ref: '#/components/schemas/MetricTypeDisplayNameEnum' PriorityEnum: type: string enum: - HIGH - MEDIUM - LOW CompareToEnum: type: string description: >- This API provides two alert evaluation methods, absolute comparisons determine if the current metric value breaches a predefined threshold, while relative comparisons analyze changes in metric by referencing a chosen time period. enum: - raw_value - time_period BinSizeEnum: type: string description: The Supported bin sizes for the Alert Rules. enum: - Hour - Day - Week - Month ThresholdAlgoEnum: type: string description: The type of threshold algorithm used to evaluate alerts. enum: - manual - standard_deviation_auto_threshold SeverityEnum: type: string enum: - WARNING - CRITICAL - DEFAULT OrganizationCompact: type: object title: OrganizationCompact description: > Compact version of an organization which can be included in the response of relevant APIs. required: - id - name properties: id: type: string format: uuid description: | Unique identifier of the organization. name: type: string description: | Name of the organization. ProjectCompact: type: object title: ProjectCompact description: > Compact version of a project which can be included in the response of relevant APIs. required: - id - name properties: id: type: string format: uuid description: | Unique identifier of the project. name: type: string description: | Name of the project. asset_type: type: string enum: - ML_MODEL - GEN_AI_APP description: | Type of assets the project can have. ModelCompact: type: object title: ModelCompact description: > Compact version of a model which can be included in the response of relevant APIs. required: - id - name - version properties: id: type: string format: uuid description: | Unique identifier for the model. name: type: string description: | Name of the model. version: type: string description: | Version of the model. BaselineCompact: type: object title: BaselineCompact description: > Compact version of a baseline which can be included in the response of relevant APIs. required: - id - name properties: id: type: string format: uuid description: | Unique identifier of the baseline. name: type: string description: | Name of the baseline. SegmentCompact: type: object title: SegmentCompact description: Compact version of segment for v3 properties: id: type: string format: uuid description: Unique identifier of the saved segment definition: type: string description: FQL definition of the applied segment UserCompact: type: object title: UserCompactV3 description: > Compact version of a user which can be included in the response of relevant APIs. required: - id - email properties: id: type: string format: uuid readOnly: true description: | Unique identifier for the user. full_name: type: string readOnly: true description: | Full name of the user. email: type: string format: email description: | Email address of the user. ErrorResponse: type: object description: | Response object for errors returned by the API. properties: api_version: type: string default: '3.0' enum: - '2.0' - '3.0' description: | API version of the response. kind: type: string default: ERROR enum: - ERROR description: | Type of response, usually indicating an error. error: type: object properties: code: type: integer format: int32 description: > Represents the code for this error, typically an HTTP response code. default: 400 enum: - 400 - 403 - 404 - 500 message: type: string description: > A human-readable message providing more details about the error. If there are multiple errors, it will be the message for the first error. example: Resource Not Found errors: type: array description: > Container for additional information regarding the error, especially for multiple errors. items: type: object properties: reason: type: string description: > Unique identifier for this error, different from the error code. example: ResourceNotFoundException message: type: string description: > A human-readable message providing more details about the error. If there is only one error, this field will match error.message. example: Resource Not Found help: type: string description: > Link to support or documentation providing more information on the error. MetricTypeEnum: type: string enum: - drift - data_integrity - performance - service_metrics - statistic - custom MetricTypeDisplayNameEnum: type: string enum: - Data Drift - Data Integrity - Performance - Traffic - Statistic - Custom Metric responses: '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer ````