# Journey Flows

> Manage saved Journey Flow configurations, preview journeys, retrieve computed results, and export CSV reports through the REST API.

Source: https://docs.oursprivacy.com/docs/platform-api/journey-flows

Journey Flows describe observed visitor paths between configured anchors. This reference covers saved configurations, supported capabilities, previews, computed results, and CSV exports.

## GET /rest/v1/journey-flows

List saved Journey Flow configurations, most recently updated first. Supports cursor pagination and name/description search. Requires API-key scope or current OAuth user permission: web-analytics:view

Request URL: `GET https://app.oursprivacy.com/rest/v1/journey-flows`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `limit` | query | integer \| null | No | Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100. Maximum number of items to return. Defaults to 25; values below 1 are clamped to 1 and values above 100 are clamped to 100. |
| `cursor` | query | string | No | Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request. Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request. |
| `search` | query | string | No | Case-insensitive search in the name and description. Case-insensitive search in the name and description. |

### Responses

- `200`: Saved Journey Flow configurations
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `entities` | object[] | Yes |  |
| `entities[].id` | string (uuid) | Yes |  |
| `entities[].revision` | string (uuid) | Yes |  |
| `entities[].name` | string | Yes |  |
| `entities[].description` | string \| null | No | Optional description; null clears it. |
| `entities[].definition` | object | Yes | Version 1 Journey Flow definition with anchors, event or page matchers, counting, scope, and exploration settings. Selecting specific sourceIds also requires source:view permission. |
| `entities[].definition.version` | number | Yes | One of: `1`. |
| `entities[].definition.kind` | string | Yes | One of: `"journey-flow"`. |
| `entities[].definition.counting` | string | No | One of: `"unique"`, `"totals"`, `"sessions"`. |
| `entities[].definition.reentry` | string | No | One of: `"first"`, `"best"`. |
| `entities[].definition.anchors` | object[] | Yes |  |
| `entities[].definition.anchors[].id` | string | Yes |  |
| `entities[].definition.anchors[].label` | string | No |  |
| `entities[].definition.anchors[].alternatives` | object[] | Yes |  |
| `entities[].definition.anchors[].filter` | object | No |  |
| `entities[].definition.anchors[].filter.version` | number | Yes | One of: `1`. |
| `entities[].definition.anchors[].filter.filter` | object | Yes |  |
| `entities[].definition.conversionWindowMs` | integer | No |  |
| `entities[].definition.contextWindowMs` | integer | No |  |
| `entities[].definition.scope` | object | Yes |  |
| `entities[].definition.scope.sourceIds` | string[] | Yes |  |
| `entities[].definition.scope.excludeBots` | boolean | Yes |  |
| `entities[].definition.scope.sessionFilter` | object | No |  |
| `entities[].definition.scope.sessionFilter.version` | number | Yes | One of: `1`. |
| `entities[].definition.scope.sessionFilter.filter` | object | Yes |  |
| `entities[].definition.entryFilter` | object | No |  |
| `entities[].definition.entryFilter.version` | number | Yes | One of: `1`. |
| `entities[].definition.entryFilter.filter` | object | Yes |  |
| `entities[].definition.anchorFilter` | object | No |  |
| `entities[].definition.anchorFilter.version` | number | Yes | One of: `1`. |
| `entities[].definition.anchorFilter.filter` | object | Yes |  |
| `entities[].definition.exploration` | object | Yes |  |
| `entities[].definition.exploration.before` | integer | No |  |
| `entities[].definition.exploration.after` | integer | No |  |
| `entities[].definition.exploration.between` | object[] | No |  |
| `entities[].definition.exploration.between[].fromAnchorId` | string | Yes |  |
| `entities[].definition.exploration.between[].toAnchorId` | string | Yes |  |
| `entities[].definition.exploration.between[].afterFrom` | integer | Yes |  |
| `entities[].definition.exploration.between[].beforeTo` | integer | Yes |  |
| `entities[].definition.exploration.stepKinds` | string[] | No |  |
| `entities[].definition.exploration.pageKey` | string | No | One of: `"path"`, `"url"`. |
| `entities[].definition.exploration.pathFilter` | object | No |  |
| `entities[].definition.exploration.pathFilter.version` | number | Yes | One of: `1`. |
| `entities[].definition.exploration.pathFilter.filter` | object | Yes |  |
| `entities[].definition.exploration.hiddenEvents` | object[] | No |  |
| `entities[].definition.exploration.collapseRepeats` | boolean | No |  |
| `entities[].definition.exploration.focus` | object[] | No |  |
| `entities[].definition.exclusions` | object[] | No |  |
| `entities[].definition.exclusions[].id` | string | Yes |  |
| `entities[].definition.exclusions[].matcher` | object | Yes |  |
| `entities[].definition.exclusions[].fromAnchorId` | string | Yes |  |
| `entities[].definition.exclusions[].toAnchorId` | string | Yes |  |
| `entities[].definition.holdConstant` | object[] | No |  |
| `entities[].definition.holdConstant[].property` | string | Yes |  |
| `entities[].definition.holdConstant[].path` | string[] | No |  |
| `entities[].definition.holdConstant[].type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `entities[].definition.breakdown` | object | No |  |
| `entities[].definition.breakdown.property` | object | Yes |  |
| `entities[].definition.breakdown.property.property` | string | Yes |  |
| `entities[].definition.breakdown.property.path` | string[] | No |  |
| `entities[].definition.breakdown.property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `entities[].definition.breakdown.atAnchorId` | string | Yes |  |
| `entities[].definition.breakdown.limit` | integer | No |  |
| `entities[].definition.nodeExpansions` | object[] | No |  |
| `entities[].definition.nodeExpansions[].position` | object | Yes |  |
| `entities[].definition.nodeExpansions[].position.anchorId` | string | Yes |  |
| `entities[].definition.nodeExpansions[].position.side` | string | Yes | One of: `"anchor"`, `"before"`, `"after"`. |
| `entities[].definition.nodeExpansions[].position.offset` | integer | Yes |  |
| `entities[].definition.nodeExpansions[].matcher` | object | Yes |  |
| `entities[].definition.nodeExpansions[].property` | object | Yes |  |
| `entities[].definition.nodeExpansions[].property.property` | string | Yes |  |
| `entities[].definition.nodeExpansions[].property.path` | string[] | No |  |
| `entities[].definition.nodeExpansions[].property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `entities[].definition.nodeExpansions[].limit` | integer | No |  |
| `entities[].reportContext` | object | Yes | Complete UTC date range and comparisons for this Journey Flow. |
| `entities[].reportContext.dateRange` | object | Yes |  |
| `entities[].reportContext.dateRange.from` | string | Yes |  |
| `entities[].reportContext.dateRange.to` | string | Yes |  |
| `entities[].reportContext.dateRange.timeZone` | string | Yes |  |
| `entities[].reportContext.comparisons` | object[] | No |  |
| `entities[].reportContext.comparisons[].id` | string | Yes |  |
| `entities[].reportContext.comparisons[].label` | string | Yes |  |
| `entities[].reportContext.comparisons[].dateRange` | object | No |  |
| `entities[].reportContext.comparisons[].dateRange.from` | string | Yes |  |
| `entities[].reportContext.comparisons[].dateRange.to` | string | Yes |  |
| `entities[].reportContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `entities[].reportContext.comparisons[].entryFilter` | object | No |  |
| `entities[].reportContext.comparisons[].entryFilter.version` | number | Yes | One of: `1`. |
| `entities[].reportContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `entities[].reportContext.comparisons[].sessionFilter` | object | No |  |
| `entities[].reportContext.comparisons[].sessionFilter.version` | number | Yes | One of: `1`. |
| `entities[].reportContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `entities[].view` | object | Yes | Complete visualization settings. Supplied view replaces the saved value on PATCH. |
| `entities[].view.visualization` | string | No | One of: `"sankey"`, `"top-paths"`. |
| `entities[].view.topEventsPerPosition` | integer | No |  |
| `entities[].view.topPaths` | integer | No |  |
| `entities[].view.showDropOff` | boolean | No |  |
| `entities[].view.showElapsedTime` | boolean | No |  |
| `entities[].createdAt` | string | Yes |  |
| `entities[].updatedAt` | string | Yes |  |
| `entities[].createdByUserId` | string | Yes |  |
| `entities[].updatedByUserId` | string | Yes |  |
| `pagination` | object | Yes |  |
| `pagination.nextCursor` | string \| null | No |  |
| `pagination.hasMore` | boolean | Yes |  |
| `unavailableCount` | integer | Yes |  |
| `warnings` | object[] | Yes |  |
| `warnings[].code` | string | Yes |  |
| `warnings[].message` | string | Yes |  |
| `warnings[].path` | string[] \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## POST /rest/v1/journey-flows

