List saved query matches

client.BrandProtection.V2.Matches.Get(ctx, params) (*V2MatchGetResponse, error)

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 match_details array with per-match query metadata and individual dismissed state.

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

ParametersExpand Collapse

params V2MatchGetParams

AccountID param.Field[string]

Path param

minLength1

QueryID param.Field[[]string]

Query param: Query ID or comma-separated list of Query IDs. When multiple IDs are provided, matches are deduplicated across queries and each match includes a match_details array with per-match query metadata and dismissed state.

DomainSearch param.Field[string]Optional

Query param: Filter matches by domain name (substring match)

IncludeDismissed param.Field[string]Optional

Query param

IncludeDomainID param.Field[string]Optional

Query param

Limit param.Field[string]Optional

Query param

Offset param.Field[string]Optional

Query param

Order param.Field[V2MatchGetParamsOrder]Optional

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

const V2MatchGetParamsOrderAsc V2MatchGetParamsOrder = "asc"

const V2MatchGetParamsOrderDesc V2MatchGetParamsOrder = "desc"

OrderBy param.Field[V2MatchGetParamsOrderBy]Optional

Query param: Column to sort by. Options: ‘domain’, ‘first_seen’, or ‘registrar’

const V2MatchGetParamsOrderByDomain V2MatchGetParamsOrderBy = "domain"

const V2MatchGetParamsOrderByFirstSeen V2MatchGetParamsOrderBy = "first_seen"

const V2MatchGetParamsOrderByRegistrar V2MatchGetParamsOrderBy = "registrar"

ReturnsExpand Collapse

type V2MatchGetResponse struct{…}

Matches []V2MatchGetResponseMatch

Domain string

FirstSeen string

PublicScans V2MatchGetResponseMatchesPublicScans

SubmissionID string

Registrar string

ScanStatus string

ScanSubmissionID int64

Source string

Dismissed boolOptional

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

MatchDetails []V2MatchGetResponseMatchesMatchDetailOptional

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.

MatchID int64

QueryID int64

QueryTag string

Tag associated with the query, if one exists.

Total int64

minimum0

List saved query matches

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/brand_protection"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  match, err := client.BrandProtection.V2.Matches.Get(context.TODO(), brand_protection.V2MatchGetParams{
    AccountID: cloudflare.F("x"),
    QueryID: cloudflare.F([]string{"string"}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", match.Matches)
}

{
  "matches": [
    {
      "domain": "domain",
      "first_seen": "first_seen",
      "public_scans": {
        "submission_id": "submission_id"
      },
      "registrar": "registrar",
      "scan_status": "scan_status",
      "scan_submission_id": 0,
      "source": "source",
      "dismissed": true,
      "match_details": [
        {
          "dismissed": true,
          "match_id": 0,
          "query_id": 0,
          "query_tag": "query_tag"
        }
      ]
    }
  ],
  "total": 0
}

Returns Examples

{
  "matches": [
    {
      "domain": "domain",
      "first_seen": "first_seen",
      "public_scans": {
        "submission_id": "submission_id"
      },
      "registrar": "registrar",
      "scan_status": "scan_status",
      "scan_submission_id": 0,
      "source": "source",
      "dismissed": true,
      "match_details": [
        {
          "dismissed": true,
          "match_id": 0,
          "query_id": 0,
          "query_tag": "query_tag"
        }
      ]
    }
  ],
  "total": 0
}