Compose a sealed native change set

curl --request POST \
  --url https://app.chatobserver.com/api/v2/reports/canvas/compositions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "locale": "<string>",
  "timezone": "<string>",
  "scenarioId": "saved-defaults",
  "allowPageGrowth": true,
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sealedStageHash": "<string>",
  "expectedRevision": 1,
  "expectedDocumentHash": "<unknown>",
  "dataPolicy": "require_existing_output"
}
'

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({
    locale: '<string>',
    timezone: '<string>',
    scenarioId: 'saved-defaults',
    allowPageGrowth: true,
    reportId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    changeSetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sealedStageHash: '<string>',
    expectedRevision: 1,
    expectedDocumentHash: '<unknown>',
    dataPolicy: 'require_existing_output'
  })
};

fetch('https://app.chatobserver.com/api/v2/reports/canvas/compositions', 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/canvas/compositions"

payload = {
    "locale": "<string>",
    "timezone": "<string>",
    "scenarioId": "saved-defaults",
    "allowPageGrowth": True,
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sealedStageHash": "<string>",
    "expectedRevision": 1,
    "expectedDocumentHash": "<unknown>",
    "dataPolicy": "require_existing_output"
}
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": 1,
    "kind": "composition",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "failureCode": "access_revoked",
    "progress": {
      "acceptedMeasurements": 1792
    },
    "plan": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planHash": "<string>",
      "documentHash": "<unknown>"
    }
  },
  "replayed": true
}

{
  "data": {
    "version": 1,
    "kind": "composition",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "failureCode": "access_revoked",
    "progress": {
      "acceptedMeasurements": 1792
    },
    "plan": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planHash": "<string>",
      "documentHash": "<unknown>"
    }
  },
  "replayed": true
}

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

Reports

Compose a sealed native change set

Requires delegated reports:write consent, current native edit permission and workspace authoring availability. Data is independently authorized: composition consumes readable pinned outputs and never executes providers. A sealed stage is composed and measured in its declared fixed or responsive mode; the saved report changes only through atomic measured-plan commit. Read all finding pages and explicitly acknowledge required advisories. Creation streams at most 16 KiB; commit streams at most 32 MiB. Current-input checks and exact revision/hash guards reject moved inputs without rebasing. Identical commit retries return the original receipt after later edits or temporary-plan cleanup. Publication is separate. Workspace service keys are unsupported.

POST

api

reports

canvas

compositions

Compose a sealed native change set

curl --request POST \
  --url https://app.chatobserver.com/api/v2/reports/canvas/compositions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "locale": "<string>",
  "timezone": "<string>",
  "scenarioId": "saved-defaults",
  "allowPageGrowth": true,
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sealedStageHash": "<string>",
  "expectedRevision": 1,
  "expectedDocumentHash": "<unknown>",
  "dataPolicy": "require_existing_output"
}
'

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({
    locale: '<string>',
    timezone: '<string>',
    scenarioId: 'saved-defaults',
    allowPageGrowth: true,
    reportId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    changeSetId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sealedStageHash: '<string>',
    expectedRevision: 1,
    expectedDocumentHash: '<unknown>',
    dataPolicy: 'require_existing_output'
  })
};

fetch('https://app.chatobserver.com/api/v2/reports/canvas/compositions', 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/canvas/compositions"

payload = {
    "locale": "<string>",
    "timezone": "<string>",
    "scenarioId": "saved-defaults",
    "allowPageGrowth": True,
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sealedStageHash": "<string>",
    "expectedRevision": 1,
    "expectedDocumentHash": "<unknown>",
    "dataPolicy": "require_existing_output"
}
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": 1,
    "kind": "composition",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "failureCode": "access_revoked",
    "progress": {
      "acceptedMeasurements": 1792
    },
    "plan": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planHash": "<string>",
      "documentHash": "<unknown>"
    }
  },
  "replayed": true
}

{
  "data": {
    "version": 1,
    "kind": "composition",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "changeSetId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "queued",
    "createdAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "failureCode": "access_revoked",
    "progress": {
      "acceptedMeasurements": 1792
    },
    "plan": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planHash": "<string>",
      "documentHash": "<unknown>"
    }
  },
  "replayed": true
}

{
  "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

Body

application/json

profileId

enum<string>

required

Available options:

report-standard-v1,

report-accessible-v1

placementPolicy

enum<string>

required

Available options:

compose,

preserve

locale

string

required

Required string length: 1 - 128

timezone

string

required

Required string length: 1 - 128

scenarioId

string

required

Allowed value: "saved-defaults"

allowPageGrowth

boolean

required

reportId

string<uuid>

required

changeSetId

string<uuid>

required

sealedStageHash

string

required

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

expectedRevision

integer

required

Required range: x >= 0

expectedDocumentHash

any

required

targetMode

enum<string>

required

Available options:

fixed,

responsive

dataPolicy

string

required

Allowed value: "require_existing_output"

Response

Plan, committed receipt or identical creation retry.

data

object

required

Show child attributes

replayed

boolean

Integration guides

Endpoint reference

Compose a sealed native change set

Authorizations

Headers

Body

Response