Skip to content

Get Documents Analytics

GET
/global-context/documents/analytics

Every document with its usage counts.

Declared before /documents/{doc_id}: the parameter route would otherwise match first and try to load a document called “analytics”.

The answer to “which Studio documents are actually being read” - the input to deciding what to regenerate and what to delete.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

A handler that returns [...] and one that returns {"documents": [...]} both land on items, and the named key is preserved beside it so a caller reading the app’s own spelling is not broken by the normalisation.

object
items
Array
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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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