Açılır pencereler API

Web sitesi açılır pencereleri, hedefleme ve A/B dönüşüm ölçümleri.

Modül kodu popups · 4 işlem · 2 veri modeli · 2 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: popups (hepsi), popups:read (yalnız okuma) ya da popups:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

popups.delete

Açılır pencereyi sil — Açılır pencereyi ve anonim ölçümlerini siler.

Gereken izin popups:delete · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/popups.delete

Girdi

Yayımladığı olaylar: popups.deleted

Neye yazar: popup (delete) — Deletes the popup; popup_event (delete) — Deletes its counts

curl -X POST https://app.getera.io/api/v1/popups/actions/delete \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"id":"ID_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "popups.deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.popups.delete({
  id: "ID_ID"
})

era popups delete \
  --id "ID_ID"

{
  "name": "era__popups__delete",
  "arguments": {
    "id": "ID_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde popups:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 429 çok sık istek

popups.save

Açılır pencere oluştur ya da düzenle — Web sitenizde ziyaretçilere gösterilecek açılır pencereyi, hedeflemesini ve A/B içeriğini kaydeder.

Gereken izin popups:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/popups.save

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: popups.saved

Neye yazar: popup (upsert) — Saves the popup as a new revision

curl -X POST https://app.getera.io/api/v1/popups/actions/save \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name","siteId":"SITE_ID","config":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "popups.saved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.popups.save({
  name: "Name",
  siteId: "SITE_ID",
  config: {}
})

era popups save --data '{"name":"Name","siteId":"SITE_ID","config":{}}'

{
  "name": "era__popups__save",
  "arguments": {
    "name": "Name",
    "siteId": "SITE_ID",
    "config": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde popups:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 popup_invalid · 429 çok sık istek

popups.submit

Açılır pencere formunu gönder — Form motoruyla bir potansiyel müşteri oluşturur ve başarılı gönderimi A/B ölçümüne ekler.

Gereken izin popups:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/popups.submit

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Neye yazar: popup_event (insert) — A successful form send

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde popups:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 popup_invalid · 429 çok sık istek

popups.track

Açılır pencere etkileşimini say — Anonim bir görüntülemeyi ya da tıklamayı bir kez kaydeder.

Gereken izin popups:write · veriyi değiştirir · Yayındaki bir siteden de çağrılabilir (visitor)

• Asıl adres: POST /api/v1/actions/popups.track

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Neye yazar: popup_event (insert) — One interaction

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde popups:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 popup_invalid · 429 çok sık istek

Veri modelleri

PopupEvent

Tablo popup_event · Kaynak popup_events

• GET /api/v1/popup_events
• GET /api/v1/popup_events/{id}

Birincil anahtar: id

Tekil: popup_id, revision, impression_id, kind

Popup

Tablo popup · Kaynak popups

• GET /api/v1/popups
• GET /api/v1/popups/{id}

Birincil anahtar: id

Denetimler:

• CHECK (((ends_at IS NULL) OR (starts_at IS NULL) OR (ends_at > starts_at)))

Olaylar

İş akışları ve webhook'lar bu olaylara tepki verir.