API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Brand Protection

Create new URL submissions

client.BrandProtection.Submit(ctx, body) (*BrandProtectionSubmitResponse, error)

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

Read submitted URLs by ID

client.BrandProtection.URLInfo(ctx, query) (*SinglePage[BrandProtectionURLInfoResponse], error)

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

ModelsExpand Collapse

type Info struct{…}

Categorizations []InfoCategorizationoptional

List of categorizations applied to this submission.

Category stringoptional

Name of the category applied.

VerificationStatus stringoptional

Result of human review for this categorization.

ModelResults []InfoModelResultoptional

List of model results for completed scans.

ModelName stringoptional

Name of the model.

ModelScore float64optional

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

RuleMatches []InfoRuleMatchoptional

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

Banning booloptional

For internal use.

Blocking booloptional

For internal use.

Description stringoptional

Description of the signature that matched.

Name stringoptional

Name of the signature that matched.

ScanStatus InfoScanStatusoptional

Status of the most recent scan found.

LastProcessed stringoptional

Timestamp of when the submission was processed.

ScanComplete booloptional

For internal use.

StatusCode int64optional

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

SubmissionID int64optional

ID of the most recent submission.

ScreenshotDownloadSignature stringoptional

For internal use.

ScreenshotPath stringoptional

For internal use.

URL stringoptional

URL that was submitted.

type Submit struct{…}

ExcludedURLs []SubmitExcludedURLoptional

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

URL stringoptional

URL that was excluded.

SkippedURLs []SubmitSkippedURLoptional

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

URL stringoptional

URL that was skipped.

URLID int64optional

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

SubmittedURLs []SubmitSubmittedURLoptional

URLs that were successfully submitted for scanning.

URL stringoptional

URL that was submitted.

URLID int64optional

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

Brand ProtectionQueries

Create new saved string queries

client.BrandProtection.Queries.New(ctx, params) error

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

Delete saved string queries by ID

client.BrandProtection.Queries.Delete(ctx, params) error

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

Create new saved string queries in bulk

client.BrandProtection.Queries.Bulk(ctx, params) error

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

Brand ProtectionMatches

Read matches for string queries by ID

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

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

Download matches for string queries by ID

client.BrandProtection.Matches.Download(ctx, params) (*MatchDownloadResponse, error)

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

Brand ProtectionLogos

Create new saved logo queries from image files

client.BrandProtection.Logos.New(ctx, params) (*LogoNewResponse, error)

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

Delete saved logo queries by ID

client.BrandProtection.Logos.Delete(ctx, logoID, body) error

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

Brand ProtectionLogo Matches

Read matches for logo queries by ID

client.BrandProtection.LogoMatches.Get(ctx, params) (*LogoMatchGetResponse, error)

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

Download matches for logo queries by ID

client.BrandProtection.LogoMatches.Download(ctx, params) (*LogoMatchDownloadResponse, error)

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

Brand ProtectionV2

Brand ProtectionV2Queries

Get queries

client.BrandProtection.V2.Queries.Get(ctx, params) (*[]V2QueryGetResponse, error)

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

Brand ProtectionV2Matches

List saved query matches

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

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

Brand ProtectionV2Logos

Insert logo query

client.BrandProtection.V2.Logos.New(ctx, params) (*V2LogoNewResponse, error)

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

Delete logo query

client.BrandProtection.V2.Logos.Delete(ctx, queryID, body) (*V2LogoDeleteResponse, error)

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

Get logo queries

client.BrandProtection.V2.Logos.Get(ctx, params) (*[]V2LogoGetResponse, error)

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

Brand ProtectionV2Logo Matches

List logo matches

client.BrandProtection.V2.LogoMatches.Get(ctx, params) (*V2LogoMatchGetResponse, error)

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