Web kampanyaları (pop-up, banner)

Web kampanyaları (pop-up, banner) — 6 işlem (GET /v1/apps/{appId}/web-campaigns, POST /v1/apps/{appId}/web-campaigns, GET /v1/apps/{appId}/web-campaigns/{campaignId}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Sitede gösterilen pop-up, banner, slide-in ve tam ekran kampanyalar: tetik (sayfa, süre, kaydırma, çıkış niyeti), hedefleme, sıklık, A/B ve günlük istatistikler. Gösterimi Web SDK yapar.

Taban adres: https://api.pushizo.com · Etiket: web-campaigns · Etkileşimli belge (Scalar)

İşlemler

Yöntem	Yol	İşlem
`GET`	`/v1/apps/{appId}/web-campaigns`	Web kampanyaları
`POST`	`/v1/apps/{appId}/web-campaigns`	Web kampanyası oluştur (taslak)
`GET`	`/v1/apps/{appId}/web-campaigns/{campaignId}`	Web kampanyası detayı ve istatistikleri
`PATCH`	`/v1/apps/{appId}/web-campaigns/{campaignId}`	Web kampanyasını düzenle
`GET`	`/v1/apps/{appId}/web-campaigns/{campaignId}/report`	Günlük seri
`POST`	`/v1/apps/{appId}/web-campaigns/{campaignId}/status`	Yayınla / duraklat / arşivle

Ayrıntılar

Web kampanyaları

GET/v1/apps/{appId}/web-campaignsDene

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`limit`	sorgu	`integer`	Hayır	Varsayılan: `50`; Aralık: 1–200	`50`
`cursor`	sorgu	`string`	Hayır	Uzunluk: 1–∞	`"eyJpZCI6Im1zZ18wMUpE…"`
`status`	sorgu	`enum`	Hayır	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`	`"draft"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: WebCampaignPage

Alan	Tür	Zorunlu	Açıklama
`data`	`array<object>`	Evet
`data[].id`	`string`	Evet
`data[].app_id`	`string`	Evet
`data[].name`	`string`	Evet
`data[].status`	`enum`	Evet	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`
`data[].priority`	`integer`	Evet
`data[].display`	`object`	Evet
`data[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`data[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`data[].display.background_color`	`string`	Hayır
`data[].display.text_color`	`string`	Hayır
`data[].display.dismissible`	`boolean`	Hayır
`data[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`data[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`data[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`data[].display.form_id`	`string \| null`	Hayır
`data[].display.survey_id`	`string \| null`	Hayır
`data[].variants`	`array<object>`	Evet
`data[].variants[].id`	`string`	Evet	Uzunluk: 1–64
`data[].variants[].name`	`string`	Evet	Uzunluk: 1–60
`data[].variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`data[].variants[].display`	`object`	Evet
`data[].ab_test`	`object`	Evet
`data[].ab_test.winner_variant_id`	`string \| null`	Evet
`data[].ab_test.decided_at`	`string \| null`	Evet
`data[].ab_test.decided_by`	`string \| null`	Evet
`data[].trigger`	`object`	Evet
`data[].conditions`	`object`	Evet
`data[].conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`data[].conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`data[].conditions.visits`	`object`	Hayır
`data[].targeting`	`object`	Evet
`data[].targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`data[].targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`data[].targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`data[].targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`data[].frequency`	`object`	Evet
`data[].frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`data[].frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`data[].frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`data[].frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`data[].frequency.stop_after_conversion`	`boolean`	Hayır
`data[].start_at`	`string \| null`	Evet
`data[].end_at`	`string \| null`	Evet
`data[].stats`	`object`	Evet
`data[].stats.impressions`	`integer`	Evet
`data[].stats.clicks`	`integer`	Evet
`data[].stats.closes`	`integer`	Evet
`data[].stats.conversions`	`integer`	Evet
`data[].stats.unique_visitors`	`integer`	Evet
`data[].stats.ctr`	`number`	Evet
`data[].stats.conversion_rate`	`number`	Evet
`data[].variant_stats`	`array<object>`	Evet
`data[].variant_stats[].variant_id`	`string`	Evet
`data[].variant_stats[].impressions`	`integer`	Evet
`data[].variant_stats[].clicks`	`integer`	Evet
`data[].variant_stats[].conversions`	`integer`	Evet
`data[].variant_stats[].ctr`	`number`	Evet
`data[].variant_stats[].conversion_rate`	`number`	Evet
`data[].variant_significance`	`object \| null`	Evet
`data[].created_at`	`string`	Evet
`data[].updated_at`	`string`	Evet
`next_cursor`	`string \| null`	Evet
`has_more`	`boolean`	Evet

Örnek yanıt:

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

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Web kampanyası oluştur (taslak)

POST/v1/apps/{appId}/web-campaignsDene

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

İstek gövdesi (zorunlu)

Şema: CreateWebCampaignDto

Alan	Tür	Zorunlu	Açıklama
`name`	`string`	Evet	Uzunluk: 2–100
`display`	`object`	Evet
`display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`display.background_color`	`string`	Hayır
`display.text_color`	`string`	Hayır
`display.dismissible`	`boolean`	Hayır
`display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`display.max_width`	`integer`	Hayır	Aralık: 280–960
`display.blocks`	`array<object>`	Evet	Öğe: 0–12
`display.form_id`	`string \| null`	Hayır
`display.survey_id`	`string \| null`	Hayır
`variants`	`array<object>`	Hayır	Öğe: 0–10
`variants[].id`	`string`	Evet	Uzunluk: 1–64
`variants[].name`	`string`	Evet	Uzunluk: 1–60
`variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`variants[].display`	`object`	Evet
`variants[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`variants[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`variants[].display.background_color`	`string`	Hayır
`variants[].display.text_color`	`string`	Hayır
`variants[].display.dismissible`	`boolean`	Hayır
`variants[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`variants[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`variants[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`variants[].display.form_id`	`string \| null`	Hayır
`variants[].display.survey_id`	`string \| null`	Hayır
`trigger`	`object`	Evet
`conditions`	`object`	Hayır
`conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`conditions.url_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"starts_with"`, `"not_contains"`, `"matches"`
`conditions.url_rules[].value`	`string`	Evet	Uzunluk: 1–500
`conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`conditions.utm_rules[].param`	`enum`	Evet	Değerler: `"utm_source"`, `"utm_medium"`, `"utm_campaign"`, `"utm_term"`, `"utm_content"`
`conditions.utm_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"exists"`
`conditions.utm_rules[].value`	`string`	Hayır	Uzunluk: 0–200
`conditions.visits`	`object`	Hayır
`conditions.visits.op`	`enum`	Evet	Değerler: `"gte"`, `"lte"`, `"eq"`
`conditions.visits.value`	`integer`	Evet	Aralık: 1–10000
`targeting`	`object`	Hayır
`targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`frequency`	`object`	Hayır
`frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`frequency.stop_after_conversion`	`boolean`	Hayır
`priority`	`integer`	Hayır	Aralık: 0–100
`start_at`	`string (date-time) \| null`	Hayır
`end_at`	`string (date-time) \| null`	Hayır

Örnek:

{
  "name": "Sipariş bildirimleri",
  "display": {
    "layout": "popup",
    "blocks": [
      {
        "url": "https://example.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
}

Yanıtlar

201 — Başarılı.

Şema: WebCampaign

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`app_id`	`string`	Evet
`name`	`string`	Evet
`status`	`enum`	Evet	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`
`priority`	`integer`	Evet
`display`	`object`	Evet
`display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`display.background_color`	`string`	Hayır
`display.text_color`	`string`	Hayır
`display.dismissible`	`boolean`	Hayır
`display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`display.max_width`	`integer`	Hayır	Aralık: 280–960
`display.blocks`	`array<object>`	Evet	Öğe: 0–12
`display.form_id`	`string \| null`	Hayır
`display.survey_id`	`string \| null`	Hayır
`variants`	`array<object>`	Evet
`variants[].id`	`string`	Evet	Uzunluk: 1–64
`variants[].name`	`string`	Evet	Uzunluk: 1–60
`variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`variants[].display`	`object`	Evet
`variants[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`variants[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`variants[].display.background_color`	`string`	Hayır
`variants[].display.text_color`	`string`	Hayır
`variants[].display.dismissible`	`boolean`	Hayır
`variants[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`variants[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`variants[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`variants[].display.form_id`	`string \| null`	Hayır
`variants[].display.survey_id`	`string \| null`	Hayır
`ab_test`	`object`	Evet
`ab_test.winner_variant_id`	`string \| null`	Evet
`ab_test.decided_at`	`string \| null`	Evet
`ab_test.decided_by`	`string \| null`	Evet
`trigger`	`object`	Evet
`conditions`	`object`	Evet
`conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`conditions.url_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"starts_with"`, `"not_contains"`, `"matches"`
`conditions.url_rules[].value`	`string`	Evet	Uzunluk: 1–500
`conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`conditions.utm_rules[].param`	`enum`	Evet	Değerler: `"utm_source"`, `"utm_medium"`, `"utm_campaign"`, `"utm_term"`, `"utm_content"`
`conditions.utm_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"exists"`
`conditions.utm_rules[].value`	`string`	Hayır	Uzunluk: 0–200
`conditions.visits`	`object`	Hayır
`conditions.visits.op`	`enum`	Evet	Değerler: `"gte"`, `"lte"`, `"eq"`
`conditions.visits.value`	`integer`	Evet	Aralık: 1–10000
`targeting`	`object`	Evet
`targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`frequency`	`object`	Evet
`frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`frequency.stop_after_conversion`	`boolean`	Hayır
`start_at`	`string \| null`	Evet
`end_at`	`string \| null`	Evet
`stats`	`object`	Evet
`stats.impressions`	`integer`	Evet
`stats.clicks`	`integer`	Evet
`stats.closes`	`integer`	Evet
`stats.conversions`	`integer`	Evet
`stats.unique_visitors`	`integer`	Evet
`stats.ctr`	`number`	Evet
`stats.conversion_rate`	`number`	Evet
`variant_stats`	`array<object>`	Evet
`variant_stats[].variant_id`	`string`	Evet
`variant_stats[].impressions`	`integer`	Evet
`variant_stats[].clicks`	`integer`	Evet
`variant_stats[].conversions`	`integer`	Evet
`variant_stats[].ctr`	`number`	Evet
`variant_stats[].conversion_rate`	`number`	Evet
`variant_significance`	`object \| null`	Evet
`created_at`	`string`	Evet
`updated_at`	`string`	Evet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "display": {
    "layout": "popup",
    "blocks": [
      {
        "url": "https://example.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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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://example.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 kampanyası detayı ve istatistikleri

GET/v1/apps/{appId}/web-campaigns/{campaignId}Dene

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`campaignId`	yol	`string`	Evet		`"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: WebCampaign

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`app_id`	`string`	Evet
`name`	`string`	Evet
`status`	`enum`	Evet	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`
`priority`	`integer`	Evet
`display`	`object`	Evet
`display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`display.background_color`	`string`	Hayır
`display.text_color`	`string`	Hayır
`display.dismissible`	`boolean`	Hayır
`display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`display.max_width`	`integer`	Hayır	Aralık: 280–960
`display.blocks`	`array<object>`	Evet	Öğe: 0–12
`display.form_id`	`string \| null`	Hayır
`display.survey_id`	`string \| null`	Hayır
`variants`	`array<object>`	Evet
`variants[].id`	`string`	Evet	Uzunluk: 1–64
`variants[].name`	`string`	Evet	Uzunluk: 1–60
`variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`variants[].display`	`object`	Evet
`variants[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`variants[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`variants[].display.background_color`	`string`	Hayır
`variants[].display.text_color`	`string`	Hayır
`variants[].display.dismissible`	`boolean`	Hayır
`variants[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`variants[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`variants[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`variants[].display.form_id`	`string \| null`	Hayır
`variants[].display.survey_id`	`string \| null`	Hayır
`ab_test`	`object`	Evet
`ab_test.winner_variant_id`	`string \| null`	Evet
`ab_test.decided_at`	`string \| null`	Evet
`ab_test.decided_by`	`string \| null`	Evet
`trigger`	`object`	Evet
`conditions`	`object`	Evet
`conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`conditions.url_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"starts_with"`, `"not_contains"`, `"matches"`
`conditions.url_rules[].value`	`string`	Evet	Uzunluk: 1–500
`conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`conditions.utm_rules[].param`	`enum`	Evet	Değerler: `"utm_source"`, `"utm_medium"`, `"utm_campaign"`, `"utm_term"`, `"utm_content"`
`conditions.utm_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"exists"`
`conditions.utm_rules[].value`	`string`	Hayır	Uzunluk: 0–200
`conditions.visits`	`object`	Hayır
`conditions.visits.op`	`enum`	Evet	Değerler: `"gte"`, `"lte"`, `"eq"`
`conditions.visits.value`	`integer`	Evet	Aralık: 1–10000
`targeting`	`object`	Evet
`targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`frequency`	`object`	Evet
`frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`frequency.stop_after_conversion`	`boolean`	Hayır
`start_at`	`string \| null`	Evet
`end_at`	`string \| null`	Evet
`stats`	`object`	Evet
`stats.impressions`	`integer`	Evet
`stats.clicks`	`integer`	Evet
`stats.closes`	`integer`	Evet
`stats.conversions`	`integer`	Evet
`stats.unique_visitors`	`integer`	Evet
`stats.ctr`	`number`	Evet
`stats.conversion_rate`	`number`	Evet
`variant_stats`	`array<object>`	Evet
`variant_stats[].variant_id`	`string`	Evet
`variant_stats[].impressions`	`integer`	Evet
`variant_stats[].clicks`	`integer`	Evet
`variant_stats[].conversions`	`integer`	Evet
`variant_stats[].ctr`	`number`	Evet
`variant_stats[].conversion_rate`	`number`	Evet
`variant_significance`	`object \| null`	Evet
`created_at`	`string`	Evet
`updated_at`	`string`	Evet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "display": {
    "layout": "popup",
    "blocks": [
      {
        "url": "https://example.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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Web kampanyasını düzenle

PATCH/v1/apps/{appId}/web-campaigns/{campaignId}Dene

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`campaignId`	yol	`string`	Evet		`"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

İstek gövdesi (zorunlu)

Şema: UpdateWebCampaignDto

Alan	Tür	Zorunlu	Açıklama
`name`	`string`	Hayır	Uzunluk: 2–100
`display`	`object`	Hayır
`display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`display.background_color`	`string`	Hayır
`display.text_color`	`string`	Hayır
`display.dismissible`	`boolean`	Hayır
`display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`display.max_width`	`integer`	Hayır	Aralık: 280–960
`display.blocks`	`array<object>`	Evet	Öğe: 0–12
`display.form_id`	`string \| null`	Hayır
`display.survey_id`	`string \| null`	Hayır
`variants`	`array<object>`	Hayır	Öğe: 0–10
`variants[].id`	`string`	Evet	Uzunluk: 1–64
`variants[].name`	`string`	Evet	Uzunluk: 1–60
`variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`variants[].display`	`object`	Evet
`variants[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`variants[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`variants[].display.background_color`	`string`	Hayır
`variants[].display.text_color`	`string`	Hayır
`variants[].display.dismissible`	`boolean`	Hayır
`variants[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`variants[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`variants[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`variants[].display.form_id`	`string \| null`	Hayır
`variants[].display.survey_id`	`string \| null`	Hayır
`trigger`	`object`	Hayır
`conditions`	`object`	Hayır
`conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`conditions.url_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"starts_with"`, `"not_contains"`, `"matches"`
`conditions.url_rules[].value`	`string`	Evet	Uzunluk: 1–500
`conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`conditions.utm_rules[].param`	`enum`	Evet	Değerler: `"utm_source"`, `"utm_medium"`, `"utm_campaign"`, `"utm_term"`, `"utm_content"`
`conditions.utm_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"exists"`
`conditions.utm_rules[].value`	`string`	Hayır	Uzunluk: 0–200
`conditions.visits`	`object`	Hayır
`conditions.visits.op`	`enum`	Evet	Değerler: `"gte"`, `"lte"`, `"eq"`
`conditions.visits.value`	`integer`	Evet	Aralık: 1–10000
`targeting`	`object`	Hayır
`targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`frequency`	`object`	Hayır
`frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`frequency.stop_after_conversion`	`boolean`	Hayır
`priority`	`integer`	Hayır	Aralık: 0–100
`start_at`	`string (date-time) \| null`	Hayır
`end_at`	`string (date-time) \| null`	Hayır

Örnek:

{
  "name": "Sipariş bildirimleri",
  "display": {
    "layout": "popup",
    "blocks": [
      {
        "url": "https://example.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
    }
  }
}

Yanıtlar

200 — Başarılı.

Şema: WebCampaign

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`app_id`	`string`	Evet
`name`	`string`	Evet
`status`	`enum`	Evet	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`
`priority`	`integer`	Evet
`display`	`object`	Evet
`display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`display.background_color`	`string`	Hayır
`display.text_color`	`string`	Hayır
`display.dismissible`	`boolean`	Hayır
`display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`display.max_width`	`integer`	Hayır	Aralık: 280–960
`display.blocks`	`array<object>`	Evet	Öğe: 0–12
`display.form_id`	`string \| null`	Hayır
`display.survey_id`	`string \| null`	Hayır
`variants`	`array<object>`	Evet
`variants[].id`	`string`	Evet	Uzunluk: 1–64
`variants[].name`	`string`	Evet	Uzunluk: 1–60
`variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`variants[].display`	`object`	Evet
`variants[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`variants[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`variants[].display.background_color`	`string`	Hayır
`variants[].display.text_color`	`string`	Hayır
`variants[].display.dismissible`	`boolean`	Hayır
`variants[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`variants[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`variants[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`variants[].display.form_id`	`string \| null`	Hayır
`variants[].display.survey_id`	`string \| null`	Hayır
`ab_test`	`object`	Evet
`ab_test.winner_variant_id`	`string \| null`	Evet
`ab_test.decided_at`	`string \| null`	Evet
`ab_test.decided_by`	`string \| null`	Evet
`trigger`	`object`	Evet
`conditions`	`object`	Evet
`conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`conditions.url_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"starts_with"`, `"not_contains"`, `"matches"`
`conditions.url_rules[].value`	`string`	Evet	Uzunluk: 1–500
`conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`conditions.utm_rules[].param`	`enum`	Evet	Değerler: `"utm_source"`, `"utm_medium"`, `"utm_campaign"`, `"utm_term"`, `"utm_content"`
`conditions.utm_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"exists"`
`conditions.utm_rules[].value`	`string`	Hayır	Uzunluk: 0–200
`conditions.visits`	`object`	Hayır
`conditions.visits.op`	`enum`	Evet	Değerler: `"gte"`, `"lte"`, `"eq"`
`conditions.visits.value`	`integer`	Evet	Aralık: 1–10000
`targeting`	`object`	Evet
`targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`frequency`	`object`	Evet
`frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`frequency.stop_after_conversion`	`boolean`	Hayır
`start_at`	`string \| null`	Evet
`end_at`	`string \| null`	Evet
`stats`	`object`	Evet
`stats.impressions`	`integer`	Evet
`stats.clicks`	`integer`	Evet
`stats.closes`	`integer`	Evet
`stats.conversions`	`integer`	Evet
`stats.unique_visitors`	`integer`	Evet
`stats.ctr`	`number`	Evet
`stats.conversion_rate`	`number`	Evet
`variant_stats`	`array<object>`	Evet
`variant_stats[].variant_id`	`string`	Evet
`variant_stats[].impressions`	`integer`	Evet
`variant_stats[].clicks`	`integer`	Evet
`variant_stats[].conversions`	`integer`	Evet
`variant_stats[].ctr`	`number`	Evet
`variant_stats[].conversion_rate`	`number`	Evet
`variant_significance`	`object \| null`	Evet
`created_at`	`string`	Evet
`updated_at`	`string`	Evet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "display": {
    "layout": "popup",
    "blocks": [
      {
        "url": "https://example.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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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://example.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
    }
  }
}'

Günlük seri

GET/v1/apps/{appId}/web-campaigns/{campaignId}/reportDene

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`campaignId`	yol	`string`	Evet		`"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`days`	sorgu	`integer`	Hayır	Aralık: 1–365	`1`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

Yanıtlar

200 — Başarılı.

Şema: WebCampaignReport

Alan	Tür	Zorunlu
`campaign_id`	`string`	Evet
`days`	`integer`	Evet
`daily`	`array<object>`	Evet
`daily[].date`	`string`	Evet
`daily[].impressions`	`integer`	Evet
`daily[].clicks`	`integer`	Evet
`daily[].closes`	`integer`	Evet
`daily[].conversions`	`integer`	Evet
`totals`	`object`	Evet
`totals.impressions`	`integer`	Evet
`totals.clicks`	`integer`	Evet
`totals.closes`	`integer`	Evet
`totals.conversions`	`integer`	Evet
`totals.unique_visitors`	`integer`	Evet
`totals.ctr`	`number`	Evet
`totals.conversion_rate`	`number`	Evet

Örnek yanıt:

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

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns/wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W/report" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Yayınla / duraklat / arşivle

POST/v1/apps/{appId}/web-campaigns/{campaignId}/statusDene

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

Ad	Konum	Tür	Zorunlu	Açıklama	Örnek
`campaignId`	yol	`string`	Evet		`"wcp_01JD3W5Q7X9K2M4N6P8R0T1V3W"`
`appId`	yol	`string`	Evet		`"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"`

İstek gövdesi (zorunlu)

Şema: WebCampaignStatusDto

Alan	Tür	Zorunlu	Açıklama
`status`	`enum`	Evet	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`

Örnek:

{
  "status": "draft"
}

Yanıtlar

200 — Başarılı.

Şema: WebCampaign

Alan	Tür	Zorunlu	Açıklama
`id`	`string`	Evet
`app_id`	`string`	Evet
`name`	`string`	Evet
`status`	`enum`	Evet	Değerler: `"draft"`, `"active"`, `"paused"`, `"archived"`
`priority`	`integer`	Evet
`display`	`object`	Evet
`display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`display.background_color`	`string`	Hayır
`display.text_color`	`string`	Hayır
`display.dismissible`	`boolean`	Hayır
`display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`display.max_width`	`integer`	Hayır	Aralık: 280–960
`display.blocks`	`array<object>`	Evet	Öğe: 0–12
`display.form_id`	`string \| null`	Hayır
`display.survey_id`	`string \| null`	Hayır
`variants`	`array<object>`	Evet
`variants[].id`	`string`	Evet	Uzunluk: 1–64
`variants[].name`	`string`	Evet	Uzunluk: 1–60
`variants[].weight_percent`	`integer`	Evet	Aralık: 1–99
`variants[].display`	`object`	Evet
`variants[].display.layout`	`enum`	Evet	Değerler: `"popup"`, `"banner_top"`, `"banner_bottom"`, `"slide_in"`, `"fullscreen"`
`variants[].display.position`	`enum`	Hayır	Değerler: `"left"`, `"right"`
`variants[].display.background_color`	`string`	Hayır
`variants[].display.text_color`	`string`	Hayır
`variants[].display.dismissible`	`boolean`	Hayır
`variants[].display.auto_dismiss_seconds`	`integer`	Hayır	Aralık: 1–300
`variants[].display.max_width`	`integer`	Hayır	Aralık: 280–960
`variants[].display.blocks`	`array<object>`	Evet	Öğe: 0–12
`variants[].display.form_id`	`string \| null`	Hayır
`variants[].display.survey_id`	`string \| null`	Hayır
`ab_test`	`object`	Evet
`ab_test.winner_variant_id`	`string \| null`	Evet
`ab_test.decided_at`	`string \| null`	Evet
`ab_test.decided_by`	`string \| null`	Evet
`trigger`	`object`	Evet
`conditions`	`object`	Evet
`conditions.url_rules`	`array<object>`	Hayır	Öğe: 0–10
`conditions.url_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"starts_with"`, `"not_contains"`, `"matches"`
`conditions.url_rules[].value`	`string`	Evet	Uzunluk: 1–500
`conditions.utm_rules`	`array<object>`	Hayır	Öğe: 0–5
`conditions.utm_rules[].param`	`enum`	Evet	Değerler: `"utm_source"`, `"utm_medium"`, `"utm_campaign"`, `"utm_term"`, `"utm_content"`
`conditions.utm_rules[].op`	`enum`	Evet	Değerler: `"equals"`, `"contains"`, `"exists"`
`conditions.utm_rules[].value`	`string`	Hayır	Uzunluk: 0–200
`conditions.visits`	`object`	Hayır
`conditions.visits.op`	`enum`	Evet	Değerler: `"gte"`, `"lte"`, `"eq"`
`conditions.visits.value`	`integer`	Evet	Aralık: 1–10000
`targeting`	`object`	Evet
`targeting.included_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.excluded_segments`	`array<string>`	Hayır	Öğe: 0–20
`targeting.visitor`	`enum`	Hayır	Değerler: `"all"`, `"new"`, `"returning"`
`targeting.devices`	`array<enum>`	Hayır	Öğe: 0–3
`frequency`	`object`	Evet
`frequency.max_per_session`	`integer`	Hayır	Aralık: 1–100
`frequency.max_per_day`	`integer`	Hayır	Aralık: 1–100
`frequency.max_total`	`integer`	Hayır	Aralık: 1–1000
`frequency.hide_after_close_days`	`integer`	Hayır	Aralık: 0–365
`frequency.stop_after_conversion`	`boolean`	Hayır
`start_at`	`string \| null`	Evet
`end_at`	`string \| null`	Evet
`stats`	`object`	Evet
`stats.impressions`	`integer`	Evet
`stats.clicks`	`integer`	Evet
`stats.closes`	`integer`	Evet
`stats.conversions`	`integer`	Evet
`stats.unique_visitors`	`integer`	Evet
`stats.ctr`	`number`	Evet
`stats.conversion_rate`	`number`	Evet
`variant_stats`	`array<object>`	Evet
`variant_stats[].variant_id`	`string`	Evet
`variant_stats[].impressions`	`integer`	Evet
`variant_stats[].clicks`	`integer`	Evet
`variant_stats[].conversions`	`integer`	Evet
`variant_stats[].ctr`	`number`	Evet
`variant_stats[].conversion_rate`	`number`	Evet
`variant_significance`	`object \| null`	Evet
`created_at`	`string`	Evet
`updated_at`	`string`	Evet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "display": {
    "layout": "popup",
    "blocks": [
      {
        "url": "https://example.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"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

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

Web kampanyaları (pop-up, banner)

İşlemlerBağlantıyı kopyala

AyrıntılarBağlantıyı kopyala

Web kampanyalarıBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Web kampanyası oluştur (taslak)Bağlantıyı kopyala

201 — Başarılı.Bağlantıyı kopyala

Web kampanyası detayı ve istatistikleriBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Web kampanyasını düzenleBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Günlük seriBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Yayınla / duraklat / arşivleBağlantıyı kopyala

200 — Başarılı.Bağlantıyı kopyala

Bu sayfada

İşlemler

Ayrıntılar

Web kampanyaları

200 — Başarılı.

Web kampanyası oluştur (taslak)

201 — Başarılı.

Web kampanyası detayı ve istatistikleri

200 — Başarılı.

Web kampanyasını düzenle

200 — Başarılı.

Günlük seri

200 — Başarılı.

Yayınla / duraklat / arşivle

200 — Başarılı.