Save a validated Journey Flow configuration. Source ownership, UTC dates, and supported journey settings are validated before saving. Reports selecting specific sources also require source:view permission. Requires API-key scope or current OAuth user permission: web-analytics:write

Request URL: `POST https://app.oursprivacy.com/rest/v1/journey-flows`

Authentication: apiKey or oauth2.

### Request body (`application/json`, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Display name for the saved Journey Flow. |
| `description` | string \| null | No | Optional description; null clears it. |
| `definition` | object | Yes | Version 1 Journey Flow definition with anchors, event or page matchers, counting, scope, and exploration settings. Selecting specific sourceIds also requires source:view permission. |
| `definition.version` | number | Yes | One of: `1`. |
| `definition.kind` | string | Yes | One of: `"journey-flow"`. |
| `definition.counting` | string | No | One of: `"unique"`, `"totals"`, `"sessions"`. |
| `definition.reentry` | string | No | One of: `"first"`, `"best"`. |
| `definition.anchors` | object[] | Yes |  |
| `definition.anchors[].id` | string | Yes |  |
| `definition.anchors[].label` | string | No |  |
| `definition.anchors[].alternatives` | object[] | Yes |  |
| `definition.anchors[].filter` | object | No |  |
| `definition.anchors[].filter.version` | number | Yes | One of: `1`. |
| `definition.anchors[].filter.filter` | object | Yes |  |
| `definition.conversionWindowMs` | integer | No |  |
| `definition.contextWindowMs` | integer | No |  |
| `definition.scope` | object | Yes |  |
| `definition.scope.sourceIds` | string[] | Yes |  |
| `definition.scope.excludeBots` | boolean | Yes |  |
| `definition.scope.sessionFilter` | object | No |  |
| `definition.scope.sessionFilter.version` | number | Yes | One of: `1`. |
| `definition.scope.sessionFilter.filter` | object | Yes |  |
| `definition.entryFilter` | object | No |  |
| `definition.entryFilter.version` | number | Yes | One of: `1`. |
| `definition.entryFilter.filter` | object | Yes |  |
| `definition.anchorFilter` | object | No |  |
| `definition.anchorFilter.version` | number | Yes | One of: `1`. |
| `definition.anchorFilter.filter` | object | Yes |  |
| `definition.exploration` | object | Yes |  |
| `definition.exploration.before` | integer | No |  |
| `definition.exploration.after` | integer | No |  |
| `definition.exploration.between` | object[] | No |  |
| `definition.exploration.between[].fromAnchorId` | string | Yes |  |
| `definition.exploration.between[].toAnchorId` | string | Yes |  |
| `definition.exploration.between[].afterFrom` | integer | Yes |  |
| `definition.exploration.between[].beforeTo` | integer | Yes |  |
| `definition.exploration.stepKinds` | string[] | No |  |
| `definition.exploration.pageKey` | string | No | One of: `"path"`, `"url"`. |
| `definition.exploration.pathFilter` | object | No |  |
| `definition.exploration.pathFilter.version` | number | Yes | One of: `1`. |
| `definition.exploration.pathFilter.filter` | object | Yes |  |
| `definition.exploration.hiddenEvents` | object[] | No |  |
| `definition.exploration.collapseRepeats` | boolean | No |  |
| `definition.exploration.focus` | object[] | No |  |
| `definition.exclusions` | object[] | No |  |
| `definition.exclusions[].id` | string | Yes |  |
| `definition.exclusions[].matcher` | object | Yes |  |
| `definition.exclusions[].fromAnchorId` | string | Yes |  |
| `definition.exclusions[].toAnchorId` | string | Yes |  |
| `definition.holdConstant` | object[] | No |  |
| `definition.holdConstant[].property` | string | Yes |  |
| `definition.holdConstant[].path` | string[] | No |  |
| `definition.holdConstant[].type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown` | object | No |  |
| `definition.breakdown.property` | object | Yes |  |
| `definition.breakdown.property.property` | string | Yes |  |
| `definition.breakdown.property.path` | string[] | No |  |
| `definition.breakdown.property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown.atAnchorId` | string | Yes |  |
| `definition.breakdown.limit` | integer | No |  |
| `definition.nodeExpansions` | object[] | No |  |
| `definition.nodeExpansions[].position` | object | Yes |  |
| `definition.nodeExpansions[].position.anchorId` | string | Yes |  |
| `definition.nodeExpansions[].position.side` | string | Yes | One of: `"anchor"`, `"before"`, `"after"`. |
| `definition.nodeExpansions[].position.offset` | integer | Yes |  |
| `definition.nodeExpansions[].matcher` | object | Yes |  |
| `definition.nodeExpansions[].property` | object | Yes |  |
| `definition.nodeExpansions[].property.property` | string | Yes |  |
| `definition.nodeExpansions[].property.path` | string[] | No |  |
| `definition.nodeExpansions[].property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.nodeExpansions[].limit` | integer | No |  |
| `reportContext` | object | Yes | Complete UTC date range and comparisons for this Journey Flow. |
| `reportContext.dateRange` | object | Yes |  |
| `reportContext.dateRange.from` | string | Yes |  |
| `reportContext.dateRange.to` | string | Yes |  |
| `reportContext.dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons` | object[] | No |  |
| `reportContext.comparisons[].id` | string | Yes |  |
| `reportContext.comparisons[].label` | string | Yes |  |
| `reportContext.comparisons[].dateRange` | object | No |  |
| `reportContext.comparisons[].dateRange.from` | string | Yes |  |
| `reportContext.comparisons[].dateRange.to` | string | Yes |  |
| `reportContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons[].entryFilter` | object | No |  |
| `reportContext.comparisons[].entryFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `reportContext.comparisons[].sessionFilter` | object | No |  |
| `reportContext.comparisons[].sessionFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `view` | object | Yes | Complete visualization settings. Supplied view replaces the saved value on PATCH. |
| `view.visualization` | string | No | One of: `"sankey"`, `"top-paths"`. |
| `view.topEventsPerPosition` | integer | No |  |
| `view.topPaths` | integer | No |  |
| `view.showDropOff` | boolean | No |  |
| `view.showElapsedTime` | boolean | No |  |

### Responses

