domain_matches

Creates, updates, deletes, gets or lists a domain_matches resource.

Overview

Name	domain_matches
Type	Resource
Id	cloudflare.brand_protection.domain_matches

Fields

The following fields are returned by SELECT queries:

list

Successfully retrieved query matches

Name	Datatype	Description
scan_submission_id	integer
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.
domain	string
first_seen	string
match_details	array	Per-match detail objects with query metadata and individual dismissed state. Only present when multiple query_ids are requested.
public_scans	object
registrar	string
scan_status	string
source	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id	offset, limit, query_id, include_domain_id, include_dismissed, domain_search, orderBy, order	Get paginated list of domain matches for one or more brand protection queries. When multiple query_ids are provided (comma-separated), matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and individual dismissed state.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
domain_search	string
include_dismissed	string
include_domain_id	string
limit	string
offset	string
order	string
orderBy	string
query_id	array

SELECT examples

list

Get paginated list of domain matches for one or more brand protection queries. When multiple query_ids are provided (comma-separated), matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and individual dismissed state.

SELECT
scan_submission_id,
dismissed,
domain,
first_seen,
match_details,
public_scans,
registrar,
scan_status,
source
FROM cloudflare.brand_protection.domain_matches
WHERE account_id = '{{ account_id }}' -- required
AND offset = '{{ offset }}'
AND limit = '{{ limit }}'
AND query_id = '{{ query_id }}'
AND include_domain_id = '{{ include_domain_id }}'
AND include_dismissed = '{{ include_dismissed }}'
AND domain_search = '{{ domain_search }}'
AND orderBy = '{{ orderBy }}'
AND order = '{{ order }}'
;