GTM Context

Submit Document Feedback

Thumbs up or down on a document.

usage_id attaches the feedback to a specific USE of the document rather than to the document itself, which is what makes "this answer was wrong" distinguishable from "this document is wrong".

post/global-context/documents/{doc_id}/feedback

Request

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

Path parameters

doc_idstring required

Document id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

feedback_type'up' | 'down' required

Thumbs up or thumbs down on the document.

usage_idstring nullable

The usage record this feedback is about, when the feedback follows a specific use of the document rather than the document itself.

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.