Skip to main content
POST
Create a brand report

Authorizations

Authorization
string
header
required

Provide your API key as a Bearer token: Authorization: Bearer YOUR_API_KEY.

Body

application/json
workspaceId
string
required

Workspace to create the report in. The API key must have access to it.

Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

brandDomain
string
required

Brand website domain, e.g. acme.com. Protocol, www. and path are stripped.

Minimum string length: 1
promptIds
string[]
required

IDs of prompts that already exist in the report workspace — look them up with GET /v1/workspaces/{id}/prompts. The report tracks the countries of these prompts.

Required array length: 1 - 1000 elements
Required string length: 1 - 64
reportTitle
string

Optional. Report name shown in the app. Defaults to brand. Required when brandRegex is set.

Minimum string length: 1
brand
string

Brand name to track. Required unless brandRegex is set, in which case reportTitle is used as the brand label.

Minimum string length: 1
brandVariations
string[]

Optional. Other names the brand goes by, at most 100. Cannot be combined with brandRegex.

Maximum array length: 100
Minimum string length: 1
brandDomainVariations
string[]

Optional. Other domains the brand owns, at most 100. Each must differ from brandDomain.

Maximum array length: 100
Minimum string length: 1
brandDomainWildcard
boolean

Optional. When true, subdomains of brandDomain also count as the brand domain.

brandRegex
string | null

Optional. Regular expression used to detect the brand in AI answers, instead of the name and its variations (so it cannot be combined with brandVariations). Up to 1000 characters. Send null to clear it.

competitors
object[]

Optional. Competitors to track, at most 100. Each competitor domain must be unique. POST /v1/competitors/suggestions returns items in this shape.

Maximum array length: 100

Response

The created brand report.

id
string
required
Minimum string length: 1
Example:

"01HX7K2YV9D3M8N0G6Q5R4S3T2"

workspaceId
string
required
brand
string
required
brandDomain
string
required
brandRegex
string | null
required

Regular expression used to detect the brand in AI answers, instead of brand and brandVariations. null when not set.

countries
string[]
required

Lowercase ISO 3166-1 alpha-2 country codes the report tracks (e.g. us, de), with uk used in place of gb.

createdDate
string
required
updatedDate
string
required
reportTitle
string
brandVariations
string[]
brandDomainVariations
string[]
brandDomainWildcard
boolean
promptIds
string[]
countryPromptsTotal
object

Total prompt count keyed by country code (lowercase ISO 3166-1 alpha-2; uk instead of gb).

competitors
object[]
tags
object[]