Skip to content
Start here

Matches

List saved query matches
brand_protection.v2.matches.get(MatchGetParams**kwargs) -> MatchGetResponse
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches
ModelsExpand Collapse
class MatchGetResponse:
matches: List[Match]
domain: str
first_seen: str
public_scans: Optional[MatchPublicScans]
submission_id: str
registrar: Optional[str]
scan_status: str
scan_submission_id: Optional[int]
source: Optional[str]
dismissed: Optional[bool]

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: Optional[List[MatchMatchDetail]]

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

dismissed: bool

Individual dismissed state for this specific match.

match_id: int
query_id: int
query_tag: Optional[str]

Tag associated with the query, if one exists.

total: int
minimum0