Analytics / TypeScript SDK

Compare campaigns

Compare execution stats (total/completed/failed/completionRate) across 2-10 campaigns side-by-side.

pipeline.compareCampaignsDeterministic operation

Parameters

workspaceIdOptional · string
Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
campaignIdsRequired · array
2-10 campaign IDs to compare.
Request example
await pipeline.compareCampaigns({
  "campaignIds": [
    "00000000-0000-4000-8000-000000000001",
    "00000000-0000-4000-8000-000000000002"
  ]
})
Full input schema
Input schema
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "campaignIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 2,
      "maxItems": 10,
      "description": "2-10 campaign IDs to compare."
    }
  },
  "required": [
    "campaignIds"
  ]
}
See this operation inCLI MCP REST API
TypeScript SDK | Pipeline v2 preview