Create a native report share

curl --request POST \
  --url https://app.chatobserver.com/api/v2/reports/{reportId}/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "expectedRevision": 1,
  "expectedDocumentHash": "<string>",
  "title": "<string>",
  "accessMode": "unlisted",
  "password": "<string>",
  "allowedUserIds": [
    123
  ],
  "allowedPageIds": [
    "<string>"
  ],
  "initialPageId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "allowDownloadData": false,
  "allowCopyReport": false,
  "allowExternalLinks": true,
  "watermarkEnabled": true,
  "branding": "chatobserver"
}
'

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({
    expectedRevision: 1,
    expectedDocumentHash: '<string>',
    title: '<string>',
    accessMode: 'unlisted',
    password: '<string>',
    allowedUserIds: [123],
    allowedPageIds: ['<string>'],
    initialPageId: '<string>',
    expiresAt: '2023-11-07T05:31:56Z',
    allowDownloadData: false,
    allowCopyReport: false,
    allowExternalLinks: true,
    watermarkEnabled: true,
    branding: 'chatobserver'
  })
};

fetch('https://app.chatobserver.com/api/v2/reports/{reportId}/shares', 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}/shares"

payload = {
    "expectedRevision": 1,
    "expectedDocumentHash": "<string>",
    "title": "<string>",
    "accessMode": "unlisted",
    "password": "<string>",
    "allowedUserIds": [123],
    "allowedPageIds": ["<string>"],
    "initialPageId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "allowDownloadData": False,
    "allowCopyReport": False,
    "allowExternalLinks": True,
    "watermarkEnabled": True,
    "branding": "chatobserver"
}
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": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "accessMode": "unlisted",
    "artifactVersion": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "revoked": true
  },
  "replayed": true
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "accessMode": "unlisted",
    "artifactVersion": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "revoked": true
  },
  "replayed": true
}

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

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

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

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

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

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

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

Reports

Create a native report share

Publish the exact saved report identity through the native shared report pipeline. Delegated user OAuth only; requires reports:publish, native publish permission and independent Data access. UUID retries preserve one atomic publication and do not publish later edits. An unlisted link is available to anyone who has it. Snapshot delivery; no Data execution or PDF generation. Requires a delegated MCP user connection; workspace API keys cannot impersonate a publishing user.

POST

api

reports

{reportId}

Create a native report share

curl --request POST \
  --url https://app.chatobserver.com/api/v2/reports/{reportId}/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "expectedRevision": 1,
  "expectedDocumentHash": "<string>",
  "title": "<string>",
  "accessMode": "unlisted",
  "password": "<string>",
  "allowedUserIds": [
    123
  ],
  "allowedPageIds": [
    "<string>"
  ],
  "initialPageId": "<string>",
  "expiresAt": "2023-11-07T05:31:56Z",
  "allowDownloadData": false,
  "allowCopyReport": false,
  "allowExternalLinks": true,
  "watermarkEnabled": true,
  "branding": "chatobserver"
}
'

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({
    expectedRevision: 1,
    expectedDocumentHash: '<string>',
    title: '<string>',
    accessMode: 'unlisted',
    password: '<string>',
    allowedUserIds: [123],
    allowedPageIds: ['<string>'],
    initialPageId: '<string>',
    expiresAt: '2023-11-07T05:31:56Z',
    allowDownloadData: false,
    allowCopyReport: false,
    allowExternalLinks: true,
    watermarkEnabled: true,
    branding: 'chatobserver'
  })
};

fetch('https://app.chatobserver.com/api/v2/reports/{reportId}/shares', 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}/shares"

payload = {
    "expectedRevision": 1,
    "expectedDocumentHash": "<string>",
    "title": "<string>",
    "accessMode": "unlisted",
    "password": "<string>",
    "allowedUserIds": [123],
    "allowedPageIds": ["<string>"],
    "initialPageId": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "allowDownloadData": False,
    "allowCopyReport": False,
    "allowExternalLinks": True,
    "watermarkEnabled": True,
    "branding": "chatobserver"
}
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": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "accessMode": "unlisted",
    "artifactVersion": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "revoked": true
  },
  "replayed": true
}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "accessMode": "unlisted",
    "artifactVersion": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "revoked": true
  },
  "replayed": true
}

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

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

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

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

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

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

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

Required scopes: reports:publish.

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

expectedRevision

integer

required

Required range: x >= 0

expectedDocumentHash

string

required

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

title

string

Maximum string length: 160

accessMode

enum<string>

default:unlisted

Available options:

unlisted,

workspace_sign_in,

authenticated_allowlist,

password

password

string

Required string length: 10 - 128

allowedUserIds

integer[]

Maximum array length: 250

allowedPageIds

string[]

Maximum array length: 100

Required string length: 1 - 256

initialPageId

string

Required string length: 1 - 256

expiresAt

string<date-time> | null

allowDownloadData

boolean

default:false

allowCopyReport

boolean

default:false

allowExternalLinks

boolean

default:true

watermarkEnabled

boolean

default:true

branding

enum<string>

default:chatobserver

Available options:

chatobserver,

workspace_allowed

Response

Native report share.

data

object

required

Show child attributes

replayed

boolean

Integration guides

Endpoint reference

Create a native report share

Authorizations

Headers

Path Parameters

Body

Response