PushizoDocs
API referansı

Olay tanımları

Olay tanımları — 3 işlem (GET /v1/apps/{appId}/events/definitions, GET /v1/apps/{appId}/events/definitions/{name}, PATCH /v1/apps/{appId}/events/definitions/{name}). OpenAPI 3.1.0 sözleşmesinden üretilir.

App’te görülen özel olayların tanımları (ad, ilk/son görülme, 30 günlük sayım) ve tanım üzerinde düzenlenebilir alanlar.

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

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/events/definitionsOlay tanımları
GET/v1/apps/{appId}/events/definitions/{name}Olay detayı
PATCH/v1/apps/{appId}/events/definitions/{name}Görünen ad / dönüşüm işareti

Ayrıntılar

Olay tanımları

GET/v1/apps/{appId}/events/definitionsDene (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: 500; Aralık: 1–50050
cursorsorgustringHayırUzunluk: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: EventDefinitionList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].app_idstringEvet
data[].namestringEvet
data[].display_namestring | nullEvet
data[].properties_schemamap<string, string>Evet
data[].is_conversionbooleanEvet
data[].outcome_uniquebooleanEvet
data[].outcome_unattributedbooleanEvet
data[].retention_daysinteger | nullEvet
data[].first_seen_atstringEvet
data[].last_seen_atstringEvet
data[].count_30dintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Örnek yanıt:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "display_name": "örnek",
      "properties_schema": {
        "key": "user_42"
      },
      "is_conversion": true,
      "outcome_unique": true,
      "outcome_unattributed": true,
      "retention_days": 1,
      "first_seen_at": "örnek",
      "last_seen_at": "örnek",
      "count_30d": 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/events/definitions?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Olay detayı

GET/v1/apps/{appId}/events/definitions/{name}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
nameyolstringEvet"Sipariş bildirimleri"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: EventDefinitionDetail

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
display_namestring | nullEvet
properties_schemamap<string, string>Evet
is_conversionbooleanEvet
outcome_uniquebooleanEvet
outcome_unattributedbooleanEvet
retention_daysinteger | nullEvet
first_seen_atstringEvet
last_seen_atstringEvet
count_30dintegerEvet
created_atstringEvet
updated_atstringEvet
dailyarray<object>Evet
daily[].datestringEvet
daily[].countintegerEvet
daily[].usersintegerEvet
propertiesarray<object>Evet
properties[].keystringEvet
properties[].typestringEvet
properties[].valuesarray<object>Evet
properties[].values[].valuestringEvet
properties[].values[].countintegerEvet

Örnek yanıt:

{
  "name": "purchase",
  "properties": [
    {
      "type": "örnek",
      "key": "key-2026-10",
      "values": [
        {
          "value": "user_42",
          "count": 1
        }
      ]
    }
  ],
  "id": "def_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "display_name": "örnek",
  "properties_schema": {
    "key": "user_42"
  },
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1,
  "first_seen_at": "örnek",
  "last_seen_at": "örnek",
  "count_30d": 1,
  "created_at": "örnek",
  "updated_at": "örnek",
  "daily": [
    {
      "date": "örnek",
      "count": 1,
      "users": 1
    }
  ]
}

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/events/definitions/Sipariş bildirimleri" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Görünen ad / dönüşüm işareti

PATCH/v1/apps/{appId}/events/definitions/{name}Dene (etkileşimli API belgesi, yeni sekme)

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

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
nameyolstringEvet"Sipariş bildirimleri"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: PatchEventDefinitionDto

AlanTürZorunluAçıklama
display_namestring | nullHayır
is_conversionbooleanHayır
outcome_uniquebooleanHayır
outcome_unattributedbooleanHayır
retention_daysinteger | nullHayır

Örnek:

{
  "display_name": "örnek",
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1
}

Yanıtlar

200 — Başarılı.

Şema: EventDefinition

AlanTürZorunluAçıklama
idstringEvet
app_idstringEvet
namestringEvet
display_namestring | nullEvet
properties_schemamap<string, string>Evet
is_conversionbooleanEvet
outcome_uniquebooleanEvet
outcome_unattributedbooleanEvet
retention_daysinteger | nullEvet
first_seen_atstringEvet
last_seen_atstringEvet
count_30dintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "name": "purchase",
  "id": "def_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "display_name": "örnek",
  "properties_schema": {
    "key": "user_42"
  },
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1,
  "first_seen_at": "örnek",
  "last_seen_at": "örnek",
  "count_30d": 1,
  "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/events/definitions/Sipariş bildirimleri" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "display_name": "örnek",
  "is_conversion": true,
  "outcome_unique": true,
  "outcome_unattributed": true,
  "retention_days": 1
}'

Kullanıcılar ve abonelikler

Kullanıcılar ve abonelikler — 18 işlem (GET /v1/apps/{appId}/users, POST /v1/apps/{appId}/users, POST /v1/apps/{appId}/users/search, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Segmentler

Segmentler — 8 işlem (GET /v1/apps/{appId}/segments, POST /v1/apps/{appId}/segments, POST /v1/apps/{appId}/segments/preview, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Bu sayfada

İşlemlerAyrıntılarOlay tanımları200 — Başarılı.Olay detayı200 — Başarılı.Görünen ad / dönüşüm işareti200 — Başarılı.