Get Desk Coverage

GET

/desk/coverage

• Production
• QA

Quarterly open-pipeline coverage against target.

{"enabled": false} when the org has set no quarterly target - a 200 with a reason rather than a 404, so a dashboard can say “not configured”.

Authorizations

• BearerAuth

Parameters

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string