- `200`: Created Journey Flow configuration
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `409`: Journey Flow write conflict.
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes |  |
| `revision` | string (uuid) | Yes |  |
| `name` | string | Yes |  |
| `description` | string \| null | No | Optional description; null clears it. |
| `definition` | object | Yes | Version 1 Journey Flow definition with anchors, event or page matchers, counting, scope, and exploration settings. Selecting specific sourceIds also requires source:view permission. |
| `definition.version` | number | Yes | One of: `1`. |
| `definition.kind` | string | Yes | One of: `"journey-flow"`. |
| `definition.counting` | string | No | One of: `"unique"`, `"totals"`, `"sessions"`. |
| `definition.reentry` | string | No | One of: `"first"`, `"best"`. |
| `definition.anchors` | object[] | Yes |  |
| `definition.anchors[].id` | string | Yes |  |
| `definition.anchors[].label` | string | No |  |
| `definition.anchors[].alternatives` | object[] | Yes |  |
| `definition.anchors[].filter` | object | No |  |
| `definition.anchors[].filter.version` | number | Yes | One of: `1`. |
| `definition.anchors[].filter.filter` | object | Yes |  |
| `definition.conversionWindowMs` | integer | No |  |
| `definition.contextWindowMs` | integer | No |  |
| `definition.scope` | object | Yes |  |
| `definition.scope.sourceIds` | string[] | Yes |  |
| `definition.scope.excludeBots` | boolean | Yes |  |
| `definition.scope.sessionFilter` | object | No |  |
| `definition.scope.sessionFilter.version` | number | Yes | One of: `1`. |
| `definition.scope.sessionFilter.filter` | object | Yes |  |
| `definition.entryFilter` | object | No |  |
| `definition.entryFilter.version` | number | Yes | One of: `1`. |
| `definition.entryFilter.filter` | object | Yes |  |
| `definition.anchorFilter` | object | No |  |
| `definition.anchorFilter.version` | number | Yes | One of: `1`. |
| `definition.anchorFilter.filter` | object | Yes |  |
| `definition.exploration` | object | Yes |  |
| `definition.exploration.before` | integer | No |  |
| `definition.exploration.after` | integer | No |  |
| `definition.exploration.between` | object[] | No |  |
| `definition.exploration.between[].fromAnchorId` | string | Yes |  |
| `definition.exploration.between[].toAnchorId` | string | Yes |  |
| `definition.exploration.between[].afterFrom` | integer | Yes |  |
| `definition.exploration.between[].beforeTo` | integer | Yes |  |
| `definition.exploration.stepKinds` | string[] | No |  |
| `definition.exploration.pageKey` | string | No | One of: `"path"`, `"url"`. |
| `definition.exploration.pathFilter` | object | No |  |
| `definition.exploration.pathFilter.version` | number | Yes | One of: `1`. |
| `definition.exploration.pathFilter.filter` | object | Yes |  |
| `definition.exploration.hiddenEvents` | object[] | No |  |
| `definition.exploration.collapseRepeats` | boolean | No |  |
| `definition.exploration.focus` | object[] | No |  |
| `definition.exclusions` | object[] | No |  |
| `definition.exclusions[].id` | string | Yes |  |
| `definition.exclusions[].matcher` | object | Yes |  |
| `definition.exclusions[].fromAnchorId` | string | Yes |  |
| `definition.exclusions[].toAnchorId` | string | Yes |  |
| `definition.holdConstant` | object[] | No |  |
| `definition.holdConstant[].property` | string | Yes |  |
| `definition.holdConstant[].path` | string[] | No |  |
| `definition.holdConstant[].type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown` | object | No |  |
| `definition.breakdown.property` | object | Yes |  |
| `definition.breakdown.property.property` | string | Yes |  |
| `definition.breakdown.property.path` | string[] | No |  |
| `definition.breakdown.property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown.atAnchorId` | string | Yes |  |
| `definition.breakdown.limit` | integer | No |  |
| `definition.nodeExpansions` | object[] | No |  |
| `definition.nodeExpansions[].position` | object | Yes |  |
| `definition.nodeExpansions[].position.anchorId` | string | Yes |  |
| `definition.nodeExpansions[].position.side` | string | Yes | One of: `"anchor"`, `"before"`, `"after"`. |
| `definition.nodeExpansions[].position.offset` | integer | Yes |  |
| `definition.nodeExpansions[].matcher` | object | Yes |  |
| `definition.nodeExpansions[].property` | object | Yes |  |
| `definition.nodeExpansions[].property.property` | string | Yes |  |
| `definition.nodeExpansions[].property.path` | string[] | No |  |
| `definition.nodeExpansions[].property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.nodeExpansions[].limit` | integer | No |  |
| `reportContext` | object | Yes | Complete UTC date range and comparisons for this Journey Flow. |
| `reportContext.dateRange` | object | Yes |  |
| `reportContext.dateRange.from` | string | Yes |  |
| `reportContext.dateRange.to` | string | Yes |  |
| `reportContext.dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons` | object[] | No |  |
| `reportContext.comparisons[].id` | string | Yes |  |
| `reportContext.comparisons[].label` | string | Yes |  |
| `reportContext.comparisons[].dateRange` | object | No |  |
| `reportContext.comparisons[].dateRange.from` | string | Yes |  |
| `reportContext.comparisons[].dateRange.to` | string | Yes |  |
| `reportContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons[].entryFilter` | object | No |  |
| `reportContext.comparisons[].entryFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `reportContext.comparisons[].sessionFilter` | object | No |  |
| `reportContext.comparisons[].sessionFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `view` | object | Yes | Complete visualization settings. Supplied view replaces the saved value on PATCH. |
| `view.visualization` | string | No | One of: `"sankey"`, `"top-paths"`. |
| `view.topEventsPerPosition` | integer | No |  |
| `view.topPaths` | integer | No |  |
| `view.showDropOff` | boolean | No |  |
| `view.showElapsedTime` | boolean | No |  |
| `createdAt` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `createdByUserId` | string | Yes |  |
| `updatedByUserId` | string | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/journey-flows/{id}

Fetch a saved Journey Flow configuration by id. Returns 404 when it does not exist or is not readable by this account. Requires API-key scope or current OAuth user permission: web-analytics:view

Request URL: `GET https://app.oursprivacy.com/rest/v1/journey-flows/{id}`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string (uuid) | Yes |  |

### Responses

- `200`: Saved Journey Flow configuration
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Journey Flow not found.
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes |  |
| `revision` | string (uuid) | Yes |  |
| `name` | string | Yes |  |
| `description` | string \| null | No | Optional description; null clears it. |
| `definition` | object | Yes | Version 1 Journey Flow definition with anchors, event or page matchers, counting, scope, and exploration settings. Selecting specific sourceIds also requires source:view permission. |
| `definition.version` | number | Yes | One of: `1`. |
| `definition.kind` | string | Yes | One of: `"journey-flow"`. |
| `definition.counting` | string | No | One of: `"unique"`, `"totals"`, `"sessions"`. |
| `definition.reentry` | string | No | One of: `"first"`, `"best"`. |
| `definition.anchors` | object[] | Yes |  |
| `definition.anchors[].id` | string | Yes |  |
| `definition.anchors[].label` | string | No |  |
| `definition.anchors[].alternatives` | object[] | Yes |  |
| `definition.anchors[].filter` | object | No |  |
| `definition.anchors[].filter.version` | number | Yes | One of: `1`. |
| `definition.anchors[].filter.filter` | object | Yes |  |
| `definition.conversionWindowMs` | integer | No |  |
| `definition.contextWindowMs` | integer | No |  |
| `definition.scope` | object | Yes |  |
| `definition.scope.sourceIds` | string[] | Yes |  |
| `definition.scope.excludeBots` | boolean | Yes |  |
| `definition.scope.sessionFilter` | object | No |  |
| `definition.scope.sessionFilter.version` | number | Yes | One of: `1`. |
| `definition.scope.sessionFilter.filter` | object | Yes |  |
| `definition.entryFilter` | object | No |  |
| `definition.entryFilter.version` | number | Yes | One of: `1`. |
| `definition.entryFilter.filter` | object | Yes |  |
| `definition.anchorFilter` | object | No |  |
| `definition.anchorFilter.version` | number | Yes | One of: `1`. |
| `definition.anchorFilter.filter` | object | Yes |  |
| `definition.exploration` | object | Yes |  |
| `definition.exploration.before` | integer | No |  |
| `definition.exploration.after` | integer | No |  |
| `definition.exploration.between` | object[] | No |  |
| `definition.exploration.between[].fromAnchorId` | string | Yes |  |
| `definition.exploration.between[].toAnchorId` | string | Yes |  |
| `definition.exploration.between[].afterFrom` | integer | Yes |  |
| `definition.exploration.between[].beforeTo` | integer | Yes |  |
| `definition.exploration.stepKinds` | string[] | No |  |
| `definition.exploration.pageKey` | string | No | One of: `"path"`, `"url"`. |
| `definition.exploration.pathFilter` | object | No |  |
| `definition.exploration.pathFilter.version` | number | Yes | One of: `1`. |
| `definition.exploration.pathFilter.filter` | object | Yes |  |
| `definition.exploration.hiddenEvents` | object[] | No |  |
| `definition.exploration.collapseRepeats` | boolean | No |  |
| `definition.exploration.focus` | object[] | No |  |
| `definition.exclusions` | object[] | No |  |
| `definition.exclusions[].id` | string | Yes |  |
| `definition.exclusions[].matcher` | object | Yes |  |
| `definition.exclusions[].fromAnchorId` | string | Yes |  |
| `definition.exclusions[].toAnchorId` | string | Yes |  |
| `definition.holdConstant` | object[] | No |  |
| `definition.holdConstant[].property` | string | Yes |  |
| `definition.holdConstant[].path` | string[] | No |  |
| `definition.holdConstant[].type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown` | object | No |  |
| `definition.breakdown.property` | object | Yes |  |
| `definition.breakdown.property.property` | string | Yes |  |
| `definition.breakdown.property.path` | string[] | No |  |
| `definition.breakdown.property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown.atAnchorId` | string | Yes |  |
| `definition.breakdown.limit` | integer | No |  |
| `definition.nodeExpansions` | object[] | No |  |
| `definition.nodeExpansions[].position` | object | Yes |  |
| `definition.nodeExpansions[].position.anchorId` | string | Yes |  |
| `definition.nodeExpansions[].position.side` | string | Yes | One of: `"anchor"`, `"before"`, `"after"`. |
| `definition.nodeExpansions[].position.offset` | integer | Yes |  |
| `definition.nodeExpansions[].matcher` | object | Yes |  |
| `definition.nodeExpansions[].property` | object | Yes |  |
| `definition.nodeExpansions[].property.property` | string | Yes |  |
| `definition.nodeExpansions[].property.path` | string[] | No |  |
| `definition.nodeExpansions[].property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.nodeExpansions[].limit` | integer | No |  |
| `reportContext` | object | Yes | Complete UTC date range and comparisons for this Journey Flow. |
| `reportContext.dateRange` | object | Yes |  |
| `reportContext.dateRange.from` | string | Yes |  |
| `reportContext.dateRange.to` | string | Yes |  |
| `reportContext.dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons` | object[] | No |  |
| `reportContext.comparisons[].id` | string | Yes |  |
| `reportContext.comparisons[].label` | string | Yes |  |
| `reportContext.comparisons[].dateRange` | object | No |  |
| `reportContext.comparisons[].dateRange.from` | string | Yes |  |
| `reportContext.comparisons[].dateRange.to` | string | Yes |  |
| `reportContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons[].entryFilter` | object | No |  |
| `reportContext.comparisons[].entryFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `reportContext.comparisons[].sessionFilter` | object | No |  |
| `reportContext.comparisons[].sessionFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `view` | object | Yes | Complete visualization settings. Supplied view replaces the saved value on PATCH. |
| `view.visualization` | string | No | One of: `"sankey"`, `"top-paths"`. |
| `view.topEventsPerPosition` | integer | No |  |
| `view.topPaths` | integer | No |  |
| `view.showDropOff` | boolean | No |  |
| `view.showElapsedTime` | boolean | No |  |
| `createdAt` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `createdByUserId` | string | Yes |  |
| `updatedByUserId` | string | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## PATCH /rest/v1/journey-flows/{id}

