keitaro-api-skill/references/schemas/StreamObject.yaml

69 lines
1.4 KiB
YAML

type: object
properties:
campaign_id:
type: integer
description: Campaign ID
type:
type: string
description: Flow type
enum:
- forced
- regular
- default
name:
type: string
description: Flow name
position:
type: integer
description: Position of a flow among other flows.
weight:
type: number
description: Flow weight.
action_options:
type: object
description: Action options.
comments:
type: string
description: Comments or notes for the flow
state:
type: string
enum:
- active
- disabled
- deleted
description: State of the flow
default: active
action_type:
type: string
description: Action to perform (see 'Retrieve available flow action types')
schema:
type: string
enum:
- landings
- redirect
- action
collect_clicks:
type: boolean
description: Flow saves clicks (true/false)
default: false
filter_or:
type: boolean
description: Use 'OR' operator between filters
default: false
filters:
type: array
items:
$ref: ../schemas/FilterStreamRequest.yaml
triggers:
type: array
items:
$ref: ../schemas/TriggersStreamRequest.yaml
landings:
type: array
items:
$ref: ../schemas/LandingStreamRequest.yaml
offers:
type: array
items:
$ref: ../schemas/OfferStreamRequest.yaml