GTM Context

Track Document Usage

Record one use of a Global Context document.

Feeds GET /global-context/documents/analytics. 404 if the document does not exist in the caller's organisation.

post/global-context/documents/{doc_id}/track-usage

Request

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

Path parameters

doc_idstring required

Global Context document ID.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

usage_type'creation' | 'citation' required

creation: the document was used to generate new content. citation: the document was quoted or referenced.

source_typestring nullable

Where the use happened, e.g. campaign, account, copilot, research. Free-form.

source_idstring nullable

ID of the entity that used the document, if any.

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.