Partially update a Journey Flow using expectedRevision for optimistic concurrency. Omitted top-level fields remain unchanged; nested values replace the complete nested value. Reports selecting specific sources also require source:view permission. Requires API-key scope or current OAuth user permission: web-analytics:write

Request URL: `PATCH https://app.oursprivacy.com/rest/v1/journey-flows/{id}`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string (uuid) | Yes |  |

### Request body (`application/json`, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `expectedRevision` | string (uuid) | Yes | Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. |
| `name` | string | No | Display name for the saved Journey Flow. |
| `description` | string \| null | No | Optional description; null clears it. |
| `definition` | object | No | Version 1 Journey Flow definition with anchors, event or page matchers, counting, scope, and exploration settings. Selecting specific sourceIds also requires source:view permission. |
| `definition.version` | number | Yes | One of: `1`. |
| `definition.kind` | string | Yes | One of: `"journey-flow"`. |
| `definition.counting` | string | No | One of: `"unique"`, `"totals"`, `"sessions"`. |
| `definition.reentry` | string | No | One of: `"first"`, `"best"`. |
| `definition.anchors` | object[] | Yes |  |
| `definition.anchors[].id` | string | Yes |  |
| `definition.anchors[].label` | string | No |  |
| `definition.anchors[].alternatives` | object[] | Yes |  |
| `definition.anchors[].filter` | object | No |  |
| `definition.anchors[].filter.version` | number | Yes | One of: `1`. |
| `definition.anchors[].filter.filter` | object | Yes |  |
| `definition.conversionWindowMs` | integer | No |  |
| `definition.contextWindowMs` | integer | No |  |
| `definition.scope` | object | Yes |  |
| `definition.scope.sourceIds` | string[] | Yes |  |
| `definition.scope.excludeBots` | boolean | Yes |  |
| `definition.scope.sessionFilter` | object | No |  |
| `definition.scope.sessionFilter.version` | number | Yes | One of: `1`. |
| `definition.scope.sessionFilter.filter` | object | Yes |  |
| `definition.entryFilter` | object | No |  |
| `definition.entryFilter.version` | number | Yes | One of: `1`. |
| `definition.entryFilter.filter` | object | Yes |  |
| `definition.anchorFilter` | object | No |  |
| `definition.anchorFilter.version` | number | Yes | One of: `1`. |
| `definition.anchorFilter.filter` | object | Yes |  |
| `definition.exploration` | object | Yes |  |
| `definition.exploration.before` | integer | No |  |
| `definition.exploration.after` | integer | No |  |
| `definition.exploration.between` | object[] | No |  |
| `definition.exploration.between[].fromAnchorId` | string | Yes |  |
| `definition.exploration.between[].toAnchorId` | string | Yes |  |
| `definition.exploration.between[].afterFrom` | integer | Yes |  |
| `definition.exploration.between[].beforeTo` | integer | Yes |  |
| `definition.exploration.stepKinds` | string[] | No |  |
| `definition.exploration.pageKey` | string | No | One of: `"path"`, `"url"`. |
| `definition.exploration.pathFilter` | object | No |  |
| `definition.exploration.pathFilter.version` | number | Yes | One of: `1`. |
| `definition.exploration.pathFilter.filter` | object | Yes |  |
| `definition.exploration.hiddenEvents` | object[] | No |  |
| `definition.exploration.collapseRepeats` | boolean | No |  |
| `definition.exploration.focus` | object[] | No |  |
| `definition.exclusions` | object[] | No |  |
| `definition.exclusions[].id` | string | Yes |  |
| `definition.exclusions[].matcher` | object | Yes |  |
| `definition.exclusions[].fromAnchorId` | string | Yes |  |
| `definition.exclusions[].toAnchorId` | string | Yes |  |
| `definition.holdConstant` | object[] | No |  |
| `definition.holdConstant[].property` | string | Yes |  |
| `definition.holdConstant[].path` | string[] | No |  |
| `definition.holdConstant[].type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown` | object | No |  |
| `definition.breakdown.property` | object | Yes |  |
| `definition.breakdown.property.property` | string | Yes |  |
| `definition.breakdown.property.path` | string[] | No |  |
| `definition.breakdown.property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown.atAnchorId` | string | Yes |  |
| `definition.breakdown.limit` | integer | No |  |
| `definition.nodeExpansions` | object[] | No |  |
| `definition.nodeExpansions[].position` | object | Yes |  |
| `definition.nodeExpansions[].position.anchorId` | string | Yes |  |
| `definition.nodeExpansions[].position.side` | string | Yes | One of: `"anchor"`, `"before"`, `"after"`. |
| `definition.nodeExpansions[].position.offset` | integer | Yes |  |
| `definition.nodeExpansions[].matcher` | object | Yes |  |
| `definition.nodeExpansions[].property` | object | Yes |  |
| `definition.nodeExpansions[].property.property` | string | Yes |  |
| `definition.nodeExpansions[].property.path` | string[] | No |  |
| `definition.nodeExpansions[].property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.nodeExpansions[].limit` | integer | No |  |
| `reportContext` | object | No | Complete UTC date range and comparisons for this Journey Flow. |
| `reportContext.dateRange` | object | Yes |  |
| `reportContext.dateRange.from` | string | Yes |  |
| `reportContext.dateRange.to` | string | Yes |  |
| `reportContext.dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons` | object[] | No |  |
| `reportContext.comparisons[].id` | string | Yes |  |
| `reportContext.comparisons[].label` | string | Yes |  |
| `reportContext.comparisons[].dateRange` | object | No |  |
| `reportContext.comparisons[].dateRange.from` | string | Yes |  |
| `reportContext.comparisons[].dateRange.to` | string | Yes |  |
| `reportContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons[].entryFilter` | object | No |  |
| `reportContext.comparisons[].entryFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `reportContext.comparisons[].sessionFilter` | object | No |  |
| `reportContext.comparisons[].sessionFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `view` | object | No | Complete visualization settings. Supplied view replaces the saved value on PATCH. |
| `view.visualization` | string | No | One of: `"sankey"`, `"top-paths"`. |
| `view.topEventsPerPosition` | integer | No |  |
| `view.topPaths` | integer | No |  |
| `view.showDropOff` | boolean | No |  |
| `view.showElapsedTime` | boolean | No |  |

### Responses

