List document attribution ranges | API reference

Description

Pages a document's complete edit attribution when the compact attribution response is truncated. Requires read access. A cursor or expected revision from before a later write returns 409, and the client restarts from the first page.

Authentication

Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.

Parameters

Name	In	Type	Details
`documentId`	path	string	required
`cursor`	query	string	optional
`expectedRevision`	query	integer	optional at least 0
`limit`	query	integer	optional 1 to 500
`accept-encoding`	header	string	optional

Responses

200 OK

application/jsonListDocumentEditAttributionRangesResponse

One page of a document's complete edit attribution.

object
5 fields
- attributionRevisionintegerrequired
  - at least 0
- documentIdstringrequired
  - not empty
- itemslist of DocumentEditAttributionRangeResponserequired
  - at most 500 items
- hasMorebooleanrequired
  - always true
- nextCursorstringrequired
  - not empty
Other fields are allowed.
object
5 fields
- attributionRevisionintegerrequired
  - at least 0
- documentIdstringrequired
  - not empty
- itemslist of DocumentEditAttributionRangeResponserequired
  - at most 500 items
- hasMorebooleanrequired
  - always false
- nextCursornullrequired
Other fields are allowed.

Response headers

Name	Type	Details
`cache-control`	string	required always `private, no-cache`
`content-encoding`	string	optional
`content-type`	string	required not empty
`vary`	string	required pattern `(?:^\|,)\s(?:[Aa][Cc][Cc][Ee][Pp][Tt]-[Ee][Nn][Cc][Oo][Dd][Ii][Nn][Gg]\|\)\s*(?:,\|$)`

Other responses

Status	Meaning	Body
400	Bad Request	`application/json`ErrorResponse
401	Unauthorized	`application/json`SessionFailureResponse
403	Forbidden	`application/json`ErrorResponse
404	Not Found	`application/json`ErrorResponse
409	Conflict	`application/json`ErrorResponse
500	Internal Server Error	`application/json`ErrorResponse
503	Service Unavailable	`application/json`ErrorResponse

Additional rules

The server also enforces these rules, which the schema above cannot express.

Document attribution segment start counters are less than end counters.