CDPConsentExperimentationGuidesSupport

Conversion Journey Summaries

Create, list, retrieve, update, and delete saved Conversion Journey Summary configurations through the Ours Privacy REST API.

BetaThis is in beta. The basics are stable, and more capabilities are on the way.

Create, list, retrieve, update, and delete saved Conversion Journey Summary configurations. Each saved summary preserves the conversion event, analysis window, filters, and source settings for a journey analysis.

GET
/rest/v1/conversion-journey-summaries

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

limit?|

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?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/conversion-journey-summaries"
{  "entities": [    {      "summaryId": "34e22033-2566-446b-a658-ac29eb10a36c",      "name": "string",      "eventName": "string",      "windowDays": 0,      "filters": [        {          "dimension": "browser",          "operator": "CONTAINS",          "values": [            "string"          ]        }      ],      "dateFrom": "string",      "dateTo": "string",      "webSourceId": "string",      "excludeBots": true,      "createdAt": "string",      "updatedAt": "string"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
POST
/rest/v1/conversion-journey-summaries
*object
array<object>

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/rest/v1/conversion-journey-summaries" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "eventName": "string",    "windowDays": 1,    "dateFrom": "2026-06-01",    "dateTo": "2026-06-30"  }'
{  "summaryId": "34e22033-2566-446b-a658-ac29eb10a36c",  "name": "string",  "eventName": "string",  "windowDays": 0,  "filters": [    {      "dimension": "browser",      "operator": "CONTAINS",      "values": [        "string"      ]    }  ],  "dateFrom": "string",  "dateTo": "string",  "webSourceId": "string",  "excludeBots": true,  "createdAt": "string",  "updatedAt": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
GET
/rest/v1/conversion-journey-summaries/{id}

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/conversion-journey-summaries/string"
{  "summaryId": "34e22033-2566-446b-a658-ac29eb10a36c",  "name": "string",  "eventName": "string",  "windowDays": 0,  "filters": [    {      "dimension": "browser",      "operator": "CONTAINS",      "values": [        "string"      ]    }  ],  "dateFrom": "string",  "dateTo": "string",  "webSourceId": "string",  "excludeBots": true,  "createdAt": "string",  "updatedAt": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
PATCH
/rest/v1/conversion-journey-summaries/{id}
*object
array<object>

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/rest/v1/conversion-journey-summaries/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "summaryId": "34e22033-2566-446b-a658-ac29eb10a36c",  "name": "string",  "eventName": "string",  "windowDays": 0,  "filters": [    {      "dimension": "browser",      "operator": "CONTAINS",      "values": [        "string"      ]    }  ],  "dateFrom": "string",  "dateTo": "string",  "webSourceId": "string",  "excludeBots": true,  "createdAt": "string",  "updatedAt": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
DELETE
/rest/v1/conversion-journey-summaries/{id}

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/rest/v1/conversion-journey-summaries/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "deleted": true}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}

How is this guide?

Attribution (Beta)

Previous Page

Funnels

Next Page