Matches

List saved query matches

client.brandProtection.v2.matches.get(, ?): MatchGetResponse { matches, total }

GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches

ModelsExpand Collapse

MatchGetResponse { matches, total }

matches: Array<Match>

domain: string

first_seen: string

public_scans: PublicScans | null

submission_id: string

registrar: string | null

scan_status: string

scan_submission_id: number | null

source: string | null

dismissed?: boolean

Whether the match is dismissed. Only present for single-query requests. For multi-query requests, use the dismissed field in each match_details entry.

match_details?: Array<MatchDetail>

Per-match detail objects with query metadata and individual dismissed state. Only present when multiple query_ids are requested.

dismissed: boolean

Individual dismissed state for this specific match.

match_id: number

query_id: number

query_tag: string | null

Tag associated with the query, if one exists.

total: number

minimum0