Skip to main content
GET
Get CI overview

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Query Parameters

account
string

Only this GitHub account (organization or user login).

repo
string

Only this repository, as owner/name.

state
enum<string>
default:all

active = queued or running. failed = failed, never started, or refused.

Available options:
all,
active,
failed
limit
integer
default:200
Required range: 1 <= x <= 500

Response

The overview.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Allowed value: "ci.overview"
setup
object
required

The four setup steps, the next one to do, and jobs boat did not run (grouped by repository and reason).

installations
object[]
required
counts
object
required

Jobs in the last 7 days in the account and repo scope, per state tab.

stats
object
required
jobs
object[]
required
filter
object