- `200`: Updated Journey Flow configuration
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Journey Flow not found.
- `409`: Journey Flow revision conflict.
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes |  |
| `revision` | string (uuid) | Yes |  |
| `name` | string | Yes |  |
| `description` | string \| null | No | Optional description; null clears it. |
| `definition` | object | Yes | Version 1 Journey Flow definition with anchors, event or page matchers, counting, scope, and exploration settings. Selecting specific sourceIds also requires source:view permission. |
| `definition.version` | number | Yes | One of: `1`. |
| `definition.kind` | string | Yes | One of: `"journey-flow"`. |
| `definition.counting` | string | No | One of: `"unique"`, `"totals"`, `"sessions"`. |
| `definition.reentry` | string | No | One of: `"first"`, `"best"`. |
| `definition.anchors` | object[] | Yes |  |
| `definition.anchors[].id` | string | Yes |  |
| `definition.anchors[].label` | string | No |  |
| `definition.anchors[].alternatives` | object[] | Yes |  |
| `definition.anchors[].filter` | object | No |  |
| `definition.anchors[].filter.version` | number | Yes | One of: `1`. |
| `definition.anchors[].filter.filter` | object | Yes |  |
| `definition.conversionWindowMs` | integer | No |  |
| `definition.contextWindowMs` | integer | No |  |
| `definition.scope` | object | Yes |  |
| `definition.scope.sourceIds` | string[] | Yes |  |
| `definition.scope.excludeBots` | boolean | Yes |  |
| `definition.scope.sessionFilter` | object | No |  |
| `definition.scope.sessionFilter.version` | number | Yes | One of: `1`. |
| `definition.scope.sessionFilter.filter` | object | Yes |  |
| `definition.entryFilter` | object | No |  |
| `definition.entryFilter.version` | number | Yes | One of: `1`. |
| `definition.entryFilter.filter` | object | Yes |  |
| `definition.anchorFilter` | object | No |  |
| `definition.anchorFilter.version` | number | Yes | One of: `1`. |
| `definition.anchorFilter.filter` | object | Yes |  |
| `definition.exploration` | object | Yes |  |
| `definition.exploration.before` | integer | No |  |
| `definition.exploration.after` | integer | No |  |
| `definition.exploration.between` | object[] | No |  |
| `definition.exploration.between[].fromAnchorId` | string | Yes |  |
| `definition.exploration.between[].toAnchorId` | string | Yes |  |
| `definition.exploration.between[].afterFrom` | integer | Yes |  |
| `definition.exploration.between[].beforeTo` | integer | Yes |  |
| `definition.exploration.stepKinds` | string[] | No |  |
| `definition.exploration.pageKey` | string | No | One of: `"path"`, `"url"`. |
| `definition.exploration.pathFilter` | object | No |  |
| `definition.exploration.pathFilter.version` | number | Yes | One of: `1`. |
| `definition.exploration.pathFilter.filter` | object | Yes |  |
| `definition.exploration.hiddenEvents` | object[] | No |  |
| `definition.exploration.collapseRepeats` | boolean | No |  |
| `definition.exploration.focus` | object[] | No |  |
| `definition.exclusions` | object[] | No |  |
| `definition.exclusions[].id` | string | Yes |  |
| `definition.exclusions[].matcher` | object | Yes |  |
| `definition.exclusions[].fromAnchorId` | string | Yes |  |
| `definition.exclusions[].toAnchorId` | string | Yes |  |
| `definition.holdConstant` | object[] | No |  |
| `definition.holdConstant[].property` | string | Yes |  |
| `definition.holdConstant[].path` | string[] | No |  |
| `definition.holdConstant[].type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown` | object | No |  |
| `definition.breakdown.property` | object | Yes |  |
| `definition.breakdown.property.property` | string | Yes |  |
| `definition.breakdown.property.path` | string[] | No |  |
| `definition.breakdown.property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.breakdown.atAnchorId` | string | Yes |  |
| `definition.breakdown.limit` | integer | No |  |
| `definition.nodeExpansions` | object[] | No |  |
| `definition.nodeExpansions[].position` | object | Yes |  |
| `definition.nodeExpansions[].position.anchorId` | string | Yes |  |
| `definition.nodeExpansions[].position.side` | string | Yes | One of: `"anchor"`, `"before"`, `"after"`. |
| `definition.nodeExpansions[].position.offset` | integer | Yes |  |
| `definition.nodeExpansions[].matcher` | object | Yes |  |
| `definition.nodeExpansions[].property` | object | Yes |  |
| `definition.nodeExpansions[].property.property` | string | Yes |  |
| `definition.nodeExpansions[].property.path` | string[] | No |  |
| `definition.nodeExpansions[].property.type` | string | Yes | One of: `"string"`, `"number"`, `"boolean"`. |
| `definition.nodeExpansions[].limit` | integer | No |  |
| `reportContext` | object | Yes | Complete UTC date range and comparisons for this Journey Flow. |
| `reportContext.dateRange` | object | Yes |  |
| `reportContext.dateRange.from` | string | Yes |  |
| `reportContext.dateRange.to` | string | Yes |  |
| `reportContext.dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons` | object[] | No |  |
| `reportContext.comparisons[].id` | string | Yes |  |
| `reportContext.comparisons[].label` | string | Yes |  |
| `reportContext.comparisons[].dateRange` | object | No |  |
| `reportContext.comparisons[].dateRange.from` | string | Yes |  |
| `reportContext.comparisons[].dateRange.to` | string | Yes |  |
| `reportContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `reportContext.comparisons[].entryFilter` | object | No |  |
| `reportContext.comparisons[].entryFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `reportContext.comparisons[].sessionFilter` | object | No |  |
| `reportContext.comparisons[].sessionFilter.version` | number | Yes | One of: `1`. |
| `reportContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `view` | object | Yes | Complete visualization settings. Supplied view replaces the saved value on PATCH. |
| `view.visualization` | string | No | One of: `"sankey"`, `"top-paths"`. |
| `view.topEventsPerPosition` | integer | No |  |
| `view.topPaths` | integer | No |  |
| `view.showDropOff` | boolean | No |  |
| `view.showElapsedTime` | boolean | No |  |
| `createdAt` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `createdByUserId` | string | Yes |  |
| `updatedByUserId` | string | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## DELETE /rest/v1/journey-flows/{id}

Delete a Journey Flow using expectedRevision for optimistic concurrency. The response includes the deleted revision. Requires API-key scope or current OAuth user permission: web-analytics:write

Request URL: `DELETE https://app.oursprivacy.com/rest/v1/journey-flows/{id}`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string (uuid) | Yes |  |
| `expectedRevision` | query | string (uuid) | Yes | Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. |

### Responses

- `200`: Deleted Journey Flow configuration
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Journey Flow not found.
- `409`: Journey Flow revision conflict.
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string (uuid) | Yes |  |
| `deleted` | boolean | Yes | One of: `true`. |
| `deletedRevision` | string \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/journey-flows/capabilities

Return the currently supported Journey Flow counting modes, visualizations, matcher kinds, limits, and unsupported-feature flags. Requires API-key scope or current OAuth user permission: web-analytics:view

Request URL: `GET https://app.oursprivacy.com/rest/v1/journey-flows/capabilities`

Authentication: apiKey or oauth2.

### Responses

- `200`: Supported Journey Flow capabilities
- `400`: Bad Request
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `definitionVersion` | integer | Yes |  |
| `supportedCounting` | string[] | Yes |  |
| `supportedReentry` | string[] | Yes |  |
| `totalsReentry` | string | Yes | One of: `"FIRST"`. |
| `supportedVisualizations` | string[] | Yes |  |
| `supportedMatcherKinds` | string[] | Yes |  |
| `supportedStepKinds` | string[] | Yes |  |
| `supportedProviders` | string[] | Yes |  |
| `maxAnchors` | integer | Yes |  |
| `maxAlternativesPerAnchor` | integer | Yes |  |
| `maxWindowMs` | number | Yes |  |
| `maxPositions` | integer | Yes |  |
| `maxHiddenMatchers` | integer | Yes |  |
| `maxExclusions` | integer | Yes |  |
| `maxHeldProperties` | integer | Yes |  |
| `maxNodeExpansions` | integer | Yes |  |
| `maxComparisons` | integer | Yes |  |
| `maxBuckets` | integer | Yes |  |
| `maxTopPaths` | integer | Yes |  |
| `maxTopEventsPerPosition` | integer | Yes |  |
| `supportsBreakdowns` | boolean | Yes |  |
| `supportsComparisons` | boolean | Yes |  |
| `supportsExclusions` | boolean | Yes |  |
| `supportsNodeExpansions` | boolean | Yes |  |
| `supportsPropertyHolds` | boolean | Yes |  |
| `supportsFocus` | boolean | Yes |  |
| `supportsOutcomeFocus` | boolean | Yes |  |
| `supportsTwoSidedGaps` | boolean | Yes |  |
| `supportsHiddenEvents` | boolean | Yes |  |
| `supportsCollapseRepeats` | boolean | Yes |  |
| `supportsDropOff` | boolean | Yes |  |
| `supportsElapsedTime` | boolean | Yes |  |
| `supportsReplaySamples` | boolean | Yes |  |
| `supportsCsvExport` | boolean | Yes |  |
| `sampleLimitPerOutcome` | integer | Yes |  |
| `supportsNonUtcTimeZones` | boolean | Yes |  |
| `supportsSampling` | boolean | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/journey-flows/preview

Compute a bounded preview from a serialized Journey Flow definition, report context, and view. Use GraphQL when the serialized input exceeds the HTTP URL budget. Reports selecting specific sources also require source:view permission. Requires API-key scope or current OAuth user permission: web-analytics:view

Request URL: `GET https://app.oursprivacy.com/rest/v1/journey-flows/preview`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `input` | query | string | Yes | Object with required definition, reportContext, and view, plus optional refresh. JSON-encode input in the REST query string; maximum 16384 bytes. Object with required definition, reportContext, and view, plus optional refresh. JSON-encode input in the REST query string; maximum 16384 bytes. |

### Responses

