PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/web-campaignsWeb campaigns
POST/v1/apps/{appId}/web-campaignsCreate 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}/reportDaily series
POST/v1/apps/{appId}/web-campaigns/{campaignId}/statusPublish / pause / archive
POST/v1/apps/{appId}/web-campaigns/{campaignId}/winnerSelect the A/B winner (the SDK then serves only the winning view)

Details

Web campaigns

GET/v1/apps/{appId}/web-campaignsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "draft", "active", "paused", "archived""draft"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebCampaignPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].priorityintegerYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
data[].display.positionenumNoValues: "left", "right"
data[].display.background_colorstringNo
data[].display.text_colorstringNo
data[].display.dismissiblebooleanNo
data[].display.auto_dismiss_secondsintegerNoRange: 1–300
data[].display.max_widthintegerNoRange: 280–960
data[].display.blocksarray<object>YesItems: 0–12
data[].display.form_idstring | nullNo
data[].display.survey_idstring | nullNo
data[].variantsarray<object>Yes
data[].variants[].idstringYesLength: 1–64
data[].variants[].namestringYesLength: 1–60
data[].variants[].weight_percentintegerYesRange: 1–99
data[].variants[].displayobjectYes
data[].ab_testobjectYes
data[].ab_test.winner_variant_idstring | nullYes
data[].ab_test.decided_atstring | nullYes
data[].ab_test.decided_bystring | nullYes
data[].triggerobjectYes
data[].conditionsobjectYes
data[].conditions.url_rulesarray<object>NoItems: 0–10
data[].conditions.utm_rulesarray<object>NoItems: 0–5
data[].conditions.visitsobjectNo
data[].targetingobjectYes
data[].targeting.included_segmentsarray<string>NoItems: 0–20
data[].targeting.excluded_segmentsarray<string>NoItems: 0–20
data[].targeting.visitorenumNoValues: "all", "new", "returning"
data[].targeting.devicesarray<enum>NoItems: 0–3
data[].frequencyobjectYes
data[].frequency.max_per_sessionintegerNoRange: 1–100
data[].frequency.max_per_dayintegerNoRange: 1–100
data[].frequency.max_totalintegerNoRange: 1–1000
data[].frequency.hide_after_close_daysintegerNoRange: 0–365
data[].frequency.stop_after_conversionbooleanNo
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].statsobjectYes
data[].stats.impressionsintegerYes
data[].stats.clicksintegerYes
data[].stats.closesintegerYes
data[].stats.conversionsintegerYes
data[].stats.unique_visitorsintegerYes
data[].stats.ctrnumberYes
data[].stats.conversion_ratenumberYes
data[].variant_statsarray<object>Yes
data[].variant_stats[].variant_idstringYes
data[].variant_stats[].impressionsintegerYes
data[].variant_stats[].clicksintegerYes
data[].variant_stats[].conversionsintegerYes
data[].variant_stats[].ctrnumberYes
data[].variant_stats[].conversion_ratenumberYes
data[].variant_significanceobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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)

POST/v1/apps/{appId}/web-campaignsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWebCampaignDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
triggerobjectYes
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectNo
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/web-campaigns/{campaignId}Try it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebCampaign

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/web-campaigns/{campaignId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWebCampaignDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
displayobjectNo
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
triggerobjectNo
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectNo
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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)

DELETE/v1/apps/{appId}/web-campaigns/{campaignId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/web-campaigns/{campaignId}/reportTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
daysqueryintegerNoRange: 1–3651
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebCampaignReport

FieldTypeRequiredDescription
campaign_idstringYes
daysintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].impressionsintegerYes
daily[].clicksintegerYes
daily[].closesintegerYes
daily[].conversionsintegerYes
totalsobjectYes
totals.impressionsintegerYes
totals.clicksintegerYes
totals.closesintegerYes
totals.conversionsintegerYes
totals.unique_visitorsintegerYes
totals.ctrnumberYes
totals.conversion_ratenumberYes

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

POST/v1/apps/{appId}/web-campaigns/{campaignId}/statusTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: WebCampaignStatusDto

FieldTypeRequiredDescription
statusenumYesValues: "draft", "active", "paused", "archived"

Example:

{
  "status": "draft"
}

Responses

200 — Success.

Schema: WebCampaign

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/web-campaigns/{campaignId}/winnerTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: WebCampaignWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–64

Example:

{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: WebCampaign

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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"
}'

On this page