sdkDeterministic

Preview campaign source

pipeline.previewCampaignSource

Persist the exact campaign-bound sourcing preview before pilot rows are written. Accepts at most 10 rows plus the claimed work order, active brief version, provider, resolved filters, and verified result ceiling. Returns an immutable sourcingPreviewId required by the pilot add-table-rows call.

Parameters

workspaceId
string
Optional with API key auth, inferred from the key.
claimTokenrequired
string
No description.
workOrderIdrequired
string
No description.
briefIdrequired
string
No description.
briefVersionrequired
integer
No description.
sourceScoperequired
string
No description.
providerrequired
string
No description.
accountId
string
No description.
resolvedFiltersrequired
object
No description.
requestedLimit
integer
No description.
availableCount
integer
No description.
rowsrequired
object[]
No description.
rejectedRows
object[]
No description.

Example

TypeScripttypescript
await pipeline.previewCampaignSource({
"claimToken": "example",
"workOrderId": "00000000-0000-4000-8000-000000000000",
"briefId": "00000000-0000-4000-8000-000000000000",
"briefVersion": 1,
"sourceScope": "example",
"provider": "example",
"resolvedFilters": {},
"rows": [
{
"data": {}
}
]
})

Response

Success response schemajson schema
{
"type": "object",
"properties": {
"sourcingPreviewId": {
"type": "string",
"format": "uuid"
},
"preview": {
"type": "object"
},
"verifiedCeiling": {
"type": "number"
}
},
"required": [
"sourcingPreviewId",
"preview",
"verifiedCeiling"
]
}

Exceptions

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