campaigns

Get campaign sequence

The campaign sequence (steps and branches) as configured in the editor. Branching steps expose their conditions — e.g. connected vs. not connected, invitation accepted vs. expired, replied vs. not replied. Use the format query parameter to choose the representation.

get/v1/campaigns/{id}/sequence

Request

  • Base URL: https://api.botdog.co
  • URL: https://api.botdog.co/v1/campaigns/{id}/sequence
  • Auth: API key in header x-api-key

Path parameters

idstring required

Query parameters

format'graph' | 'tree' | 'readable' | 'all'

Response shape: graph (default, faithful/lossless), tree (nested branches), readable (human outline), or all.

Response

The campaign sequence in the requested format

campaignIdstring required

The id of the campaign this sequence belongs to

editorViewType'SIMPLE' | 'ADVANCED' required

Which editor produced the campaign

source'workflow' | 'legacy' | 'empty' required

Where the sequence was read from: workflow (modern), legacy (old linear sequences), or empty (no sequence yet).

firstStepnumber nullable

Id of the first step to run, or null when there is no sequence

treeobject nullable

Present when format is tree or all. Nested step tree rooted at the first step; null for an empty sequence.

readablestring[]

Present when format is readable or all. One line per step/branch.

Example response

{
  "campaignId": "123e4567-e89b-12d3-a456-426614174000",
  "editorViewType": "ADVANCED",
  "source": "workflow",
  "firstStep": 1,
  "steps": [
    {
      "id": 2,
      "stepType": "WAIT_FOR_INVITATION_RESPONSE",
      "label": "Wait for invitation response",
      "next": 3,
      "choice": {
        "invitation_accepted": 3,
        "expired": null
      }
    }
  ],
  "readable": [
    "Step 1 · Send invitation (start)",
    "    → then step 2 (Wait for invitation response)"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.