Brand Protection

brand_protection

Methods

Create New URL Submissions -> { skipped_urls, submitted_urls }

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

Return new URL submissions

Read Submitted URLs By ID -> SinglePage<Record<string, unknown>>

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

Return submitted URLs based on ID

Domain types

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

Submit = { excluded_urls, skipped_urls, submitted_urls }

Brand Protection

Logo Matches

brand_protection.logo_matches

Methods

Read Matches For Logo Queries By ID -> { matches, total }

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

Return matches for logo queries based on ID

Download Matches For Logo Queries By ID -> { matches, total }

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

Return matches as CSV for logo queries based on ID

Brand Protection

Logos

brand_protection.logos

Methods

Create New Saved Logo Queries From Image Files -> { id, tag, upload_path }

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

Return new saved logo queries created from image files

Delete Saved Logo Queries By ID ->

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

Return a success message after deleting saved logo queries by ID

Brand Protection

Matches

brand_protection.matches

Methods

Read Matches For String Queries By ID -> { matches, total }

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

Return matches for string queries based on ID

Download Matches For String Queries By ID -> { matches, total }

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

Return matches as CSV for string queries based on ID

Brand Protection

Queries

brand_protection.queries

Methods

Create New Saved String Queries ->

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

Return a success message after creating new saved string queries

Delete Saved String Queries By ID ->

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

Return a success message after deleting saved string queries by ID

Create New Saved String Queries In Bulk ->

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

Return a success message after creating new saved string queries in bulk

Brand Protection

V2

brand_protection.v2

Brand Protection V2

Logo Matches

brand_protection.v2.logo_matches

Methods

List Logo Matches -> { matches, total }

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

Get paginated list of logo matches for a specific brand protection logo query

Brand Protection V2

Logos

brand_protection.v2.logos

Methods

Insert Logo Query -> { message, success, query_id }

post/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries

Create a new saved brand protection logo query for visual similarity matching

Delete Logo Query -> { message, success }

delete/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries/{query_id}

Delete a saved brand protection logo query. Returns 404 if the query ID doesn't exist.

Get Logo Queries -> Array<{ id, r2_path, similarity_threshold, 4 more... }>

get/accounts/{account_id}/cloudforce-one/v2/brand-protection/logo/queries

Get all saved brand protection logo queries for an account. Optionally specify id to get a single query. Set download=true to include base64-encoded image data.

Brand Protection V2

Matches

brand_protection.v2.matches

Methods

List Saved Query Matches -> { matches, total }

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

Get paginated list of domain matches for a specific brand protection query

Brand Protection V2

Queries

brand_protection.v2.queries

Methods

Get Queries -> Array<{ created, parameters, query_id, 3 more... }>

get/accounts/{account_id}/cloudforce-one/v2/brand-protection/domain/queries

Get all saved brand protection queries for an account