Share Report

post/extensions/roboledger/{graph_id}/operations/share-report

Pushes a published report to every member of the target publish list. Each share is an independent copy: the report row + all its facts are cloned into the recipient's tenant schema with source_graph_id / source_report_id provenance fields populated. Per-target outcomes (success or error) surface in the response — share does not fail-fast across targets. Recipients that have blocked this graph come back as an error for that target; withdraw a delivered copy with revoke-report-share.

Idempotency: supply an Idempotency-Key header to make safe retries; replays within 24 hours return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`graph_id`required	string	Graph Id

Header parameters

Name	Type	Description
`Idempotency-Key`optional	string	Idempotency-Key

Request body

Required, application/json.

Field	Type	Description
`publish_list_id`required	string	Publish list whose members will receive the report. Created via `create-publish-list`.
`report_id`required	string	The published Report to share.

Example request

curl

curl -X POST "https://api.robosystems.ai/extensions/roboledger/{graph_id}/operations/share-report" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Idempotency-Key: <Idempotency-Key>" \
  -H "Content-Type: application/json" \
  -d '{
  "publish_list_id": "pl_01HVF8T0M2YTAY3BBNRH0V0",
  "report_id": "rpt_01HVF8T0M2YTAY3BBNRH0V0"
}'

Responses

200 Successful Response

Field Type Description

operationrequired

string

Kebab-case operation name

operationIdrequired

string

op_-prefixed ULID for audit and SSE correlation

statusrequired

string

Operation lifecycle state

One of: completed, pending, failed

resultoptional

ShareReportResponse

Command-specific result payload

ShareReportResponse fields

Field Type Description

report_idrequired

string

The report that was shared.

resultsrequired

ShareResultItem[]

Per-recipient outcomes. Inspect to find partial failures — the share operation does not fail-fast across targets.

ShareResultItem fields

Field	Type	Description
`target_graph_id`required	string	Recipient graph ID (a publish-list member).
`status`required	string	`shared` when the copy succeeded; `error` when this target failed (other targets may still have succeeded).
`error`optional	string	Error message when `status='error'`, else null.
`fact_count`optional	integer	Number of facts copied into the target on success. Default: `0`

atrequired

string

ISO-8601 UTC timestamp

createdByoptional

string

User ID that initiated the operation (null for legacy callers)

idempotentReplayoptional

boolean

True when this envelope came from the idempotency cache — the underlying command did not execute again. False on fresh executions.

Default: false

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
409	Idempotency-Key conflict — key reused with different body
422	Validation error
429	Rate limit exceeded
500	Internal server error