Brand demand#

Track estimated branded-search demand, competitor Share of Search, and optional first-party Google Search Console observations.

Authentication required

All endpoints require a Bearer token in the Authorization header. See the Authentication guide for setup instructions.

GET /v1/brand-demand/config#

Fetch the organization Brand Demand configuration, including own brand, competitors, exact terms, markets, review state, and Search Console status.

bash

GET /v1/brand-demand/config?organization_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.

Response#

Returns { data, _meta } with the result.

PUT /v1/brand-demand/config#

Update the active Brand Demand own brand, competitors, exact terms, and markets by replacing the configuration. Owners only.

Owner only

bash

PUT /v1/brand-demand/config
Authorization: Bearer {token}
Content-Type: application/json

{
  "organization_id": "1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01",
  "own_brand": "...",
  "competitors": "...",
  "markets": "..."
}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
ownBrand	`object`	Required
competitors	`Array<object>`	Required
markets	`Array<object>`	Required

Response#

Returns { data, _meta } with the result.

GET /v1/brand-demand/report#

Fetch 12 complete months of estimated branded-search demand and Share of Search for one market, with optional observed Search Console metrics reported separately.

bash

GET /v1/brand-demand/report?organization_id=1c7743a8-6410-4a9e-9f3b-2c1d5e8a4b01
Authorization: Bearer {token}

Parameters#

Name	Type	Required	Description
organizationId	`string (UUID)`	Required	Organization identifier.
marketId	`string (UUID)`	—	Unique identifier (UUID v4).

Response#

Returns { data, _meta } with the result.