GTM Context

Get Global Context Document

One document, with its full content.

GET /global-context/documents lists them; this returns a single one by id or by type key.

get/global-context/documents/{doc_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/global-context/documents/{doc_id}
  • Auth: HTTP bearer

Path parameters

doc_idstring required

Document id, OR a document TYPE key. The app resolves either, which is what makes company_profile a usable id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

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.