Web personalization
Web personalization — 8 operations (GET /v1/apps/{appId}/web-personalizations, POST /v1/apps/{appId}/web-personalizations, GET /v1/apps/{appId}/web-personalizations/{personalizationId}, …). Generated from the OpenAPI 3.1.0 contract.
Experiences that change elements on your site (CSS selectors) per visitor: text, image, link, hide/show; page conditions, audience and segment targeting, A/B (control group), conversion goal and daily report. Changes are applied by the Web SDK; no HTML is written. Requires the Growth+ plan.
Base URL: https://api.pushizo.com · Tag: web-personalizations · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/web-personalizations | Web personalization experiences |
POST | /v1/apps/{appId}/web-personalizations | Create a personalization experience (draft) |
GET | /v1/apps/{appId}/web-personalizations/{personalizationId} | Personalization experience details and statistics |
PATCH | /v1/apps/{appId}/web-personalizations/{personalizationId} | Edit a personalization experience |
DELETE | /v1/apps/{appId}/web-personalizations/{personalizationId} | Delete a personalization experience (along with its events) |
GET | /v1/apps/{appId}/web-personalizations/{personalizationId}/report | Daily series |
POST | /v1/apps/{appId}/web-personalizations/{personalizationId}/status | Publish / pause / archive |
POST | /v1/apps/{appId}/web-personalizations/{personalizationId}/winner | Select the A/B winner (the SDK then applies only the winner's changes) |
Details
Web personalization experiences
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
status | query | enum | No | Values: "draft", "active", "paused", "archived" | "draft" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebPersonalizationPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].priority | integer | Yes | |
data[].changes | array<object> | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | Length: 1–64 |
data[].variants[].name | string | Yes | Length: 1–60 |
data[].variants[].weight_percent | integer | Yes | Range: 1–99 |
data[].variants[].changes | array<object> | Yes | Items: 0–20 |
data[].ab_test | object | Yes | |
data[].ab_test.winner_variant_id | string | null | Yes | |
data[].ab_test.decided_at | string | null | Yes | |
data[].ab_test.decided_by | string | null | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.included_segments | array<string> | No | Items: 0–20 |
data[].targeting.excluded_segments | array<string> | No | Items: 0–20 |
data[].targeting.visitor | enum | No | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | No | Items: 0–3 |
data[].goal | object | null | Yes | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.visitors | integer | Yes | |
data[].stats.conversions | integer | Yes | |
data[].stats.conversion_rate | number | Yes | |
data[].variant_stats | array<object> | Yes | |
data[].variant_stats[].visitors | integer | Yes | |
data[].variant_stats[].conversions | integer | Yes | |
data[].variant_stats[].conversion_rate | number | Yes | |
data[].variant_stats[].variant_id | string | Yes | |
data[].variant_significance | object | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": []
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{}
],
"utm_rules": [
{}
]
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a personalization experience (draft)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateWebPersonalizationDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
changes | array<object> | No | Items: 0–20 |
variants | array<object> | No | Items: 0–4 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
},
"goal": {
"type": "event",
"event": "purchase"
}
}Responses
201 — Success.
Schema: WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
},
"goal": {
"type": "event",
"event": "purchase"
}
}'Personalization experience details and statistics
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Edit a personalization experience
/v1/apps/{appId}/web-personalizations/{personalizationId}Try it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWebPersonalizationDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
changes | array<object> | No | Items: 0–20 |
variants | array<object> | No | Items: 0–4 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
}
}Responses
200 — Success.
Schema: WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
}
}'Delete a personalization experience (along with its events)
/v1/apps/{appId}/web-personalizations/{personalizationId}Try it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Daily series
/v1/apps/{appId}/web-personalizations/{personalizationId}/reportTry it (interactive API docs, new tab)Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
days | query | integer | No | Range: 1–365 | 1 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebPersonalizationReport
| Field | Type | Required | Description |
|---|---|---|---|
personalization_id | string | Yes | |
days | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].visitors | integer | Yes | |
daily[].conversions | integer | Yes | |
totals | object | Yes | |
totals.visitors | integer | Yes | |
totals.conversions | integer | Yes | |
totals.conversion_rate | number | Yes |
Example response:
{
"personalization_id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"days": 1,
"daily": [
{
"date": "örnek",
"visitors": 1,
"conversions": 1
}
],
"totals": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/report" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Publish / pause / archive
/v1/apps/{appId}/web-personalizations/{personalizationId}/statusTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WebPersonalizationStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
Example:
{
"status": "draft"
}Responses
200 — Success.
Schema: WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/status" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "draft"
}'Select the A/B winner (the SDK then applies only the winner's changes)
/v1/apps/{appId}/web-personalizations/{personalizationId}/winnerTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WebPersonalizationWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–64 |
Example:
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Web campaigns (pop-up, banner)
Web campaigns (pop-up, banner) — 8 operations (GET /v1/apps/{appId}/web-campaigns, POST /v1/apps/{appId}/web-campaigns, GET /v1/apps/{appId}/web-campaigns/{campaignId}, …). Generated from the OpenAPI 3.1.0 contract.
Site search
Site search — 11 operations (GET /v1/apps/{appId}/site-search, PATCH /v1/apps/{appId}/site-search/settings, GET /v1/apps/{appId}/site-search/sources, …). Generated from the OpenAPI 3.1.0 contract.