PushizoDocs
API referansı

Landing sayfaları

Landing sayfaları — 4 işlem (GET /v1/apps/{appId}/landing-pages, GET /v1/apps/{appId}/landing-pages/{pageId}, POST /v1/apps/{appId}/landing-pages/{pageId}/publish, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Blok editörüyle hazırlanan landing sayfaları: listeleme, detay, yayınlama ve yayından kaldırma (yayın adresi /lp/<org>/<slug> veya özel alan adı).

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

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/landing-pagesLanding sayfaları
GET/v1/apps/{appId}/landing-pages/{pageId}Landing sayfası detayı
POST/v1/apps/{appId}/landing-pages/{pageId}/publishTaslağı yayınla
POST/v1/apps/{appId}/landing-pages/{pageId}/unpublishYayından kaldır

Ayrıntılar

Landing sayfaları

GET/v1/apps/{appId}/landing-pagesDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
limitsorguintegerHayırVarsayılan: 50; Aralık: 1–20050
cursorsorgustringHayırUzunluk: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statussorguenumHayırDeğerler: "draft", "published", "archived""draft"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: LandingPageList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].slugstringEvet
data[].statusenumEvetDeğerler: "draft", "published", "archived"
data[].seoobjectEvet
data[].seo.titlestringHayırUzunluk: 0–120
data[].seo.descriptionstringHayırUzunluk: 0–320
data[].seo.og_imagestring (url)HayırUzunluk: 0–2000
data[].seo.canonical_urlstring (url)HayırUzunluk: 0–2000
data[].seo.noindexbooleanHayır
data[].settingsobjectEvet
data[].settings.languagestringHayırUzunluk: 2–10
data[].settings.form_idstring | nullHayır
data[].settings.form_section_idstring | nullHayır
data[].settings.cookie_consentobjectHayır
data[].settings.web_sdkbooleanHayır
data[].settings.favicon_urlstring (url)HayırUzunluk: 0–2000
data[].custom_domain_idstring | nullEvet
data[].versionintegerEvet
data[].published_versioninteger | nullEvet
data[].published_atstring | nullEvet
data[].has_unpublished_changesbooleanEvet
data[].urlstringEvet
data[].domain_urlstring | nullEvet
data[].statsobjectEvet
data[].stats.submissionsintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Örnek yanıt:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "url": "https://example.com/orders/1001",
      "status": "draft",
      "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "slug": "magaza",
      "seo": {
        "title": "Siparişiniz yola çıktı",
        "description": "Sipariş durumu güncellemeleri"
      },
      "settings": {
        "language": "tr",
        "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      },
      "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "version": 1,
      "published_version": 1,
      "published_at": "örnek",
      "has_unpublished_changes": true,
      "domain_url": "https://example.com/orders/1001",
      "stats": {
        "submissions": 1
      },
      "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/landing-pages?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Landing sayfası detayı

GET/v1/apps/{appId}/landing-pages/{pageId}Dene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
pageIdyolstringEvet"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: LandingPage

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
slugstringEvet
statusenumEvetDeğerler: "draft", "published", "archived"
seoobjectEvet
seo.titlestringHayırUzunluk: 0–120
seo.descriptionstringHayırUzunluk: 0–320
seo.og_imagestring (url)HayırUzunluk: 0–2000
seo.canonical_urlstring (url)HayırUzunluk: 0–2000
seo.noindexbooleanHayır
settingsobjectEvet
settings.languagestringHayırUzunluk: 2–10
settings.form_idstring | nullHayır
settings.form_section_idstring | nullHayır
settings.cookie_consentobjectHayır
settings.cookie_consent.enabledbooleanEvet
settings.cookie_consent.textstringHayırUzunluk: 0–1000
settings.cookie_consent.accept_labelstringHayırUzunluk: 0–60
settings.cookie_consent.reject_labelstringHayırUzunluk: 0–60
settings.cookie_consent.policy_urlstring (url)HayırUzunluk: 0–2000
settings.web_sdkbooleanHayır
settings.favicon_urlstring (url)HayırUzunluk: 0–2000
custom_domain_idstring | nullEvet
versionintegerEvet
published_versioninteger | nullEvet
published_atstring | nullEvet
has_unpublished_changesbooleanEvet
urlstringEvet
domain_urlstring | nullEvet
statsobjectEvet
stats.submissionsintegerEvet
created_atstringEvet
updated_atstringEvet
documentobjectEvet
document.version1Evet
document.settingsobjectEvet
document.settings.widthintegerHayırAralık: 480–800
document.settings.background_colorstringHayır
document.settings.content_background_colorstringHayır
document.settings.text_colorstringHayır
document.settings.link_colorstringHayır
document.settings.font_familyenumHayırDeğerler: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectHayır
document.sectionsarray<object>EvetÖğe: 0–50
document.sections[].idstringEvet
document.sections[].type"section"Evet
document.sections[].background_colorstringHayır
document.sections[].background_imagestringHayırUzunluk: 1–2000
document.sections[].paddingobjectHayır
document.sections[].stack_on_mobilebooleanHayır
document.sections[].columnsarray<object>EvetÖğe: 1–4

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "url": "https://example.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://example.com/orders/1001",
    "canonical_url": "https://example.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://example.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "ö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/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Taslağı yayınla

POST/v1/apps/{appId}/landing-pages/{pageId}/publishDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
pageIdyolstringEvet"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: LandingPage

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
slugstringEvet
statusenumEvetDeğerler: "draft", "published", "archived"
seoobjectEvet
seo.titlestringHayırUzunluk: 0–120
seo.descriptionstringHayırUzunluk: 0–320
seo.og_imagestring (url)HayırUzunluk: 0–2000
seo.canonical_urlstring (url)HayırUzunluk: 0–2000
seo.noindexbooleanHayır
settingsobjectEvet
settings.languagestringHayırUzunluk: 2–10
settings.form_idstring | nullHayır
settings.form_section_idstring | nullHayır
settings.cookie_consentobjectHayır
settings.cookie_consent.enabledbooleanEvet
settings.cookie_consent.textstringHayırUzunluk: 0–1000
settings.cookie_consent.accept_labelstringHayırUzunluk: 0–60
settings.cookie_consent.reject_labelstringHayırUzunluk: 0–60
settings.cookie_consent.policy_urlstring (url)HayırUzunluk: 0–2000
settings.web_sdkbooleanHayır
settings.favicon_urlstring (url)HayırUzunluk: 0–2000
custom_domain_idstring | nullEvet
versionintegerEvet
published_versioninteger | nullEvet
published_atstring | nullEvet
has_unpublished_changesbooleanEvet
urlstringEvet
domain_urlstring | nullEvet
statsobjectEvet
stats.submissionsintegerEvet
created_atstringEvet
updated_atstringEvet
documentobjectEvet
document.version1Evet
document.settingsobjectEvet
document.settings.widthintegerHayırAralık: 480–800
document.settings.background_colorstringHayır
document.settings.content_background_colorstringHayır
document.settings.text_colorstringHayır
document.settings.link_colorstringHayır
document.settings.font_familyenumHayırDeğerler: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectHayır
document.sectionsarray<object>EvetÖğe: 0–50
document.sections[].idstringEvet
document.sections[].type"section"Evet
document.sections[].background_colorstringHayır
document.sections[].background_imagestringHayırUzunluk: 1–2000
document.sections[].paddingobjectHayır
document.sections[].stack_on_mobilebooleanHayır
document.sections[].columnsarray<object>EvetÖğe: 1–4

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "url": "https://example.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://example.com/orders/1001",
    "canonical_url": "https://example.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://example.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "ö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/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/publish" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Yayından kaldır

POST/v1/apps/{appId}/landing-pages/{pageId}/unpublishDene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
pageIdyolstringEvet"lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: LandingPage

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
slugstringEvet
statusenumEvetDeğerler: "draft", "published", "archived"
seoobjectEvet
seo.titlestringHayırUzunluk: 0–120
seo.descriptionstringHayırUzunluk: 0–320
seo.og_imagestring (url)HayırUzunluk: 0–2000
seo.canonical_urlstring (url)HayırUzunluk: 0–2000
seo.noindexbooleanHayır
settingsobjectEvet
settings.languagestringHayırUzunluk: 2–10
settings.form_idstring | nullHayır
settings.form_section_idstring | nullHayır
settings.cookie_consentobjectHayır
settings.cookie_consent.enabledbooleanEvet
settings.cookie_consent.textstringHayırUzunluk: 0–1000
settings.cookie_consent.accept_labelstringHayırUzunluk: 0–60
settings.cookie_consent.reject_labelstringHayırUzunluk: 0–60
settings.cookie_consent.policy_urlstring (url)HayırUzunluk: 0–2000
settings.web_sdkbooleanHayır
settings.favicon_urlstring (url)HayırUzunluk: 0–2000
custom_domain_idstring | nullEvet
versionintegerEvet
published_versioninteger | nullEvet
published_atstring | nullEvet
has_unpublished_changesbooleanEvet
urlstringEvet
domain_urlstring | nullEvet
statsobjectEvet
stats.submissionsintegerEvet
created_atstringEvet
updated_atstringEvet
documentobjectEvet
document.version1Evet
document.settingsobjectEvet
document.settings.widthintegerHayırAralık: 480–800
document.settings.background_colorstringHayır
document.settings.content_background_colorstringHayır
document.settings.text_colorstringHayır
document.settings.link_colorstringHayır
document.settings.font_familyenumHayırDeğerler: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectHayır
document.sectionsarray<object>EvetÖğe: 0–50
document.sections[].idstringEvet
document.sections[].type"section"Evet
document.sections[].background_colorstringHayır
document.sections[].background_imagestringHayırUzunluk: 1–2000
document.sections[].paddingobjectHayır
document.sections[].stack_on_mobilebooleanHayır
document.sections[].columnsarray<object>EvetÖğe: 1–4

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "url": "https://example.com/orders/1001",
  "status": "draft",
  "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "seo": {
    "title": "Siparişiniz yola çıktı",
    "description": "Sipariş durumu güncellemeleri",
    "og_image": "https://example.com/orders/1001",
    "canonical_url": "https://example.com/orders/1001"
  },
  "settings": {
    "language": "tr",
    "form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "form_section_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "cookie_consent": {
      "enabled": true,
      "text": "Takip bağlantısı içeride",
      "accept_label": "örnek"
    }
  },
  "custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "version": 1,
  "published_version": 1,
  "published_at": "örnek",
  "has_unpublished_changes": true,
  "domain_url": "https://example.com/orders/1001",
  "stats": {
    "submissions": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "document": {
    "version": 1,
    "settings": {
      "width": 480,
      "background_color": "değer"
    },
    "sections": [
      {
        "type": "section",
        "id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "columns": [
          {}
        ],
        "background_color": "değer",
        "background_image": "ö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/landing-pages/lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W/unpublish" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Anketler ve NPS

Anketler ve NPS — 7 işlem (GET /v1/apps/{appId}/surveys, POST /v1/apps/{appId}/surveys, GET /v1/apps/{appId}/surveys/{surveyId}, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

MCP taslakları

MCP taslakları — 2 işlem (POST /v1/apps/{appId}/mcp/campaign-drafts, POST /v1/apps/{appId}/mcp/segment-drafts). OpenAPI 3.1.0 sözleşmesinden üretilir.

Bu sayfada

İşlemlerAyrıntılarLanding sayfaları200 — Başarılı.Landing sayfası detayı200 — Başarılı.Taslağı yayınla200 — Başarılı.Yayından kaldır200 — Başarılı.