SummaryReportResponse

Fields

19 fields

avg_duration_ms · required

integer

flaky_criteria

FlakyCountCriteria or null

flaky_rate_pct · required

number

flaky_test_count · required

integer

Not scoped by release_id. A test is flaky by its last N executions across the project's history (flaky_criteria) -- a run-count window, not a set of runs -- and the dashboard's flaky count and the release gate's flaky cap read that same project-wide figure; restricting it to one release's runs would be a different metric. Scoped by suite_name.

generated_at · required

string

last_run_before_window_at

string or null

latest_run_at

string or null

meta

object or null

mode · required

string

period_end · required

string

period_start · required

string

project_id

string or null

project_name

string or null

run_count · required

integer

runs_per_day

number or null

suites · required

array of SummarySuiteRow

top_failing_tests · required

array of SummaryTopFailingTest

totals · required

SummaryTotals

window_days · required

integer

Raw schema (JSON)

{
  "properties": {
    "avg_duration_ms": {
      "title": "Avg Duration Ms",
      "type": "integer"
    },
    "flaky_criteria": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/FlakyCountCriteria"
        },
        {
          "type": "null"
        }
      ]
    },
    "flaky_rate_pct": {
      "title": "Flaky Rate Pct",
      "type": "number"
    },
    "flaky_test_count": {
      "description": "Not scoped by release_id. A test is flaky by its last N executions across the project's history (flaky_criteria) -- a run-count window, not a set of runs -- and the dashboard's flaky count and the release gate's flaky cap read that same project-wide figure; restricting it to one release's runs would be a different metric. Scoped by suite_name.",
      "title": "Flaky Test Count",
      "type": "integer"
    },
    "generated_at": {
      "title": "Generated At",
      "type": "string"
    },
    "last_run_before_window_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Last Run Before Window At"
    },
    "latest_run_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Latest Run At"
    },
    "meta": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "title": "Meta"
    },
    "mode": {
      "enum": [
        "window",
        "latest"
      ],
      "title": "Mode",
      "type": "string"
    },
    "period_end": {
      "title": "Period End",
      "type": "string"
    },
    "period_start": {
      "title": "Period Start",
      "type": "string"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id"
    },
    "project_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Name"
    },
    "run_count": {
      "title": "Run Count",
      "type": "integer"
    },
    "runs_per_day": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Runs Per Day"
    },
    "suites": {
      "items": {
        "$ref": "#/components/schemas/SummarySuiteRow"
      },
      "title": "Suites",
      "type": "array"
    },
    "top_failing_tests": {
      "items": {
        "$ref": "#/components/schemas/SummaryTopFailingTest"
      },
      "title": "Top Failing Tests",
      "type": "array"
    },
    "totals": {
      "$ref": "#/components/schemas/SummaryTotals"
    },
    "window_days": {
      "title": "Window Days",
      "type": "integer"
    }
  },
  "required": [
    "mode",
    "window_days",
    "generated_at",
    "period_start",
    "period_end",
    "totals",
    "run_count",
    "avg_duration_ms",
    "flaky_test_count",
    "flaky_rate_pct",
    "suites",
    "top_failing_tests"
  ],
  "title": "SummaryReportResponse",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• GET /api/v1/reports/summary — Get Summary Report

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON