Skip to main content
POST
ListEntityCoverage

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
selection
public_query · object
required

The assets to report on. Required.

filter
enum<string>

Which coverage state to keep. Defaults to all candidates.

A filter naming a kind your credential may not read is PERMISSION_DENIED rather than an empty list.

Available options:
COVERAGE_FILTER_UNSPECIFIED,
COVERAGE_FILTER_WITHOUT_DATAPRODUCT,
COVERAGE_FILTER_WITHOUT_OWNER,
COVERAGE_FILTER_WITHOUT_ANY,
COVERAGE_FILTER_WITH_DATAPRODUCT,
COVERAGE_FILTER_WITH_OWNER
freshness
enum<string>

Where the answer is computed from. Defaults to the recomputed membership.

Available options:
FRESHNESS_UNSPECIFIED,
FRESHNESS_CACHED,
FRESHNESS_LIVE
pagination
Pagination · object

Pagination over the candidates matching filter.

Response

200 - application/json

Success

entities
EntityOverlays · object[]

One page of matching candidates, each with the overlays claiming it.

The same message BatchGetEntityOverlays returns: a row under COVERAGE_FILTER_WITHOUT_DATAPRODUCT has an empty dataproduct_entity_ids and may still name owners, which is how "owned but in no product" reads without a second call.

totalCount

How many candidates match filter across every page. Independent of pagination — the number to show beside a list, not the length of it.

pageInfo
PageInfo · object

Pagination cursor for the next page.

renderedResolverQl
string

The candidate selection rendered back to canonical resolver query language, whichever form it was sent in. Useful to log what was actually asked, and to lift a query built with the structured form into one you can hand-edit.

Empty when the selection has no resolver-QL representation; the answer is unaffected.

membersComputedAt
string<date-time> | null

When the recomputation behind this answer last ran to completion — the start of the most recent successful pass over the workspace's overlays. Every overlay is recomputed on each pass, so this is the age of the whole answer rather than of any one overlay in it.

This is the number to alert on: it stops advancing as soon as the recomputation stops succeeding, whether or not any membership has changed.

Absent under FRESHNESS_LIVE (nothing was read from an index), and absent when no overlay of a readable kind exists in the workspace, or none has been computed yet (there is no membership to be stale).

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"