- `200`: Preview Journey Flow result
- `400`: Invalid or oversized preview input.
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Not Found
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `definitionRevision` | string \| null (uuid) | No |  |
| `definitionHash` | string | Yes |  |
| `semanticVersion` | string | Yes |  |
| `engine` | string | Yes |  |
| `effectiveContext` | object | Yes |  |
| `effectiveContext.dateRange` | object | Yes |  |
| `effectiveContext.dateRange.from` | string | Yes |  |
| `effectiveContext.dateRange.to` | string | Yes |  |
| `effectiveContext.dateRange.timeZone` | string | Yes |  |
| `effectiveContext.comparisons` | object[] | Yes |  |
| `effectiveContext.comparisons[].id` | string | Yes |  |
| `effectiveContext.comparisons[].label` | string | Yes |  |
| `effectiveContext.comparisons[].dateRange` | object \| null | No |  |
| `effectiveContext.comparisons[].dateRange.from` | string | Yes |  |
| `effectiveContext.comparisons[].dateRange.to` | string | Yes |  |
| `effectiveContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `effectiveContext.comparisons[].entryFilter` | object \| null | No |  |
| `effectiveContext.comparisons[].entryFilter.version` | integer | Yes |  |
| `effectiveContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `effectiveContext.comparisons[].entryFilter.filter.kind` | string | Yes | One of: `"AND"`, `"OR"`, `"NOT"`, `"PREDICATE"`. |
| `effectiveContext.comparisons[].entryFilter.filter.children` | object[] \| null | No |  |
| `effectiveContext.comparisons[].entryFilter.filter.child` | object \| null | No |  |
| `effectiveContext.comparisons[].entryFilter.filter.predicate` | object \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter` | object \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter.version` | integer | Yes |  |
| `effectiveContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `effectiveContext.comparisons[].sessionFilter.filter.kind` | string | Yes | One of: `"AND"`, `"OR"`, `"NOT"`, `"PREDICATE"`. |
| `effectiveContext.comparisons[].sessionFilter.filter.children` | object[] \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter.filter.child` | object \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter.filter.predicate` | object \| null | No |  |
| `effectiveContext.sourceIds` | string[] | Yes |  |
| `effectiveContext.excludeBots` | boolean | Yes |  |
| `effectiveContext.counting` | string | Yes | One of: `"UNIQUE"`, `"TOTALS"`, `"SESSIONS"`. |
| `effectiveContext.reentry` | string | Yes | One of: `"FIRST"`, `"BEST"`. |
| `effectiveContext.conversionWindowMs` | number | Yes |  |
| `effectiveContext.contextWindowMs` | number | Yes |  |
| `observation` | object | Yes |  |
| `observation.entryFrom` | string | Yes |  |
| `observation.entryTo` | string | Yes |  |
| `observation.observationFrom` | string | Yes |  |
| `observation.observationTo` | string | Yes |  |
| `observation.watermark` | string \| null | No |  |
| `observation.retentionBoundary` | string \| null | No |  |
| `observation.complete` | boolean \| null | No |  |
| `observation.status` | string | Yes | One of: `"COMPLETE"`, `"INCOMPLETE"`, `"UNKNOWN"`. |
| `series` | object[] | Yes |  |
| `series[].id` | string | Yes |  |
| `series[].label` | string | Yes |  |
| `series[].segments` | object[] | Yes |  |
| `series[].segments[].id` | string | Yes |  |
| `series[].segments[].label` | string | Yes |  |
| `series[].segments[].entryCount` | string | Yes |  |
| `series[].segments[].unfocusedEntryCount` | string | Yes |  |
| `series[].segments[].completedCount` | string | Yes |  |
| `series[].segments[].timedOutCount` | string \| null | No |  |
| `series[].segments[].excludedCount` | string | Yes |  |
| `series[].segments[].observationIncompleteCount` | string \| null | No |  |
| `series[].segments[].columns` | object[] | Yes |  |
| `series[].segments[].columns[].kind` | string | Yes | One of: `"ANCHOR"`, `"BEFORE"`, `"GAP"`, `"OMITTED"`, `"AFTER"`, `"OUTCOME"`. |
| `series[].segments[].columns[].position` | object | Yes |  |
| `series[].segments[].columns[].position.key` | string | Yes |  |
| `series[].segments[].columns[].position.column` | integer | Yes |  |
| `series[].segments[].columns[].position.anchorId` | string \| null | Yes |  |
| `series[].segments[].columns[].position.side` | string \| null | Yes | One of: `"anchor"`, `"before"`, `"after"`, `null`. |
| `series[].segments[].columns[].position.offset` | number \| null | Yes |  |
| `series[].segments[].columns[].label` | string | Yes |  |
| `series[].segments[].columns[].total` | string | Yes |  |
| `series[].segments[].nodes` | object[] | Yes |  |
| `series[].segments[].nodes[].id` | string | Yes |  |
| `series[].segments[].nodes[].key` | string | Yes |  |
| `series[].segments[].nodes[].position` | object | Yes |  |
| `series[].segments[].nodes[].position.key` | string | Yes |  |
| `series[].segments[].nodes[].position.column` | integer | Yes |  |
| `series[].segments[].nodes[].position.anchorId` | string \| null | Yes |  |
| `series[].segments[].nodes[].position.side` | string \| null | Yes | One of: `"anchor"`, `"before"`, `"after"`, `null`. |
| `series[].segments[].nodes[].position.offset` | number \| null | Yes |  |
| `series[].segments[].nodes[].kind` | string | Yes | One of: `"ANCHOR"`, `"EVENT"`, `"PAGE"`, `"TERMINAL"`, `"OMITTED_STEPS"`, `"OTHER_EVENTS"`. |
| `series[].segments[].nodes[].anchorId` | string \| null | Yes |  |
| `series[].segments[].nodes[].matcher` | object \| null | Yes |  |
| `series[].segments[].nodes[].terminal` | string \| null | No | One of: `"COMPLETED"`, `"INCOMPLETE"`, `null`. |
| `series[].segments[].nodes[].source` | string \| null | No |  |
| `series[].segments[].nodes[].value` | string | Yes |  |
| `series[].segments[].nodes[].count` | string | Yes |  |
| `series[].segments[].nodes[].denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfEntries` | object | Yes |  |
| `series[].segments[].nodes[].shareOfEntries.numerator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfEntries.denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfEntries.value` | number \| null | No |  |
| `series[].segments[].nodes[].shareOfPrevious` | object \| null | No |  |
| `series[].segments[].nodes[].shareOfPrevious.numerator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfPrevious.denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfPrevious.value` | number \| null | No |  |
| `series[].segments[].nodes[].shareOfNext` | object \| null | No |  |
| `series[].segments[].nodes[].shareOfNext.numerator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfNext.denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfNext.value` | number \| null | No |  |
| `series[].segments[].edges` | object[] | Yes |  |
| `series[].segments[].edges[].id` | string | Yes |  |
| `series[].segments[].edges[].sourceNodeId` | string | Yes |  |
| `series[].segments[].edges[].targetNodeId` | string | Yes |  |
| `series[].segments[].edges[].count` | string | Yes |  |
| `series[].segments[].edges[].denominator` | string | Yes |  |
| `series[].segments[].edges[].shareOfPrevious` | object | Yes |  |
| `series[].segments[].edges[].shareOfPrevious.numerator` | string | Yes |  |
| `series[].segments[].edges[].shareOfPrevious.denominator` | string | Yes |  |
| `series[].segments[].edges[].shareOfPrevious.value` | number \| null | No |  |
| `series[].segments[].edges[].shareOfNext` | object \| null | No |  |
| `series[].segments[].edges[].shareOfNext.numerator` | string | Yes |  |
| `series[].segments[].edges[].shareOfNext.denominator` | string | Yes |  |
| `series[].segments[].edges[].shareOfNext.value` | number \| null | No |  |
| `series[].segments[].topPaths` | object[] | Yes |  |
| `series[].segments[].topPaths[].id` | string | Yes |  |
| `series[].segments[].topPaths[].steps` | object[] | Yes |  |
| `series[].segments[].topPaths[].steps[].position` | object | Yes |  |
| `series[].segments[].topPaths[].steps[].kind` | string | Yes | One of: `"ANCHOR"`, `"EVENT"`, `"PAGE"`, `"TERMINAL"`, `"OMITTED_STEPS"`, `"OTHER_EVENTS"`. |
| `series[].segments[].topPaths[].steps[].anchorId` | string \| null | Yes |  |
| `series[].segments[].topPaths[].steps[].matcher` | object \| null | Yes |  |
| `series[].segments[].topPaths[].steps[].terminal` | string \| null | No | One of: `"COMPLETED"`, `"INCOMPLETE"`, `null`. |
| `series[].segments[].topPaths[].steps[].source` | string \| null | No |  |
| `series[].segments[].topPaths[].steps[].value` | string | Yes |  |
| `series[].segments[].topPaths[].weight` | string | Yes |  |
| `series[].segments[].topPaths[].denominator` | string | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries` | object | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries.numerator` | string | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries.denominator` | string | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries.value` | number \| null | No |  |
| `series[].segments[].topPaths[].completedCount` | string | Yes |  |
| `series[].segments[].topPaths[].incompleteCount` | string | Yes |  |
| `series[].segments[].totalPathCount` | string | Yes |  |
| `series[].segments[].returnedPathWeight` | string | Yes |  |
| `series[].segments[].omittedPathWeight` | string | Yes |  |
| `timing` | object[] | Yes |  |
| `timing[].kind` | string | Yes | One of: `"EDGE"`, `"ANCHOR"`, `"OVERALL"`. |
| `timing[].sourceNodeId` | string | Yes |  |
| `timing[].targetNodeId` | string | Yes |  |
| `timing[].fromPosition` | string | Yes |  |
| `timing[].toPosition` | string | Yes |  |
| `timing[].direction` | string | Yes | One of: `"FORWARD"`, `"BACKWARD"`. |
| `timing[].count` | string | Yes |  |
| `timing[].minimumMs` | number \| null | No |  |
| `timing[].medianMs` | number \| null | No |  |
| `timing[].averageMs` | number \| null | No |  |
| `timing[].maximumMs` | number \| null | No |  |
| `samples` | object | Yes |  |
| `samples.limitPerOutcome` | integer | Yes |  |
| `samples.entries` | object[] | Yes |  |
| `samples.entries[].visitorId` | string | Yes |  |
| `samples.entries[].sessionId` | string \| null | Yes |  |
| `samples.entries[].entryAt` | string | Yes |  |
| `samples.entries[].lastAnchorAt` | string | Yes |  |
| `samples.entries[].sessionStartDate` | string \| null (date) | Yes |  |
| `samples.entries[].reachedAnchors` | integer | Yes |  |
| `samples.entries[].outcome` | string | Yes | One of: `"COMPLETED"`, `"INCOMPLETE"`. |
| `limits` | object | Yes |  |
| `limits.topEventsPerPosition` | integer | Yes |  |
| `limits.topPaths` | integer | Yes |  |
| `limits.omittedNodeCount` | string \| null | No |  |
| `limits.omittedNodeWeight` | string \| null | No |  |
| `limits.omittedPathCount` | string | Yes |  |
| `limits.omittedPathWeight` | string | Yes |  |
| `limits.executionLimitStatus` | string \| null | No |  |
| `execution` | object | Yes |  |
| `execution.queryId` | string (uuid) | Yes |  |
| `execution.generatedAt` | string | Yes |  |
| `execution.cacheHit` | boolean | Yes |  |
| `execution.cacheAgeMs` | number \| null | No |  |
| `execution.sampled` | boolean | Yes |  |
| `execution.warnings` | object[] | Yes |  |
| `execution.warnings[].code` | string | Yes |  |
| `execution.warnings[].message` | string | Yes |  |
| `execution.warnings[].path` | string[] \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/journey-flows/{id}/result

Compute a saved Journey Flow result. Pass refresh=true to recompute instead of serving a cached result for identical inputs. Requires expectedRevision and permits an optional complete report context override. Reports selecting specific sources also require source:view permission. Requires API-key scope or current OAuth user permission: web-analytics:view

Request URL: `GET https://app.oursprivacy.com/rest/v1/journey-flows/{id}/result`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string (uuid) | Yes |  |
| `expectedRevision` | query | string (uuid) | Yes | Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. |
| `reportContextOverride` | query | string | No | Complete report context override; JSON-encoded in the REST query string. Complete report context override; JSON-encoded in the REST query string. |
| `refresh` | query | boolean | No | Recompute instead of serving a cached result for identical inputs. Recompute instead of serving a cached result for identical inputs. |

