Brand Protection

Create new URL submissions

POST/accounts/{account_id}/brand-protection/submit

Read submitted URLs by ID

GET/accounts/{account_id}/brand-protection/url-info

ModelsExpand Collapse

Info = object { categorizations, model_results, rule_matches, 4 more }

categorizations: optional array of object { category, verification_status }

List of categorizations applied to this submission.

category: optional string

Name of the category applied.

verification_status: optional string

Result of human review for this categorization.

model_results: optional array of object { model_name, model_score }

List of model results for completed scans.

model_name: optional string

Name of the model.

model_score: optional number

This is the score that is outputted by the model for this submission.

rule_matches: optional array of object { banning, blocking, description, name }

List of signatures that matched against site content found when crawling the URL.

banning: optional boolean

For internal use.

blocking: optional boolean

For internal use.

description: optional string

Description of the signature that matched.

name: optional string

Name of the signature that matched.

scan_status: optional object { last_processed, scan_complete, status_code, submission_id }

Status of the most recent scan found.

last_processed: optional string

Timestamp of when the submission was processed.

scan_complete: optional boolean

For internal use.

status_code: optional number

Status code that the crawler received when loading the submitted URL.

submission_id: optional number

ID of the most recent submission.

screenshot_download_signature: optional string

For internal use.

screenshot_path: optional string

For internal use.

url: optional string

URL that was submitted.

Submit = object { excluded_urls, skipped_urls, submitted_urls }

excluded_urls: optional array of object { url }

URLs that were excluded from scanning because their domain is in our no-scan list.

url: optional string

URL that was excluded.

skipped_urls: optional array of object { url, url_id }

URLs that were skipped because the same URL is currently being scanned.

url: optional string

URL that was skipped.

url_id: optional number

ID of the submission of that URL that is currently scanning.

submitted_urls: optional array of object { url, url_id }

URLs that were successfully submitted for scanning.

url: optional string

URL that was submitted.

url_id: optional number

ID assigned to this URL submission. Used to retrieve scanning results.

BrandProtectionSubmitResponse = object { skipped_urls, submitted_urls }

skipped_urls: optional array of map[unknown]

submitted_urls: optional array of map[unknown]

BrandProtectionURLInfoResponse = map[unknown]

Brand ProtectionQueries

Create new saved string queries

POST/accounts/{account_id}/brand-protection/queries

Delete saved string queries by ID

DELETE/accounts/{account_id}/brand-protection/queries

Create new saved string queries in bulk

POST/accounts/{account_id}/brand-protection/queries/bulk

Brand ProtectionMatches

Read matches for string queries by ID

GET/accounts/{account_id}/brand-protection/matches

Download matches for string queries by ID

GET/accounts/{account_id}/brand-protection/matches/download

ModelsExpand Collapse

MatchGetResponse = object { matches, total }

matches: optional array of map[unknown]

total: optional number

MatchDownloadResponse = object { matches, total }

matches: optional array of map[unknown]

total: optional number

Brand ProtectionLogos

Create new saved logo queries from image files

POST/accounts/{account_id}/brand-protection/logos

Delete saved logo queries by ID

DELETE/accounts/{account_id}/brand-protection/logos/{logo_id}

ModelsExpand Collapse

LogoCreateResponse = object { id, tag, upload_path }

id: optional number

tag: optional string

upload_path: optional string

Brand ProtectionLogo Matches

Read matches for logo queries by ID

GET/accounts/{account_id}/brand-protection/logo-matches

Download matches for logo queries by ID

GET/accounts/{account_id}/brand-protection/logo-matches/download

ModelsExpand Collapse

LogoMatchGetResponse = object { matches, total }

matches: optional array of map[unknown]

total: optional number

LogoMatchDownloadResponse = object { matches, total }

matches: optional array of map[unknown]

total: optional number

Brand ProtectionV2

Brand ProtectionV2Queries

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

Brand ProtectionV2Matches

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, 6 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

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

Brand ProtectionV2Logos

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)

Brand ProtectionV2Logo 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