Create a spreadsheet write claim

curl --request POST \
  --url https://app.chatobserver.com/api/v2/metrics/client/writes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-metrics-client-audience: <x-metrics-client-audience>' \
  --header 'x-metrics-document-reference: <x-metrics-document-reference>' \
  --data '
{
  "runId": "<string>",
  "clientBindingVersionId": "<string>",
  "clientBindingId": "<string>",
  "schemaFingerprint": "<string>",
  "expectedRowCount": 1
}
'

const options = {
  method: 'POST',
  headers: {
    'x-metrics-client-audience': '<x-metrics-client-audience>',
    'x-metrics-document-reference': '<x-metrics-document-reference>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    runId: '<string>',
    clientBindingVersionId: '<string>',
    clientBindingId: '<string>',
    schemaFingerprint: '<string>',
    expectedRowCount: 1
  })
};

fetch('https://app.chatobserver.com/api/v2/metrics/client/writes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.chatobserver.com/api/v2/metrics/client/writes"

payload = {
    "runId": "<string>",
    "clientBindingVersionId": "<string>",
    "clientBindingId": "<string>",
    "schemaFingerprint": "<string>",
    "expectedRowCount": 1
}
headers = {
    "x-metrics-client-audience": "<x-metrics-client-audience>",
    "x-metrics-document-reference": "<x-metrics-document-reference>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "<string>",
    "clientBindingId": "<string>",
    "clientBindingVersionId": "<string>",
    "runId": "<string>",
    "generation": 123,
    "status": "<string>",
    "nextRowOffset": 123,
    "rowsWritten": 123,
    "schemaFingerprint": "<string>",
    "outputChecksum": "<string>",
    "lastWrittenRange": "<string>",
    "expiresAt": "<string>",
    "committedAt": "<string>"
  },
  "replayed": false
}

{
  "data": {
    "id": "<string>",
    "clientBindingId": "<string>",
    "clientBindingVersionId": "<string>",
    "runId": "<string>",
    "generation": 123,
    "status": "<string>",
    "nextRowOffset": 123,
    "rowsWritten": 123,
    "schemaFingerprint": "<string>",
    "outputChecksum": "<string>",
    "lastWrittenRange": "<string>",
    "expiresAt": "<string>",
    "committedAt": "<string>"
  },
  "replayed": false
}

{
  "error": {
    "code": "internal",
    "fieldPath": [
      "<string>"
    ],
    "parameters": {},
    "repairActions": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": false,
    "retryAfterSeconds": 1
  }
}

POST

api

metrics

client

writes

Create a spreadsheet write claim

curl --request POST \
  --url https://app.chatobserver.com/api/v2/metrics/client/writes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-metrics-client-audience: <x-metrics-client-audience>' \
  --header 'x-metrics-document-reference: <x-metrics-document-reference>' \
  --data '
{
  "runId": "<string>",
  "clientBindingVersionId": "<string>",
  "clientBindingId": "<string>",
  "schemaFingerprint": "<string>",
  "expectedRowCount": 1
}
'

const options = {
  method: 'POST',
  headers: {
    'x-metrics-client-audience': '<x-metrics-client-audience>',
    'x-metrics-document-reference': '<x-metrics-document-reference>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    runId: '<string>',
    clientBindingVersionId: '<string>',
    clientBindingId: '<string>',
    schemaFingerprint: '<string>',
    expectedRowCount: 1
  })
};

fetch('https://app.chatobserver.com/api/v2/metrics/client/writes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.chatobserver.com/api/v2/metrics/client/writes"

payload = {
    "runId": "<string>",
    "clientBindingVersionId": "<string>",
    "clientBindingId": "<string>",
    "schemaFingerprint": "<string>",
    "expectedRowCount": 1
}
headers = {
    "x-metrics-client-audience": "<x-metrics-client-audience>",
    "x-metrics-document-reference": "<x-metrics-document-reference>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "<string>",
    "clientBindingId": "<string>",
    "clientBindingVersionId": "<string>",
    "runId": "<string>",
    "generation": 123,
    "status": "<string>",
    "nextRowOffset": 123,
    "rowsWritten": 123,
    "schemaFingerprint": "<string>",
    "outputChecksum": "<string>",
    "lastWrittenRange": "<string>",
    "expiresAt": "<string>",
    "committedAt": "<string>"
  },
  "replayed": false
}

{
  "data": {
    "id": "<string>",
    "clientBindingId": "<string>",
    "clientBindingVersionId": "<string>",
    "runId": "<string>",
    "generation": 123,
    "status": "<string>",
    "nextRowOffset": 123,
    "rowsWritten": 123,
    "schemaFingerprint": "<string>",
    "outputChecksum": "<string>",
    "lastWrittenRange": "<string>",
    "expiresAt": "<string>",
    "committedAt": "<string>"
  },
  "replayed": false
}

{
  "error": {
    "code": "internal",
    "fieldPath": [
      "<string>"
    ],
    "parameters": {},
    "repairActions": [
      "<string>"
    ],
    "requestId": "<string>",
    "retryable": false,
    "retryAfterSeconds": 1
  }
}

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}$

Idempotency-Key

string

required

Unique key for one logical command. Reuse it only when retrying the same request and payload.

Required string length: 16 - 160

Pattern: ^[A-Za-z0-9:_-]+$

Body

application/json

runId

string

required

clientBindingVersionId

string

required

clientBindingId

string

required

schemaFingerprint

string

required

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

expectedRowCount

null | integer

required

Required range: x >= 0

Response

Successful response.

data

object

required

Show child attributes

replayed

required

Integration guides

Endpoint reference

Create a spreadsheet write claim

Authorizations

Headers

Body

Response