### Responses

- `200`: Saved Journey Flow result
- `400`: Invalid Journey Flow context or compiler semantics.
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Journey Flow not found.
- `409`: Journey Flow revision conflict.
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `definitionRevision` | string \| null (uuid) | No |  |
| `definitionHash` | string | Yes |  |
| `semanticVersion` | string | Yes |  |
| `engine` | string | Yes |  |
| `effectiveContext` | object | Yes |  |
| `effectiveContext.dateRange` | object | Yes |  |
| `effectiveContext.dateRange.from` | string | Yes |  |
| `effectiveContext.dateRange.to` | string | Yes |  |
| `effectiveContext.dateRange.timeZone` | string | Yes |  |
| `effectiveContext.comparisons` | object[] | Yes |  |
| `effectiveContext.comparisons[].id` | string | Yes |  |
| `effectiveContext.comparisons[].label` | string | Yes |  |
| `effectiveContext.comparisons[].dateRange` | object \| null | No |  |
| `effectiveContext.comparisons[].dateRange.from` | string | Yes |  |
| `effectiveContext.comparisons[].dateRange.to` | string | Yes |  |
| `effectiveContext.comparisons[].dateRange.timeZone` | string | Yes |  |
| `effectiveContext.comparisons[].entryFilter` | object \| null | No |  |
| `effectiveContext.comparisons[].entryFilter.version` | integer | Yes |  |
| `effectiveContext.comparisons[].entryFilter.filter` | object | Yes |  |
| `effectiveContext.comparisons[].entryFilter.filter.kind` | string | Yes | One of: `"AND"`, `"OR"`, `"NOT"`, `"PREDICATE"`. |
| `effectiveContext.comparisons[].entryFilter.filter.children` | object[] \| null | No |  |
| `effectiveContext.comparisons[].entryFilter.filter.child` | object \| null | No |  |
| `effectiveContext.comparisons[].entryFilter.filter.predicate` | object \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter` | object \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter.version` | integer | Yes |  |
| `effectiveContext.comparisons[].sessionFilter.filter` | object | Yes |  |
| `effectiveContext.comparisons[].sessionFilter.filter.kind` | string | Yes | One of: `"AND"`, `"OR"`, `"NOT"`, `"PREDICATE"`. |
| `effectiveContext.comparisons[].sessionFilter.filter.children` | object[] \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter.filter.child` | object \| null | No |  |
| `effectiveContext.comparisons[].sessionFilter.filter.predicate` | object \| null | No |  |
| `effectiveContext.sourceIds` | string[] | Yes |  |
| `effectiveContext.excludeBots` | boolean | Yes |  |
| `effectiveContext.counting` | string | Yes | One of: `"UNIQUE"`, `"TOTALS"`, `"SESSIONS"`. |
| `effectiveContext.reentry` | string | Yes | One of: `"FIRST"`, `"BEST"`. |
| `effectiveContext.conversionWindowMs` | number | Yes |  |
| `effectiveContext.contextWindowMs` | number | Yes |  |
| `observation` | object | Yes |  |
| `observation.entryFrom` | string | Yes |  |
| `observation.entryTo` | string | Yes |  |
| `observation.observationFrom` | string | Yes |  |
| `observation.observationTo` | string | Yes |  |
| `observation.watermark` | string \| null | No |  |
| `observation.retentionBoundary` | string \| null | No |  |
| `observation.complete` | boolean \| null | No |  |
| `observation.status` | string | Yes | One of: `"COMPLETE"`, `"INCOMPLETE"`, `"UNKNOWN"`. |
| `series` | object[] | Yes |  |
| `series[].id` | string | Yes |  |
| `series[].label` | string | Yes |  |
| `series[].segments` | object[] | Yes |  |
| `series[].segments[].id` | string | Yes |  |
| `series[].segments[].label` | string | Yes |  |
| `series[].segments[].entryCount` | string | Yes |  |
| `series[].segments[].unfocusedEntryCount` | string | Yes |  |
| `series[].segments[].completedCount` | string | Yes |  |
| `series[].segments[].timedOutCount` | string \| null | No |  |
| `series[].segments[].excludedCount` | string | Yes |  |
| `series[].segments[].observationIncompleteCount` | string \| null | No |  |
| `series[].segments[].columns` | object[] | Yes |  |
| `series[].segments[].columns[].kind` | string | Yes | One of: `"ANCHOR"`, `"BEFORE"`, `"GAP"`, `"OMITTED"`, `"AFTER"`, `"OUTCOME"`. |
| `series[].segments[].columns[].position` | object | Yes |  |
| `series[].segments[].columns[].position.key` | string | Yes |  |
| `series[].segments[].columns[].position.column` | integer | Yes |  |
| `series[].segments[].columns[].position.anchorId` | string \| null | Yes |  |
| `series[].segments[].columns[].position.side` | string \| null | Yes | One of: `"anchor"`, `"before"`, `"after"`, `null`. |
| `series[].segments[].columns[].position.offset` | number \| null | Yes |  |
| `series[].segments[].columns[].label` | string | Yes |  |
| `series[].segments[].columns[].total` | string | Yes |  |
| `series[].segments[].nodes` | object[] | Yes |  |
| `series[].segments[].nodes[].id` | string | Yes |  |
| `series[].segments[].nodes[].key` | string | Yes |  |
| `series[].segments[].nodes[].position` | object | Yes |  |
| `series[].segments[].nodes[].position.key` | string | Yes |  |
| `series[].segments[].nodes[].position.column` | integer | Yes |  |
| `series[].segments[].nodes[].position.anchorId` | string \| null | Yes |  |
| `series[].segments[].nodes[].position.side` | string \| null | Yes | One of: `"anchor"`, `"before"`, `"after"`, `null`. |
| `series[].segments[].nodes[].position.offset` | number \| null | Yes |  |
| `series[].segments[].nodes[].kind` | string | Yes | One of: `"ANCHOR"`, `"EVENT"`, `"PAGE"`, `"TERMINAL"`, `"OMITTED_STEPS"`, `"OTHER_EVENTS"`. |
| `series[].segments[].nodes[].anchorId` | string \| null | Yes |  |
| `series[].segments[].nodes[].matcher` | object \| null | Yes |  |
| `series[].segments[].nodes[].terminal` | string \| null | No | One of: `"COMPLETED"`, `"INCOMPLETE"`, `null`. |
| `series[].segments[].nodes[].source` | string \| null | No |  |
| `series[].segments[].nodes[].value` | string | Yes |  |
| `series[].segments[].nodes[].count` | string | Yes |  |
| `series[].segments[].nodes[].denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfEntries` | object | Yes |  |
| `series[].segments[].nodes[].shareOfEntries.numerator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfEntries.denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfEntries.value` | number \| null | No |  |
| `series[].segments[].nodes[].shareOfPrevious` | object \| null | No |  |
| `series[].segments[].nodes[].shareOfPrevious.numerator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfPrevious.denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfPrevious.value` | number \| null | No |  |
| `series[].segments[].nodes[].shareOfNext` | object \| null | No |  |
| `series[].segments[].nodes[].shareOfNext.numerator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfNext.denominator` | string | Yes |  |
| `series[].segments[].nodes[].shareOfNext.value` | number \| null | No |  |
| `series[].segments[].edges` | object[] | Yes |  |
| `series[].segments[].edges[].id` | string | Yes |  |
| `series[].segments[].edges[].sourceNodeId` | string | Yes |  |
| `series[].segments[].edges[].targetNodeId` | string | Yes |  |
| `series[].segments[].edges[].count` | string | Yes |  |
| `series[].segments[].edges[].denominator` | string | Yes |  |
| `series[].segments[].edges[].shareOfPrevious` | object | Yes |  |
| `series[].segments[].edges[].shareOfPrevious.numerator` | string | Yes |  |
| `series[].segments[].edges[].shareOfPrevious.denominator` | string | Yes |  |
| `series[].segments[].edges[].shareOfPrevious.value` | number \| null | No |  |
| `series[].segments[].edges[].shareOfNext` | object \| null | No |  |
| `series[].segments[].edges[].shareOfNext.numerator` | string | Yes |  |
| `series[].segments[].edges[].shareOfNext.denominator` | string | Yes |  |
| `series[].segments[].edges[].shareOfNext.value` | number \| null | No |  |
| `series[].segments[].topPaths` | object[] | Yes |  |
| `series[].segments[].topPaths[].id` | string | Yes |  |
| `series[].segments[].topPaths[].steps` | object[] | Yes |  |
| `series[].segments[].topPaths[].steps[].position` | object | Yes |  |
| `series[].segments[].topPaths[].steps[].kind` | string | Yes | One of: `"ANCHOR"`, `"EVENT"`, `"PAGE"`, `"TERMINAL"`, `"OMITTED_STEPS"`, `"OTHER_EVENTS"`. |
| `series[].segments[].topPaths[].steps[].anchorId` | string \| null | Yes |  |
| `series[].segments[].topPaths[].steps[].matcher` | object \| null | Yes |  |
| `series[].segments[].topPaths[].steps[].terminal` | string \| null | No | One of: `"COMPLETED"`, `"INCOMPLETE"`, `null`. |
| `series[].segments[].topPaths[].steps[].source` | string \| null | No |  |
| `series[].segments[].topPaths[].steps[].value` | string | Yes |  |
| `series[].segments[].topPaths[].weight` | string | Yes |  |
| `series[].segments[].topPaths[].denominator` | string | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries` | object | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries.numerator` | string | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries.denominator` | string | Yes |  |
| `series[].segments[].topPaths[].shareOfEntries.value` | number \| null | No |  |
| `series[].segments[].topPaths[].completedCount` | string | Yes |  |
| `series[].segments[].topPaths[].incompleteCount` | string | Yes |  |
| `series[].segments[].totalPathCount` | string | Yes |  |
| `series[].segments[].returnedPathWeight` | string | Yes |  |
| `series[].segments[].omittedPathWeight` | string | Yes |  |
| `timing` | object[] | Yes |  |
| `timing[].kind` | string | Yes | One of: `"EDGE"`, `"ANCHOR"`, `"OVERALL"`. |
| `timing[].sourceNodeId` | string | Yes |  |
| `timing[].targetNodeId` | string | Yes |  |
| `timing[].fromPosition` | string | Yes |  |
| `timing[].toPosition` | string | Yes |  |
| `timing[].direction` | string | Yes | One of: `"FORWARD"`, `"BACKWARD"`. |
| `timing[].count` | string | Yes |  |
| `timing[].minimumMs` | number \| null | No |  |
| `timing[].medianMs` | number \| null | No |  |
| `timing[].averageMs` | number \| null | No |  |
| `timing[].maximumMs` | number \| null | No |  |
| `samples` | object | Yes |  |
| `samples.limitPerOutcome` | integer | Yes |  |
| `samples.entries` | object[] | Yes |  |
| `samples.entries[].visitorId` | string | Yes |  |
| `samples.entries[].sessionId` | string \| null | Yes |  |
| `samples.entries[].entryAt` | string | Yes |  |
| `samples.entries[].lastAnchorAt` | string | Yes |  |
| `samples.entries[].sessionStartDate` | string \| null (date) | Yes |  |
| `samples.entries[].reachedAnchors` | integer | Yes |  |
| `samples.entries[].outcome` | string | Yes | One of: `"COMPLETED"`, `"INCOMPLETE"`. |
| `limits` | object | Yes |  |
| `limits.topEventsPerPosition` | integer | Yes |  |
| `limits.topPaths` | integer | Yes |  |
| `limits.omittedNodeCount` | string \| null | No |  |
| `limits.omittedNodeWeight` | string \| null | No |  |
| `limits.omittedPathCount` | string | Yes |  |
| `limits.omittedPathWeight` | string | Yes |  |
| `limits.executionLimitStatus` | string \| null | No |  |
| `execution` | object | Yes |  |
| `execution.queryId` | string (uuid) | Yes |  |
| `execution.generatedAt` | string | Yes |  |
| `execution.cacheHit` | boolean | Yes |  |
| `execution.cacheAgeMs` | number \| null | No |  |
| `execution.sampled` | boolean | Yes |  |
| `execution.warnings` | object[] | Yes |  |
| `execution.warnings[].code` | string | Yes |  |
| `execution.warnings[].message` | string | Yes |  |
| `execution.warnings[].path` | string[] \| null | No |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## GET /rest/v1/journey-flows/{id}/export

