GTM Context

Extract Company Data

Pull company facts out of scraped intelligence data.

SPENDS CREDITS when enrich is true (the default): the route is credit-gated before the model call and answers 402 when the balance is short. Send enrich=false for the scrape-derived fields alone, which costs nothing extra.

The app takes an untyped body here; this contract types it, so a missing website_url is a 422 naming the field rather than a 400 describing it.

post/global-context/extract-company-data

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/global-context/extract-company-data
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

website_urlstring required

Company website to extract from. Intelligence data for it must already exist.

enrichboolean

Enrich the extracted fields through Apollo. SPENDS CREDITS - the call is credit-gated and answers 402 when the balance is short.

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.