Skip to content

Track Document Usage

POST
/global-context/documents/{doc_id}/track-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.

Authorizations

Parameters

Path Parameters

doc_id
required

Global Context document ID.

string

Global Context document ID.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors the app handler’s query parameters field for field.

object
source_id
Any of:
string
<= 128 characters
source_type
Any of:
string
<= 64 characters
usage_type
required

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

string
Allowed values: creation citation

Responses

201

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string