Export the saved Journey Flow as CSV with its effective scope, exact aggregate counts, timing, graph and bounded Top Paths. Requires expectedRevision; display limits and omitted path weight are included. The response contains the CSV content and filename. Visitor and session samples are not included. Reports selecting specific sources also require source:view permission. Requires API-key scope or current OAuth user permission: web-analytics:view

Request URL: `GET https://app.oursprivacy.com/rest/v1/journey-flows/{id}/export`

Authentication: apiKey or oauth2.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string (uuid) | Yes |  |
| `expectedRevision` | query | string (uuid) | Yes | Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. Revision returned by get/list or the last write. A stale revision returns 409; reload before retrying. |
| `reportContextOverride` | query | string | No | Complete report context override; JSON-encoded in the REST query string. Complete report context override; JSON-encoded in the REST query string. |
| `refresh` | query | boolean | No | Recompute instead of serving a cached result for identical inputs. Recompute instead of serving a cached result for identical inputs. |

### Responses

- `200`: Journey Flow CSV content and result identity
- `400`: Invalid Journey Flow context or semantics.
- `401`: Unauthorized — missing, invalid, or expired API key or OAuth access token
- `403`: Forbidden — credential does not have the required current Ours permission
- `404`: Journey Flow not found.
- `409`: Journey Flow revision conflict.
- `500`: Internal Server Error

#### `200` response body

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `filename` | string | Yes |  |
| `contentType` | string | Yes | One of: `"text/csv; charset=utf-8"`. |
| `content` | string | Yes |  |
| `definitionRevision` | string (uuid) | Yes |  |
| `definitionHash` | string | Yes |  |
| `generatedAt` | string | Yes |  |

Full schema: [OpenAPI specification](https://docs.oursprivacy.com/openapi-platform.json).

## Next Steps

* [Web Analytics API](https://docs.oursprivacy.com/docs/platform-api/web-analytics)
* [Funnels API](https://docs.oursprivacy.com/docs/platform-api/funnels)
