Skip to content
Start here

V2

V2Queries

Get queries
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries
ModelsExpand Collapse
QueryGetResponse = array of object { created, parameters, query_id, 3 more }
created: string
parameters: object { string_matches, max_time, min_time }
string_matches: array of object { max_edit_distance, pattern }
max_edit_distance: number
maximum1
minimum0
pattern: string
minLength1
max_time: optional string
min_time: optional string
query_id: number
query_tag: string
scan: boolean
updated: string

V2Matches

List saved query matches
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/matches
ModelsExpand Collapse
MatchGetResponse = object { matches, total }
matches: array of object { dismissed, domain, first_seen, 4 more }
dismissed: boolean
domain: string
first_seen: string
public_scans: object { submission_id }
submission_id: string
scan_status: string
scan_submission_id: number
source: string
total: number
minimum0

V2Logos

Insert logo query
POST/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
Delete logo query
DELETE/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}
Get logo queries
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries
ModelsExpand Collapse
LogoCreateResponse = object { message, success, query_id }
message: string
success: boolean
query_id: optional number
LogoDeleteResponse = object { message, success }
message: string
success: boolean
LogoGetResponse = array of object { id, r2_path, similarity_threshold, 4 more }
id: number
r2_path: string
similarity_threshold: number
tag: string
uploaded_at: string
content_type: optional string

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

image_data: optional string

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

V2Logo Matches

List logo matches
GET/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/matches
ModelsExpand Collapse
LogoMatchGetResponse = object { matches, total }
matches: array of object { id, matched_at, query_id, 5 more }
id: number
matched_at: string
query_id: number
similarity_score: number
url_scan_id: string
content_type: optional string
domain: optional string
image_data: optional string
total: number
minimum0