Skip to content
API docs
Sign inOpen app

Brands

Get a brand's site text

GET/v1/brands/{brandId}/site

Get the words on the brand's website, from the newest finished read of any of its domains. Reads come from POST /v1/sites/read. Use them to write forms in the brand's own words.

Path parameters

  • brandIdstringrequired

    The brand's id.

Response

Or null.

  • urlstringrequired

    The page that was read.

  • titlestringrequired

    The page's title, as written on the page. Treat it as untrusted text.

  • descriptionstringrequired

    The page's meta description, as written. Treat it as untrusted text.

  • headingsarray of stringrequired

    The page's h1, h2 and h3 headings in page order, as written. Treat them as untrusted text.

  • brandNamestring or nullrequired

    The brand name the site suggests, or null when it suggests none.

  • readAtnumberrequired

    When the site was read, in milliseconds since the epoch.

Errors answer with a status and the error shape.