PushizoDocs
API reference

Web personalization

Web personalization — 8 operations (GET /v1/apps/{appId}/web-personalizations, POST /v1/apps/{appId}/web-personalizations, GET /v1/apps/{appId}/web-personalizations/{personalizationId}, …). Generated from the OpenAPI 3.1.0 contract.

Experiences that change elements on your site (CSS selectors) per visitor: text, image, link, hide/show; page conditions, audience and segment targeting, A/B (control group), conversion goal and daily report. Changes are applied by the Web SDK; no HTML is written. Requires the Growth+ plan.

Base URL: https://api.pushizo.com · Tag: web-personalizations · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/web-personalizationsWeb personalization experiences
POST/v1/apps/{appId}/web-personalizationsCreate a personalization experience (draft)
GET/v1/apps/{appId}/web-personalizations/{personalizationId}Personalization experience details and statistics
PATCH/v1/apps/{appId}/web-personalizations/{personalizationId}Edit a personalization experience
DELETE/v1/apps/{appId}/web-personalizations/{personalizationId}Delete a personalization experience (along with its events)
GET/v1/apps/{appId}/web-personalizations/{personalizationId}/reportDaily series
POST/v1/apps/{appId}/web-personalizations/{personalizationId}/statusPublish / pause / archive
POST/v1/apps/{appId}/web-personalizations/{personalizationId}/winnerSelect the A/B winner (the SDK then applies only the winner's changes)

Details

Web personalization experiences

GET/v1/apps/{appId}/web-personalizationsTry 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: WebPersonalizationPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].priorityintegerYes
data[].changesarray<object>Yes
data[].variantsarray<object>Yes
data[].variants[].idstringYesLength: 1–64
data[].variants[].namestringYesLength: 1–60
data[].variants[].weight_percentintegerYesRange: 1–99
data[].variants[].changesarray<object>YesItems: 0–20
data[].ab_testobjectYes
data[].ab_test.winner_variant_idstring | nullYes
data[].ab_test.decided_atstring | nullYes
data[].ab_test.decided_bystring | nullYes
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[].goalobject | nullYes
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].statsobjectYes
data[].stats.visitorsintegerYes
data[].stats.conversionsintegerYes
data[].stats.conversion_ratenumberYes
data[].variant_statsarray<object>Yes
data[].variant_stats[].visitorsintegerYes
data[].variant_stats[].conversionsintegerYes
data[].variant_stats[].conversion_ratenumberYes
data[].variant_stats[].variant_idstringYes
data[].variant_significanceobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "draft",
      "id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ],
      "variants": [
        {
          "name": "Sipariş bildirimleri",
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "changes": []
        }
      ],
      "ab_test": {
        "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "decided_at": "örnek",
        "decided_by": "örnek"
      },
      "conditions": {
        "url_rules": [
          {}
        ],
        "utm_rules": [
          {}
        ]
      },
      "targeting": {
        "included_segments": [
          "örnek"
        ],
        "excluded_segments": [
          "örnek"
        ]
      },
      "goal": {
        "type": "event",
        "event": "purchase"
      },
      "start_at": "örnek",
      "end_at": "örnek",
      "stats": {
        "visitors": 1,
        "conversions": 1,
        "conversion_rate": 1.5
      },
      "variant_stats": [
        {
          "visitors": 1,
          "conversions": 1,
          "conversion_rate": 1.5,
          "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
        }
      ],
      "variant_significance": {
        "leader": "örnek",
        "p_value": 149.9,
        "significant": true
      },
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

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

Create a personalization experience (draft)

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWebPersonalizationDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
changesarray<object>NoItems: 0–20
variantsarray<object>NoItems: 0–4
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
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
goalobject | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all"
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  }
}

Responses

201 — Success.

Schema: WebPersonalization

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
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
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek"
  },
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all",
    "devices": [
      "desktop"
    ]
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  },
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "visitors": 1,
    "conversions": 1,
    "conversion_rate": 1.5
  },
  "variant_stats": [
    {
      "visitors": 1,
      "conversions": 1,
      "conversion_rate": 1.5,
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ],
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all"
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  }
}'

