List saved query matches

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

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 matched_queries array.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Cloudforce One WriteCloudforce One Read

Path ParametersExpand Collapse

account_id: string

minLength1

Query ParametersExpand Collapse

query_id: array of string

Query ID or comma-separated list of Query IDs. When multiple IDs are provided, matches are deduplicated across queries and each match includes matched_queries and match_ids arrays.

domain_search: optional string

Filter matches by domain name (substring match)

include_dismissed: optional string

include_domain_id: optional string

limit: optional string

offset: optional string

order: optional "asc" or "desc"

Sort order. Options: ‘asc’ (ascending) or ‘desc’ (descending)

One of the following:

"asc"

"desc"

orderBy: optional "domain" or "first_seen"

Column to sort by. Options: ‘domain’ or ‘first_seen’

One of the following:

"domain"

"first_seen"

ReturnsExpand Collapse

matches: array of { dismissed, domain, first_seen, 6 more }

dismissed: boolean

domain: string

first_seen: string

public_scans: { submission_id }

submission_id: string

scan_status: string

scan_submission_id: number

source: string

match_ids: optional array of number

All underlying match row IDs for this domain. Only present when multiple query_ids are requested.

matched_queries: optional array of number

List of query IDs that produced this match. Only present when multiple query_ids are requested.

total: number

minimum0

List saved query matches

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/cloudforce-one/v2/brand-protection/domain/matches \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "matches": [
    {
      "dismissed": true,
      "domain": "domain",
      "first_seen": "first_seen",
      "public_scans": {
        "submission_id": "submission_id"
      },
      "scan_status": "scan_status",
      "scan_submission_id": 0,
      "source": "source",
      "match_ids": [
        0
      ],
      "matched_queries": [
        0
      ]
    }
  ],
  "total": 0
}

Returns Examples

{
  "matches": [
    {
      "dismissed": true,
      "domain": "domain",
      "first_seen": "first_seen",
      "public_scans": {
        "submission_id": "submission_id"
      },
      "scan_status": "scan_status",
      "scan_submission_id": 0,
      "source": "source",
      "match_ids": [
        0
      ],
      "matched_queries": [
        0
      ]
    }
  ],
  "total": 0
}