Flow definitions

Sitecore API catalog/Agent API/Flow definitions

Flow definitions

The Flow definitions API lets you retrieve flow definitions (A/B/n tests and personalizations) for a specific page, configure their variants, and access detailed information about each variant.

Operations

List flow definitions for a page

Request

Retrieves all flow definitions (both A/B/n tests and personalizations) for a specific page, including the structure, variants, and configuration details.

Security

HTTPBearer

Path

pageIdstring, (uuid)(Pageid)required

The unique identifier of the page for which to retrieve flow definitions (A/B/n tests or personalizations). To get this ID, you can use the List pages of a site endpoint to retrieve the list of pages for a specific site.

Example:3f2504e0-4f89-11d3-9a0c-0305e82c3301

Query

languagestring(Language)

The language version of the page to filter flow definitions (A/B/n tests or personalizations).

Default:"en"

Example:language=en

statusstring(Status)

The status to filter flow definitions (A/B/n tests or personalizations), such as active, paused, or draft.

Example:status=active

x-sc-job-idany(X-Sc-Job-Id)

A unique identifier for the job, used to trace, audit, and revert actions performed by an AI agent through the Agent API.

Example:job-1234

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/stream/ai-agent-api/api/v1/flows/by-page/3f2504e0-4f89-11d3-9a0c-0305e82c3301?language=en&status=active' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-job-id: job-1234'

Responses

Successful response

Bodyapplication/json

Array [

clientKeystring(Clientkey)

The client key associated with the flow definition (A/B/n test or personalization).

Example:"pers12345"

hrefstring or null(Href)

Example:"https://www.example.com/flow-definition"

Any of:

The URL of the flow definition (A/B/n test or personalization).

string

refstring(Ref)

A reference identifier for the flow definition (A/B/n test or personalization).

Example:"FlowDefinition-12345"

namestring(Name)

The name of the flow definition (A/B/n test or personalization).

Example:"User Registration Flow"

modifiedByRefstring or null(Modifiedbyref)

Example:"User-67890"

Any of:

A reference identifier for the user who last modified the flow definition (A/B/n test or personalization).

string

modifiedAtstring or null(Modifiedat)

Example:"2025-01-15T10:30:00Z"

Any of:

The timestamp when the flow definition (A/B/n test or personalization) was last modified.

string

revisioninteger or null(Revision)

Example:2

Any of:

The revision number of the flow definition (A/B/n test or personalization).

integer

archivedboolean(Archived)

Whether the flow definition (A/B/n test or personalization) is archived.

Example:false

friendlyIdstring(Friendlyid)

A user-friendly identifier for the flow definition (A/B/n test or personalization).

Example:"user_registration_flow"

typestring(Type)

The type of the flow definition (A/B/n test or personalization).

Example:"COMPONENT"

channelsArray of strings or null(Channels)

Any of:

A list of channels associated with the flow definition (A/B/n test or personalization), such as web or mobile.

Array of strings

triggersArray of any or null(Triggers)

Any of:

A list of triggers for the flow definition (A/B/n test or personalization), or null if none.

Array of any

tagsArray of any or null(Tags)

Any of:

A list of tags associated with the flow definition (A/B/n test or personalization), or null if none.

Array of any

businessProcessstring or null(Businessprocess)

Example:"user_registration"

Any of:

The business process associated with the flow definition (A/B/n test or personalization).

string

siteIdstring(Siteid)

The unique identifier of the site associated with the A/B/n test or personalization.

Example:"site_123"

transpiledVariantsArray of any or null(Transpiledvariants)

Any of:

A list of transpiled variants for the flow definition (A/B/n test or personalization), or null if none.

Array of any

variantsArray of objects or null(Variants)

Any of:

A list of variants for the experiment (A/B/n test or personalization), or null if none.

statusstring(Status)

The current status of the flow definition (A/B/n test or personalization).

Example:"DRAFT"

scheduleFlowDefinitionSchedule (object) or null

Any of:

The schedule configuration for the flow definition (A/B/n test or personalization).

revisionsFlowDefinitionRevisions (object) or null

Any of:

Links to the revisions of the flow definition (A/B/n test or personalization).

sampleSizeConfigFlowDefinitionSampleSizeConfigV2 (object) or null

Any of:

The sample size configuration for the flow definition (A/B/n test or personalization).

notificationEnabledboolean or null(Notificationenabled)

Any of:

Whether notifications are enabled for the flow definition (A/B/n test or personalization).

boolean

subtypestring(Subtype)

The subtype of the flow definition (A/B/n test or personalization), identifying it as an A/B experiment.

Enum:"EXPERIMENT""EXPERIENCE"

Example:"EXPERIMENT"

Discriminator

Value:"EXPERIMENT"

trafficobject(ExperimentTraffic)

The traffic distribution configuration for the A/B/n test.

goalsExperimentGoalModel (object) or null

Any of:

The goals tracked for the experiment, keyed by goal identifier.

]

Response

[
  {
    "clientKey": "pers12345",
    "href": "https://www.example.com/flow-definition",
    "ref": "FlowDefinition-12345",
    "name": "User Registration Flow",
    "modifiedByRef": "User-67890",
    "modifiedAt": "2025-01-15T10:30:00Z",
    "revision": 2,
    "archived": false,
    "friendlyId": "user_registration_flow",
    "type": "COMPONENT",
    "channels": [ … ],
    "triggers": [ … ],
    "tags": [ … ],
    "businessProcess": "user_registration",
    "siteId": "site_123",
    "transpiledVariants": [ … ],
    "variants": [ … ],
    "status": "DRAFT",
    "schedule": { … },
    "revisions": { … },
    "sampleSizeConfig": { … },
    "notificationEnabled": true,
    "subtype": "EXPERIMENT",
    "traffic": { … },
    "goals": { … }
  }
]