Skip to main content
GET
/
v2
/
failure-analysis
/
insights
Get FA insights summary
curl --request GET \
  --url https://api.valiqor.com/v2/failure-analysis/insights \
  --header 'Authorization: Bearer <token>'
{
  "total_runs": 123,
  "total_items_analyzed": 123,
  "overall_failure_rate": 0,
  "average_severity": 0,
  "period_days": 30,
  "period_start": "2023-11-07T05:31:56Z",
  "period_end": "2023-11-07T05:31:56Z",
  "project_name": "<string>",
  "top_recurring_failures": [
    {
      "subcategory_id": "<string>",
      "subcategory_name": "<string>",
      "bucket_id": "<string>",
      "bucket_name": "<string>",
      "occurrence_count": 123,
      "affected_runs": 123,
      "trend_percent": 0
    }
  ],
  "bucket_distribution": [
    {
      "bucket_id": "<string>",
      "bucket_name": "<string>",
      "failure_count": 123,
      "percentage": 0
    }
  ]
}

Authorizations

Authorization
string
header
required

Valiqor API key. Pass as Bearer token: Authorization: Bearer vq-xxxxxxxxxxxxxxxxxxxx

Query Parameters

days
integer | null
default:30

Number of days to analyze (None = all time)

Required range: 1 <= x <= 365
project_name
string | null

Filter by project name

Response

Successful Response

Aggregated insights across FA runs.

total_runs
integer
required
total_items_analyzed
integer
required
overall_failure_rate
number
default:0

Proportion of items that failed 0.0-1.0

average_severity
number
default:0

Average severity score 0.0-5.0

period_days
integer
default:30

Number of days in the analysis period

period_start
string<date-time> | null
period_end
string<date-time> | null
project_name
string | null
top_recurring_failures
RecurringFailure · object[]
bucket_distribution
BucketDistribution · object[]