Company Intelligence

Get Brand Suggestions

The other websites the company links to from its homepage nav, header or footer. No credits.

Only for the organisation's own website (or any website before one is set); 400 otherwise, 429 when asked too often. An empty candidates list on any fetch failure, so it never blocks setup.

post/intelligence/brand-suggestions

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/intelligence/brand-suggestions
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

website_urlstring required

Response

Successful Response

dataStudioPayload required

An open envelope for one settings block, document or brand artefact.

OPEN on purpose. These surfaces are configuration and generated content, and both grow: a new toggle on a settings block or a new field on a generated document must reach a caller on the day it ships, not on the day somebody remembers to widen a mirror. A closed response model here would silently DROP the new key, which reads to the caller as "the product does not have that setting".

The request side is the opposite and is mirrored exactly - see the module docstring for why the asymmetry is deliberate.

Changes

No recorded changes to this operation across all 2 revisions of this API.