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.
Pop-up, banner, slide-in and full-screen campaigns shown on your site: triggers (page, time, scroll, exit intent), targeting, frequency, A/B and daily statistics. Rendering is handled by the Web SDK.
Base URL: https://api.pushizo.com · Tag: web-campaigns · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/web-campaigns | Web campaigns |
POST | /v1/apps/{appId}/web-campaigns | Create a web campaign (draft) |
GET | /v1/apps/{appId}/web-campaigns/{campaignId} | Web campaign details and statistics |
PATCH | /v1/apps/{appId}/web-campaigns/{campaignId} | Edit a web campaign |
DELETE | /v1/apps/{appId}/web-campaigns/{campaignId} | Delete a web campaign (along with its events) |
GET | /v1/apps/{appId}/web-campaigns/{campaignId}/report | Daily series |
POST | /v1/apps/{appId}/web-campaigns/{campaignId}/status | Publish / pause / archive |
POST | /v1/apps/{appId}/web-campaigns/{campaignId}/winner | Select the A/B winner (the SDK then serves only the winning view) |
Details
Web campaigns
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: WebCampaignPage
| 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[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
data[].display.position | enum | No | Values: "left", "right" |
data[].display.background_color | string | No | |
data[].display.text_color | string | No | |
data[].display.dismissible | boolean | No | |
data[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
data[].display.max_width | integer | No | Range: 280–960 |
data[].display.blocks | array<object> | Yes | Items: 0–12 |
data[].display.form_id | string | null | No | |
data[].display.survey_id | string | null | No | |
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[].display | object | Yes | |
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[].trigger | object | 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[].frequency | object | Yes | |
data[].frequency.max_per_session | integer | No | Range: 1–100 |
data[].frequency.max_per_day | integer | No | Range: 1–100 |
data[].frequency.max_total | integer | No | Range: 1–1000 |
data[].frequency.hide_after_close_days | integer | No | Range: 0–365 |
data[].frequency.stop_after_conversion | boolean | No | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.impressions | integer | Yes | |
data[].stats.clicks | integer | Yes | |
data[].stats.closes | integer | Yes | |
data[].stats.conversions | integer | Yes | |
data[].stats.unique_visitors | integer | Yes | |
data[].stats.ctr | number | Yes | |
data[].stats.conversion_rate | number | Yes | |
data[].variant_stats | array<object> | Yes | |
data[].variant_stats[].variant_id | string | Yes | |
data[].variant_stats[].impressions | integer | Yes | |
data[].variant_stats[].clicks | integer | Yes | |
data[].variant_stats[].conversions | integer | Yes | |
data[].variant_stats[].ctr | number | Yes | |
data[].variant_stats[].conversion_rate | number | 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": "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"conditions": {
"url_rules": [
{}
],
"utm_rules": [
{}
]
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"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-campaigns?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a web campaign (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: CreateWebCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
trigger | object | Yes | |
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 |
frequency | object | No | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | 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",
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left"
}
}
],
"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"
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1
},
"priority": 10
}Responses
201 — Success.
Schema: WebCampaign
| 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 | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
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[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
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 | |
trigger | object | 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 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"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"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1,
"hide_after_close_days": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"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-campaigns" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left"
}
}
],
"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"
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1
},
"priority": 10
}'Web campaign details and statistics
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebCampaign
| 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 | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
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[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
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 | |
trigger | object | 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 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"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"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1,
"hide_after_close_days": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"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-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Edit a web campaign
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWebCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
display | object | No | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
trigger | object | No | |
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 |
frequency | object | No | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | 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",
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left"
}
}
],
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
}
}Responses
200 — Success.
Schema: WebCampaign
| 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 | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
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[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
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 | |
trigger | object | 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 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"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"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1,
"hide_after_close_days": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"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-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left"
}
}
],
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
}
}'Delete a web campaign (along with its events)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "wcp_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-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Daily series
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
days | query | integer | No | Range: 1–365 | 1 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebCampaignReport
| Field | Type | Required | Description |
|---|---|---|---|
campaign_id | string | Yes | |
days | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].impressions | integer | Yes | |
daily[].clicks | integer | Yes | |
daily[].closes | integer | Yes | |
daily[].conversions | integer | Yes | |
totals | object | Yes | |
totals.impressions | integer | Yes | |
totals.clicks | integer | Yes | |
totals.closes | integer | Yes | |
totals.conversions | integer | Yes | |
totals.unique_visitors | integer | Yes | |
totals.ctr | number | Yes | |
totals.conversion_rate | number | Yes |
Example response:
{
"campaign_id": "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"days": 1,
"daily": [
{
"date": "örnek",
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1
}
],
"totals": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"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-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W/report" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Publish / pause / archive
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WebCampaignStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
Example:
{
"status": "draft"
}Responses
200 — Success.
Schema: WebCampaign
| 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 | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
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[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
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 | |
trigger | object | 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 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"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"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1,
"hide_after_close_days": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"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-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W/status" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "draft"
}'Select the A/B winner (the SDK then serves only the winning view)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WebCampaignWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–64 |
Example:
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: WebCampaign
| 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 | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
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[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
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 | |
trigger | object | 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 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"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"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1,
"hide_after_close_days": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"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-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Ads (audiences, campaigns, attribution)
Ads (audiences, campaigns, attribution) — 33 operations (GET /v1/apps/{appId}/ads/platforms, GET /v1/apps/{appId}/ads/accounts, GET /v1/apps/{appId}/ads/audiences, …). Generated from the OpenAPI 3.1.0 contract.
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.