List logo matches

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

Lists images that matched a saved logo query, most recently matched first by default. Set download=true to include each matched image as base64 data.

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: string

ID of the logo query whose matches to list.

minLength1

download: optional string

Set to true to include each matched image as base64 data in image_data, with its MIME type in content_type.

limit: optional string

Maximum number of matches to return. Defaults to 50.

offset: optional string

Number of matches to skip, for pagination. Defaults to 0.

order: optional "asc" or "desc"

Sort direction: asc or desc. Defaults to desc.

One of the following:

"asc"

"desc"

orderBy: optional "matchedAt" or "domain" or "similarityScore" or "registrar"

Field to sort by: matchedAt, domain, similarityScore, or registrar. Defaults to matchedAt.

One of the following:

"matchedAt"

"domain"

"similarityScore"

"registrar"

ReturnsExpand Collapse

matches: array of object { id, domain, matched_at, 6 more }

id: number

ID of the logo match.

domain: string

Domain where the matching image was found, if known.

matched_at: string

When the match was recorded.

query_id: number

ID of the logo query that produced this match.

registrar: string

Registrar of domain, if known.

similarity_score: number

Visual similarity between the matched image and the query logo. Higher is closer.

url_scan_id: string

content_type: optional string

MIME type of the matched image (only present when download=true)

image_data: optional string

Base64-encoded matched image (only present when download=true)

total: number

minimum0

List logo matches

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

{
  "matches": [
    {
      "id": 0,
      "domain": "domain",
      "matched_at": "matched_at",
      "query_id": 0,
      "registrar": "registrar",
      "similarity_score": 0,
      "url_scan_id": "url_scan_id",
      "content_type": "content_type",
      "image_data": "image_data"
    }
  ],
  "total": 0
}

Returns Examples

{
  "matches": [
    {
      "id": 0,
      "domain": "domain",
      "matched_at": "matched_at",
      "query_id": 0,
      "registrar": "registrar",
      "similarity_score": 0,
      "url_scan_id": "url_scan_id",
      "content_type": "content_type",
      "image_data": "image_data"
    }
  ],
  "total": 0
}