@@ -6335,6 +6335,232 @@ components:
63356335 example: ok
63366336 type: string
63376337 type: object
6338+ JourneyMapConversionType:
6339+ description: Whether to show the paths that convert to the end step or drop off before it.
6340+ enum:
6341+ - conversion
6342+ - drop-off
6343+ example: conversion
6344+ type: string
6345+ x-enum-varnames:
6346+ - CONVERSION
6347+ - DROP_OFF
6348+ JourneyMapCountingMethod:
6349+ description: Whether to count unique journeys or all journeys.
6350+ enum:
6351+ - uniques
6352+ - totals
6353+ example: uniques
6354+ type: string
6355+ x-enum-varnames:
6356+ - UNIQUES
6357+ - TOTALS
6358+ JourneyMapExpandedPrefix:
6359+ additionalProperties: false
6360+ description: A path expanded to show the events that follow it.
6361+ properties:
6362+ events:
6363+ description: Events of the expanded path, in order.
6364+ example:
6365+ - "@view.name:/cart"
6366+ items:
6367+ description: An event of the expanded path.
6368+ type: string
6369+ minItems: 1
6370+ type: array
6371+ path_limit:
6372+ description: Maximum number of paths shown after the expanded path.
6373+ example: 5
6374+ format: int64
6375+ maximum: 10
6376+ minimum: 1
6377+ type: integer
6378+ required:
6379+ - events
6380+ type: object
6381+ JourneyMapGroupBy:
6382+ additionalProperties: false
6383+ description: Group by configuration for the Journey Paths widget.
6384+ properties:
6385+ facet:
6386+ description: Facet to group by.
6387+ example: "@geo.country"
6388+ type: string
6389+ source:
6390+ $ref: "#/components/schemas/JourneyMapGroupByAudience"
6391+ value_filters:
6392+ description: Facet values to keep.
6393+ example:
6394+ - France
6395+ items:
6396+ description: A facet value.
6397+ type: string
6398+ minItems: 1
6399+ type: array
6400+ required:
6401+ - facet
6402+ - value_filters
6403+ type: object
6404+ JourneyMapGroupByAudience:
6405+ description: Audience the group by facet is read from.
6406+ enum:
6407+ - product_analytics_audience_filters.users
6408+ - product_analytics_audience_filters.accounts
6409+ example: product_analytics_audience_filters.users
6410+ type: string
6411+ x-enum-varnames:
6412+ - USERS
6413+ - ACCOUNTS
6414+ JourneyMapQuery:
6415+ additionalProperties: false
6416+ description: Journey Paths query definition.
6417+ properties:
6418+ conversion_type:
6419+ $ref: "#/components/schemas/JourneyMapConversionType"
6420+ counting_method:
6421+ $ref: "#/components/schemas/JourneyMapCountingMethod"
6422+ data_source:
6423+ $ref: "#/components/schemas/ProductAnalyticsFunnelDataSource"
6424+ entries_per_step:
6425+ description: Maximum number of paths shown per step.
6426+ example: 5
6427+ format: int64
6428+ maximum: 10
6429+ minimum: 1
6430+ type: integer
6431+ event_filter:
6432+ description: Filter applied to the events shown along the paths.
6433+ example: "@type:view"
6434+ type: string
6435+ expanded_prefixes:
6436+ description: Paths expanded to show the events that follow them.
6437+ items:
6438+ $ref: "#/components/schemas/JourneyMapExpandedPrefix"
6439+ description: An expanded path.
6440+ type: array
6441+ uniqueItems: true
6442+ group_by:
6443+ description: Group by configuration.
6444+ items:
6445+ $ref: "#/components/schemas/JourneyMapGroupBy"
6446+ description: A Journey Paths group by configuration.
6447+ type: array
6448+ sampling:
6449+ $ref: "#/components/schemas/JourneyMapSampling"
6450+ search:
6451+ $ref: "#/components/schemas/UserJourneySearch"
6452+ target:
6453+ $ref: "#/components/schemas/JourneyMapTarget"
6454+ required:
6455+ - data_source
6456+ - search
6457+ - target
6458+ type: object
6459+ JourneyMapRequestType:
6460+ description: Request type for the Journey Paths widget.
6461+ enum:
6462+ - journey_map
6463+ example: journey_map
6464+ type: string
6465+ x-enum-varnames:
6466+ - JOURNEY_MAP
6467+ JourneyMapSampling:
6468+ additionalProperties: false
6469+ description: Sampling configuration for the Journey Paths query.
6470+ properties:
6471+ enabled:
6472+ description: Whether sampling is enabled.
6473+ example: true
6474+ type: boolean
6475+ required:
6476+ - enabled
6477+ type: object
6478+ JourneyMapTarget:
6479+ additionalProperties: false
6480+ description: The pair of journey steps the paths are visualized between.
6481+ properties:
6482+ end:
6483+ description: Key of the end step in `search.node_objects`.
6484+ example: node_1
6485+ type: string
6486+ start:
6487+ description: Key of the start step in `search.node_objects`.
6488+ example: node_0
6489+ type: string
6490+ required:
6491+ - start
6492+ - end
6493+ type: object
6494+ JourneyMapWidgetDefinition:
6495+ additionalProperties: false
6496+ description: The Journey Paths widget visualizes the paths users take between two steps of a Product Analytics journey.
6497+ properties:
6498+ description:
6499+ description: The description of the widget.
6500+ type: string
6501+ requests:
6502+ description: List of Journey Paths widget requests. Exactly one request is supported.
6503+ example:
6504+ - query:
6505+ data_source: product_analytics_journey
6506+ search:
6507+ expression: "node_0 -> node_1"
6508+ node_objects:
6509+ node_0:
6510+ data_source: product_analytics
6511+ search:
6512+ query: "@type:view @view.name:/cart"
6513+ node_1:
6514+ data_source: product_analytics
6515+ search:
6516+ query: "@type:view @view.name:/checkout"
6517+ target:
6518+ end: node_1
6519+ start: node_0
6520+ request_type: journey_map
6521+ items:
6522+ $ref: "#/components/schemas/JourneyMapWidgetRequest"
6523+ description: A Journey Paths widget request.
6524+ maxItems: 1
6525+ minItems: 1
6526+ type: array
6527+ time:
6528+ $ref: "#/components/schemas/WidgetTime"
6529+ title:
6530+ description: Title of your widget.
6531+ type: string
6532+ title_align:
6533+ $ref: "#/components/schemas/WidgetTextAlign"
6534+ title_size:
6535+ description: Size of the title.
6536+ type: string
6537+ type:
6538+ $ref: "#/components/schemas/JourneyMapWidgetDefinitionType"
6539+ required:
6540+ - type
6541+ - requests
6542+ type: object
6543+ JourneyMapWidgetDefinitionType:
6544+ default: journey_map
6545+ description: Type of the Journey Paths widget.
6546+ enum:
6547+ - journey_map
6548+ example: journey_map
6549+ type: string
6550+ x-enum-varnames:
6551+ - JOURNEY_MAP
6552+ JourneyMapWidgetRequest:
6553+ additionalProperties: false
6554+ description: Journey Paths widget request.
6555+ properties:
6556+ query:
6557+ $ref: "#/components/schemas/JourneyMapQuery"
6558+ request_type:
6559+ $ref: "#/components/schemas/JourneyMapRequestType"
6560+ required:
6561+ - request_type
6562+ - query
6563+ type: object
63386564 ListStreamColumn:
63396565 description: Widget column.
63406566 example: {"field": "timestamp", "width": "auto"}
@@ -28705,6 +28931,7 @@ components:
2870528931 - $ref: "#/components/schemas/HostMapWidgetDefinition"
2870628932 - $ref: "#/components/schemas/IFrameWidgetDefinition"
2870728933 - $ref: "#/components/schemas/ImageWidgetDefinition"
28934+ - $ref: "#/components/schemas/JourneyMapWidgetDefinition"
2870828935 - $ref: "#/components/schemas/ListStreamWidgetDefinition"
2870928936 - $ref: "#/components/schemas/LogStreamWidgetDefinition"
2871028937 - $ref: "#/components/schemas/MonitorSummaryWidgetDefinition"
0 commit comments