Skip to main content
POST
Record a spreadsheet write checkpoint
Required scopes: client:write.

Authorizations

Authorization
string
header
required

A client session token obtained through the client authorisation challenge flow.

Headers

x-metrics-client-audience
enum<string>
required

The audience bound to the authorised client session.

Available options:
chatobserver-metrics-sheets,
chatobserver-metrics-excel
x-metrics-document-reference
string
required

The document reference hash bound to the client session.

Pattern: ^[a-f0-9]{64}$

Path Parameters

writeClaimId
string<uuid>
required

Resource identifier returned by the API.

Body

application/json
generation
integer
required
rowCount
integer
required
Required range: x <= 10000
batchNumber
integer
required
Required range: x >= 0
startRowOffset
integer
required
Required range: x >= 0
resultPageCursor
string
required
Required string length: 1 - 2048
batchChecksum
string
required
Pattern: ^[a-f0-9]{64}$
writtenRange
string
required
Required string length: 1 - 512

Response

Successful response.

data
object
required