Personalization experience details and statistics

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

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

Parameters

NameInTypeRequiredDescriptionExample
personalizationIdpathstringYes"wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebPersonalization

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
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
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek"
  },
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all",
    "devices": [
      "desktop"
    ]
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  },
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "visitors": 1,
    "conversions": 1,
    "conversion_rate": 1.5
  },
  "variant_stats": [
    {
      "visitors": 1,
      "conversions": 1,
      "conversion_rate": 1.5,
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ],
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

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

Edit a personalization experience

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

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

Parameters

NameInTypeRequiredDescriptionExample
personalizationIdpathstringYes"wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWebPersonalizationDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
changesarray<object>NoItems: 0–20
variantsarray<object>NoItems: 0–4
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
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
goalobject | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all"
  }
}

Responses

200 — Success.

Schema: WebPersonalization

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
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
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek"
  },
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all",
    "devices": [
      "desktop"
    ]
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  },
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "visitors": 1,
    "conversions": 1,
    "conversion_rate": 1.5
  },
  "variant_stats": [
    {
      "visitors": 1,
      "conversions": 1,
      "conversion_rate": 1.5,
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ],
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all"
  }
}'

Delete a personalization experience (along with its events)

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

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

Parameters

NameInTypeRequiredDescriptionExample
personalizationIdpathstringYes"wpz_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-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Daily series

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

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

Parameters

NameInTypeRequiredDescriptionExample
personalizationIdpathstringYes"wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W"
daysqueryintegerNoRange: 1–3651
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebPersonalizationReport

FieldTypeRequiredDescription
personalization_idstringYes
daysintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].visitorsintegerYes
daily[].conversionsintegerYes
totalsobjectYes
totals.visitorsintegerYes
totals.conversionsintegerYes
totals.conversion_ratenumberYes

Example response:

{
  "personalization_id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "days": 1,
  "daily": [
    {
      "date": "örnek",
      "visitors": 1,
      "conversions": 1
    }
  ],
  "totals": {
    "visitors": 1,
    "conversions": 1,
    "conversion_rate": 1.5
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

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

Publish / pause / archive

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

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

Parameters

NameInTypeRequiredDescriptionExample
personalizationIdpathstringYes"wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: WebPersonalizationStatusDto

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

Example:

{
  "status": "draft"
}

Responses

200 — Success.

Schema: WebPersonalization

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
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
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek"
  },
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all",
    "devices": [
      "desktop"
    ]
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  },
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "visitors": 1,
    "conversions": 1,
    "conversion_rate": 1.5
  },
  "variant_stats": [
    {
      "visitors": 1,
      "conversions": 1,
      "conversion_rate": 1.5,
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ],
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/status" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "draft"
}'

Select the A/B winner (the SDK then applies only the winner's changes)

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

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

Parameters

NameInTypeRequiredDescriptionExample
personalizationIdpathstringYes"wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: WebPersonalizationWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–64

Example:

{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: WebPersonalization

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
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
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "changes": [
    {
      "action": "text",
      "selector": "değer",
      "text": {
        "tr": "Siparişiniz yola çıktı",
        "en": "Your order has shipped"
      }
    }
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "changes": [
        {
          "action": "text",
          "selector": "değer",
          "text": {}
        }
      ]
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek"
  },
  "conditions": {
    "url_rules": [
      {
        "op": "equals",
        "value": "user_42"
      }
    ],
    "utm_rules": [
      {
        "param": "utm_source",
        "op": "equals",
        "value": "user_42"
      }
    ],
    "visits": {
      "op": "gte",
      "value": 150
    }
  },
  "targeting": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "visitor": "all",
    "devices": [
      "desktop"
    ]
  },
  "goal": {
    "type": "event",
    "event": "purchase"
  },
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "visitors": 1,
    "conversions": 1,
    "conversion_rate": 1.5
  },
  "variant_stats": [
    {
      "visitors": 1,
      "conversions": 1,
      "conversion_rate": 1.5,
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
    }
  ],
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

On this page