Begin exact private native authoring

curl --request POST \
  --url https://app.chatobserver.com/api/v2/reports/{reportId}/change-sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "authoringSchemaVersion": 2,
  "nativeDocumentVersion": 4,
  "expectedRevision": 1,
  "expectedDocumentHash": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'x-workspace-id': '<x-workspace-id>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    authoringSchemaVersion: 2,
    nativeDocumentVersion: 4,
    expectedRevision: 1,
    expectedDocumentHash: '<string>'
  })
};

fetch('https://app.chatobserver.com/api/v2/reports/{reportId}/change-sets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.chatobserver.com/api/v2/reports/{reportId}/change-sets"

payload = {
    "authoringSchemaVersion": 2,
    "nativeDocumentVersion": 4,
    "expectedRevision": 1,
    "expectedDocumentHash": "<string>"
}
headers = {
    "x-workspace-id": "<x-workspace-id>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "version": 2,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nativeDocumentVersion": 4,
    "base": {
      "revision": 1,
      "documentHash": "<string>"
    },
    "state": "open",
    "cumulativeHash": "<unknown>",
    "sealedHash": "<unknown>",
    "acceptedSequence": 128,
    "operationCount": 4096,
    "inputBytes": 16777216,
    "expiresAt": "2023-11-07T05:31:56Z",
    "receipts": [
      {
        "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sequence": 123,
        "requestHash": "<unknown>",
        "cumulativeHash": "<unknown>",
        "operationCount": 123,
        "inputBytes": 123
      }
    ],
    "commitReceipt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "documentHash": "<unknown>"
    }
  },
  "replayed": true,
  "receipt": "<unknown>"
}

{
  "data": {
    "version": 2,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nativeDocumentVersion": 4,
    "base": {
      "revision": 1,
      "documentHash": "<string>"
    },
    "state": "open",
    "cumulativeHash": "<unknown>",
    "sealedHash": "<unknown>",
    "acceptedSequence": 128,
    "operationCount": 4096,
    "inputBytes": 16777216,
    "expiresAt": "2023-11-07T05:31:56Z",
    "receipts": [
      {
        "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sequence": 123,
        "requestHash": "<unknown>",
        "cumulativeHash": "<unknown>",
        "operationCount": 123,
        "inputBytes": 123
      }
    ],
    "commitReceipt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "documentHash": "<unknown>"
    }
  },
  "replayed": true,
  "receipt": "<unknown>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "requestId": "<string>"
}

Reports

Begin exact private native authoring

Requires delegated reports:write consent, current native report edit permission and workspace authoring availability. Workspace service keys are unsupported. These private stages never alter the saved report, run Data, publish a share or certify rendered layout. Requests stream at most 512 KiB. Stages retain at most 256 batches, 8192 operations and 32 MiB for 24 hours. Create binds its UUID retry key to the exact base. Append binds the batch ID, sequence and confirmed cumulative hash to the entire typed command. Seal and discard are functionally idempotent at the exact cumulative hash. Sealed means validated native configuration and references; measured composition and commit are separate.

POST

api

reports

{reportId}

change-sets

Begin exact private native authoring

curl --request POST \
  --url https://app.chatobserver.com/api/v2/reports/{reportId}/change-sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "authoringSchemaVersion": 2,
  "nativeDocumentVersion": 4,
  "expectedRevision": 1,
  "expectedDocumentHash": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {
    'x-workspace-id': '<x-workspace-id>',
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    authoringSchemaVersion: 2,
    nativeDocumentVersion: 4,
    expectedRevision: 1,
    expectedDocumentHash: '<string>'
  })
};

fetch('https://app.chatobserver.com/api/v2/reports/{reportId}/change-sets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.chatobserver.com/api/v2/reports/{reportId}/change-sets"

payload = {
    "authoringSchemaVersion": 2,
    "nativeDocumentVersion": 4,
    "expectedRevision": 1,
    "expectedDocumentHash": "<string>"
}
headers = {
    "x-workspace-id": "<x-workspace-id>",
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "data": {
    "version": 2,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nativeDocumentVersion": 4,
    "base": {
      "revision": 1,
      "documentHash": "<string>"
    },
    "state": "open",
    "cumulativeHash": "<unknown>",
    "sealedHash": "<unknown>",
    "acceptedSequence": 128,
    "operationCount": 4096,
    "inputBytes": 16777216,
    "expiresAt": "2023-11-07T05:31:56Z",
    "receipts": [
      {
        "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sequence": 123,
        "requestHash": "<unknown>",
        "cumulativeHash": "<unknown>",
        "operationCount": 123,
        "inputBytes": 123
      }
    ],
    "commitReceipt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "documentHash": "<unknown>"
    }
  },
  "replayed": true,
  "receipt": "<unknown>"
}

{
  "data": {
    "version": 2,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "nativeDocumentVersion": 4,
    "base": {
      "revision": 1,
      "documentHash": "<string>"
    },
    "state": "open",
    "cumulativeHash": "<unknown>",
    "sealedHash": "<unknown>",
    "acceptedSequence": 128,
    "operationCount": 4096,
    "inputBytes": 16777216,
    "expiresAt": "2023-11-07T05:31:56Z",
    "receipts": [
      {
        "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sequence": 123,
        "requestHash": "<unknown>",
        "cumulativeHash": "<unknown>",
        "operationCount": 123,
        "inputBytes": 123
      }
    ],
    "commitReceipt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revision": 1,
      "documentHash": "<unknown>"
    }
  },
  "replayed": true,
  "receipt": "<unknown>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  },
  "requestId": "<string>"
}

Required scopes: reports:write.

Authorizations

Authorization

string

header

required

Delegated application credential issued after Chatobserver account consent. Restricted to selected workspaces and explicitly supported MCP operations. The MCP server access token is a separate credential and cannot be used here.

Headers

x-workspace-id

string

required

Explicit workspace selected for the delegated account.

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

Idempotency-Key

string<uuid>

required

Path Parameters

reportId

string<uuid>

required

Body

application/json

authoringSchemaVersion

number

required

nativeDocumentVersion

number

required

expectedRevision

integer

required

Required range: x >= 0

expectedDocumentHash

string

required

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

Response

Confirmed private stage or identical retry.

data

object

required

Show child attributes

replayed

boolean

receipt

any

Integration guides

Endpoint reference

Begin exact private native authoring

Authorizations

Headers

Path Parameters

Body

Response