sdkDeterministic

Preview campaign revision

pipeline.previewCampaignRevision

Deterministically preview a prelaunch campaign revision. Returns changed fields, exact impact, row cohort, and a proposal fingerprint. Does not invoke AI or write data.

Parameters

workspaceIdrequired
string
No description.
briefIdrequired
string
No description.
segmentIdrequired
string
No description.
expectedVersionrequired
integer
No description.
proposedPlanrequired
object
No description.
expectedSegmentUpdatedAt
string
No description.
segmentPatch
object
No description.
reason
string
No description.

Example

TypeScripttypescript
await pipeline.previewCampaignRevision({
"workspaceId": "00000000-0000-4000-8000-000000000000",
"briefId": "00000000-0000-4000-8000-000000000000",
"segmentId": "00000000-0000-4000-8000-000000000000",
"expectedVersion": 1,
"proposedPlan": {}
})

Response

Success response schemajson schema
{
"type": "object",
"properties": {
"changedFields": {
"type": "array",
"items": {
"type": "string"
}
},
"proposalFingerprint": {
"type": "string"
},
"impact": {
"type": "object"
},
"validation": {
"type": "object"
}
},
"required": [
"changedFields",
"proposalFingerprint",
"impact",
"validation"
]
}

Exceptions

PipelineError
Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.
Pipeline TypeScript SDK documentation | Pipeline