Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Events
POSTAlertingSince 1.0SynchronousAuth Required

SubmitAlertNoiseAnalysis

Submit a noise analysis job to identify noisy and redundant alert rules

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • timeRangeStringRequired

    Time range for analysis (e.g. 7d, 30d)

    Example: 7d

  • topKIntegerRequired

    Number of top noisy rules to return

    Example: 10

  • groupByListRequired

    Fields to group analysis results by

    Example: item1,item2

  • tenantIdStringRequired

    Tenant identifier for scoped analysis

    Example: 1

Responses

200 OK

On success, this API returns the following response structure.

  • jobIdString

    Unique identifier of the analysis job

    Example: job-001

  • statusString

    Job status: pending, running, completed, or failed

    Example: completed

  • timeRangeString

    Time range used for analysis

    Example: 7d

  • topKInteger

    Number of top noisy rules requested

    Example: 10

  • groupByList

    Grouping fields used in analysis

    Example: item1,item2

  • tenantIdString

    Tenant identifier for the analysis scope

    Example: 1

  • reportObject

    Analysis report (populated when job completes)

    • generatedAtString

      Timestamp when the report was generated

      Example: 2026-01-15T08:00:00Z

    • timeRangeString

      Time range covered by the report

      Example: 7d

    • topNoisyRulesList

      Top noisy rules ranked by fire count

      Example: (nested array)

      • ruleIdString

        Alert rule identifier

        Example: rule-abc123

      • ruleNameString

        Alert rule name

        Example: Disk IO Warning

      • fireCountInteger

        Number of times the rule fired

        Example: 247

      • autoResolveRateLong

        Percentage of alerts that auto-resolved

        Example: 0.92

      • avgDurationSecLong

        Average alert duration in seconds

        Example: 45.5

      • severityString

        Severity level of the rule

        Example: warning

    • stormEventsList

      Alert storm events detected during the period

      Example: (nested array)

      • startTimeString

        Start time of the storm event

        Example: 2026-01-15T08:00:00Z

      • durationMinInteger

        Duration of the storm in minutes

        Example: 15

      • alertCountInteger

        Number of alerts in the storm

        Example: 120

      • rootRuleIdString

        Root cause rule identifier

        Example: rule-abc123

    • suppressionSuggestionsList

      Suggested suppression actions for noisy rules

      Example: (nested array)

      • ruleIdString

        Rule identifier for the suggestion

        Example: rule-abc123

      • ruleNameString

        Rule name for the suggestion

        Example: Disk IO Warning

      • suggestedActionString

        Suggested action (e.g. increase_threshold, add_silence, disable)

        Example: increase_threshold

      • reasonString

        Explanation for why this action is suggested

        Example: 92% of alerts auto-resolve within 60 seconds

    • statusString

      Report generation status

      Example: completed

    • analyzedEventCountInteger

      Total number of alert events analyzed

      Example: 1500

    • analysisDurationMsString

      Duration of the analysis in milliseconds

      Example: 1200

  • createdAtString

    Timestamp when the job was created

    Example: 2026-01-15T08:00:00Z

  • completedAtString

    Timestamp when the job completed

    Example: 2026-01-15T08:00:00Z

  • durationMsString

    Duration of the analysis in milliseconds

    Example: 1500

  • errorMsgString

    Error message if the job failed

    Example: request timeout

Endpoint

POST/api/v1/alerting/noise-analysis

/api/v1/alerting/noise-analysis

Operation ID

SubmitAlertNoiseAnalysis

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/noise-analysis' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"timeRange":"7d","topK":10,"groupBy":"item1,item2","tenantId":1}'

Response Example

200
{
  "jobId": "job-001",
  "status": "completed",
  "timeRange": "7d",
  "topK": 10,
  "groupBy": [],
  "tenantId": 1,
  "report": {},
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history