Skip to main content
POST
List Hotlist Findings

Authorizations

Authorization
string
header
required

CodeAnt API token (cdt_...), created on the Settings → API Tokens page. Pass via Authorization: Bearer <token> header.

Body

application/json

Ranked Hotlist page request.

platform
enum<string>
required

Git platform of the organization

Available options:
github,
gitlab,
bitbucket,
azure_devops
org
string
required

Organization / workspace slug

github_base_url
string

Self-hosted instance URL (also gitlab_base_url / bitbucket_base_url / azure_devops_base_url). Defaults to the cloud host.

Example:

"https://github.com"

filters
object

Values within one dimension are ORed; dimensions are ANDed together. Omit a dimension, or send an empty list, to leave it unfiltered. Use the facets of a previous response to discover the values available in your organization.

Case-insensitive substring match over the finding title, identifier, location and file path.

limit
integer
default:30

Findings per page.

Required range: 1 <= x <= 100
cursor
string

Opaque next_cursor from the previous page. A cursor is bound to the snapshot revision and to the exact filters + search it was issued for; changing either, or a rebuild of the Hotlist, returns 409 HOTLIST_CURSOR_STALE and pagination must restart.

Response

Ranked findings returned

state
string
Example:

"ready"

snapshot_revision
string

Revision of the snapshot this page was served from.

scoring_version
string
Example:

"hotlist-v2"

updated_at
string<date-time>
source_freshness
object

Last time each scanner's data was folded into the snapshot.

summary
object

Headline counts for exactly the findings the request matched.

facets
object

Available filter values with their counts, keyed by the dimensions of HotlistFilters.

sla_config
object

SLA in days configured per severity; null means no SLA for that severity.

total_filtered
integer

Findings matching the request across all pages.

items
object[]

One page of findings, highest priority first.

next_cursor
string | null

Pass back as cursor to fetch the next page; null on the last page.

has_more
boolean