Belgeler menüsüManagement API

Postlip Metrics Management API

Uygulama, kaynak ve olay şemasının otomasyonu (ör. CI'da şema senkronu, metrics pull) ve Query API (panelin metrik sorgusu, /v1/query). Kimlik: organizasyonun panelden oluşturduğu API anahtarı, Authorization: Bearer mk_…. Kapsamlar: management:read, management:write (okumayı da içerir), query:read (Query API: POST /v1/query, GET /v1/query/catalogue, huni sonuçları; reklam metrikleri dahil), leads:read (talep kutusu), ads:read (reklam hesapları, kampanyalar, bütçe, bağlantıların sağlığı), reports:read (kayıtlı raporlar, donmuş çıktıları ve PDF’leri, tahmin senaryoları), social:read (sosyal medya hesapları, özetin sayıları, gönderiler ve sayıları), messaging:read / messaging:write (Mailing & SMS listeleri, kampanyalar ve sonuçları; kişi, izin, bastırma), persons:read (analitik kişi ve hesap profilleri ve zaman çizelgeleri, panelin saklama kurallarıyla; dalga 16). Dalga 16’dan management:write ayrıca kaynakları ve anahtarlarını, olay tanımlarının durumunu ve silinmesini, kişi / hesap özellik tanımlarını yönetir ve üye davet eder (management:read: üyeler, roller, davetler). Hata gövdesi her uçta { "error": { "code", "message", "fields"?, "details"?, "traceId" } }; message isteğin dilinde (Accept-Language: tr, en). Liste uçları imleç sayfalamalıdır: ?cursor=&limit= (≤ 200), yanıt { items, nextCursor }.

Sürüm 1.0.0OpenAPI 3.1.1OpenAPI belgesini indir

Bu sayfa derleme sırasında depodaki docs/api/openapi/management.json dosyasından üretilir.

Sunucular

Adres	Açıklama
`https://api.metrics.example`	Management API

Kimlik doğrulama

Ad	Yöntem	Açıklama
`apiKey`	Bearer belirteci (mk_…)	Organizasyonun Management API anahtarı (`mk_` + 40 karakter).

Sağlık

1 uç

Sürecin ve veritabanı bağlantısının durumu.

GET/v1/health

Sağlık

Herkese açık: kimlik gerekmez.

Kimlik: Kimlik gerekmez

Yanıtlar

200
Başarılı.
application/jsonobject
Örnek · JSON
```
{
  "status": "ok",
  "database": "ok"
}
```
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Organizasyon

4 uç

Organizasyon ayarları, üyeler, davetler, roller.

GET/v1/invitations

Davetler

Bekleyen, kabul edilen, süresi dolan ve iptal edilen davetler. Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	Değerler: pending, accepted, revoked, expired

Yanıtlar

200

Başarılı.

application/jsonInvitationPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "email": "string",
      "role": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "key": "string",
        "name": "string",
        "builtIn": true
      },
      "appScope": "all",
      "appIds": [
        "01a1b249-9ed2-77e8-af53-0c99529e68cb"
      ],
      "status": "pending",
      "invitedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "expiresAt": "2026-11-06T14:46:00+03:00",
      "acceptedAt": "2026-11-06T14:46:00+03:00",
      "revokedAt": "2026-11-06T14:46:00+03:00",
      "createdAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/invitations

Üye davet et

Adrese yedi gün geçerli bir davet e-postası gider (davet edenin adı yazmaz). Anahtar yöneticinin (admin) haklarıyla davet eder: sahip rolü ve yöneticinin vermediği izinli rol verilemez (ROLE_NOT_GRANTABLE), uygulama kapsamı anahtarınkini aşamaz (APP_SCOPE_TOO_WIDE); etkin üye yeniden davet edilmez, adresin bekleyen davetleri yenisiyle değişir; planın üye sınırı (etkin üyeler ve bekleyen davetler) 403 PLAN_LIMIT_REACHED. Kapsam: management:write; denetim kaydıyla.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

İstek gövdesiGövde zorunlu

application/jsonCreateInvitationRequest

Alan	Tip	Açıklama
`email`zorunlu	`string`	1–320 karakter
`roleId`zorunlu	`string`	Biçim: uuid
`appScope`	`string`	Değerler: all, selected · Varsayılan: all
`appIds`	`string[]`	en çok 200 öğe · Varsayılan: []

Örnek · JSON

{
  "email": "string",
  "roleId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appScope": "all",
  "appIds": []
}

Yanıtlar

201

Oluşturuldu.

application/jsonInvitation

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "email": "string",
  "role": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "key": "string",
    "name": "string",
    "builtIn": true
  },
  "appScope": "all",
  "appIds": [
    "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  ],
  "status": "pending",
  "invitedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "expiresAt": "2026-11-06T14:46:00+03:00",
  "acceptedAt": "2026-11-06T14:46:00+03:00",
  "revokedAt": "2026-11-06T14:46:00+03:00",
  "createdAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/members

Üyeler

Organizasyonun üyeleri (panelde members.manage ile görülen liste: ad, e-posta, rol, uygulama kapsamı, durum, son giriş, iki adımlı doğrulama). Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	Değerler: active, disabled

Yanıtlar

200

Başarılı.

application/jsonMemberPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "user": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "email": "string",
        "name": "string"
      },
      "role": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "key": "string",
        "name": "string",
        "builtIn": true
      },
      "appScope": "all",
      "appIds": [
        "01a1b249-9ed2-77e8-af53-0c99529e68cb"
      ],
      "status": "active",
      "invitedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/roles

Roller

Yerleşik ve organizasyonun rolleri, izinleriyle (davet için roleId). Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Yanıtlar

200

Başarılı.

application/jsonRoleList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "key": "string",
      "name": "string",
      "description": "string",
      "permissions": [
        "string"
      ],
      "builtIn": true,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Uygulamalar

4 uç

Ölçülen ürünler: saat dilimi, para birimi, doğrulama kipi, atıf ve saklama ayarları; test, iç ve bot trafiği işaretleyen trafik filtresi kuralları.

GET/v1/apps

Uygulamalar

Anahtarın uygulama kapsamındakiler.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	Değerler: active, archived

Yanıtlar

200

Başarılı.

application/jsonAppPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "slug": "string",
      "name": "string",
      "description": "string",
      "websiteUrl": "string",
      "iconUrl": "string",
      "timezone": "string",
      "currency": "string",
      "schemaMode": "strict",
      "schemaRevision": 0,
      "attributionModel": "first_touch",
      "attributionWindowDays": 0,
      "conversionRoles": [
        "signup"
      ],
      "leadContactClicks": true,
      "retention": {
        "eventsMonths": 0,
        "interactionsMonths": 0,
        "sessionsMonths": 0
      },
      "internalIpRanges": [
        "string"
      ],
      "internalCookie": "string",
      "status": "active",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps

Uygulama ekle

Bütün uygulamalar kapsamlı anahtar gerekir.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

İstek gövdesiGövde zorunlu

application/jsonCreateAppRequest

Alan	Tip	Açıklama
`slug`zorunlu	`string`	Desen: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 karakter
`name`zorunlu	`string`	1–200 karakter
`description`	`string`	null olabilir
`websiteUrl`	`string`	null olabilir
`iconUrl`	`string`	null olabilir
`timezone`	`string`	en çok 64 karakter
`currency`	`string`	Desen: `^[A-Z]{3}$`
`schemaMode`	`string`	Değerler: strict, lenient, discover · Varsayılan: lenient
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid · Varsayılan: last_non_direct
`attributionWindowDays`	`integer`	1–365 · Varsayılan: 90
`conversionRoles`	`string[]`	1–16 öğe · Varsayılan: ["signup","trial_start","lead","demo_request","purchase"]
`leadContactClicks`	`boolean`	Varsayılan: false
`retention`	`object`
`retention.eventsMonths`zorunlu	`integer`	1–120
`retention.interactionsMonths`zorunlu	`integer`	1–60
`retention.sessionsMonths`zorunlu	`integer`	1–120
`internalIpRanges`	`string[]`	en çok 100 öğe · Varsayılan: []
`internalCookie`	`string`	null olabilir
`revenueBasis`	`string`	Değerler: gross, net · Varsayılan: gross
`pricesIncludeTax`	`boolean`	Varsayılan: true
`overviewTiles`	`OverviewTileRequest[]`	en çok 12 öğe · Varsayılan: []
`adsKpis`	`string[]`	en çok 12 öğe · Varsayılan: []
`modules`	`string[]`	en çok 6 öğe · Varsayılan: ["ads","social","messaging","content","leads","behavior"]
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	en çok 50 öğe · Varsayılan: []

Örnek · JSON

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "websiteUrl": "string",
  "iconUrl": "string",
  "timezone": "string",
  "currency": "string",
  "schemaMode": "lenient",
  "attributionModel": "last_non_direct",
  "attributionWindowDays": 90,
  "conversionRoles": [
    "signup",
    "trial_start",
    "lead",
    "demo_request",
    "purchase"
  ],
  "leadContactClicks": false,
  "retention": {
    "eventsMonths": 1,
    "interactionsMonths": 1,
    "sessionsMonths": 1
  },
  "internalIpRanges": [],
  "internalCookie": "string",
  "revenueBasis": "gross",
  "pricesIncludeTax": true,
  "overviewTiles": [],
  "adsKpis": [],
  "modules": [
    "ads",
    "social",
    "messaging",
    "content",
    "leads",
    "behavior"
  ],
  "defaultAlertRecipients": {
    "inApp": true,
    "userIds": []
  },
  "searchBrandTerms": []
}

Yanıtlar

201

Oluşturuldu.

application/jsonApp

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "slug": "string",
  "name": "string",
  "description": "string",
  "websiteUrl": "string",
  "iconUrl": "string",
  "timezone": "string",
  "currency": "string",
  "schemaMode": "strict",
  "schemaRevision": 0,
  "attributionModel": "first_touch",
  "attributionWindowDays": 0,
  "conversionRoles": [
    "signup"
  ],
  "leadContactClicks": true,
  "retention": {
    "eventsMonths": 0,
    "interactionsMonths": 0,
    "sessionsMonths": 0
  },
  "internalIpRanges": [
    "string"
  ],
  "internalCookie": "string",
  "revenueBasis": "gross",
  "pricesIncludeTax": true,
  "overviewTiles": [
    {
      "metric": "string",
      "breakdown": "string"
    }
  ],
  "adsKpis": [
    "string"
  ],
  "modules": [
    "ads"
  ],
  "defaultAlertRecipients": {
    "inApp": true,
    "userIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ],
    "emails": [
      "string"
    ],
    "channelIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ]
  },
  "searchBrandTerms": [
    "string"
  ],
  "defaultOverviewTiles": [
    {
      "metric": "string",
      "breakdown": "string"
    }
  ],
  "defaultAdsKpis": [
    "string"
  ],
  "status": "active",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}

Uygulama

Uygulamanın ayarları. Tek uygulama okumasında (dalga 16) ayrıca, uygulama kendi setini kaydetmemişken Genel bakış ve Reklam özetinin gösterdiği varsayılan setler: defaultOverviewTiles (uygulamanın tanımlarının oynadığı dönüşüm rolleri, uygulamanın sırasıyla, en çok 5) ve defaultAdsKpis (harcama, gösterim, tıklama, ilk dört rolün reklamdan dönüşümü, ilk rolün dönüşüm başı maliyeti) — kural contracts defaultOverviewTiles / defaultAdsKpis. Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonApp

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "slug": "string",
  "name": "string",
  "description": "string",
  "websiteUrl": "string",
  "iconUrl": "string",
  "timezone": "string",
  "currency": "string",
  "schemaMode": "strict",
  "schemaRevision": 0,
  "attributionModel": "first_touch",
  "attributionWindowDays": 0,
  "conversionRoles": [
    "signup"
  ],
  "leadContactClicks": true,
  "retention": {
    "eventsMonths": 0,
    "interactionsMonths": 0,
    "sessionsMonths": 0
  },
  "internalIpRanges": [
    "string"
  ],
  "internalCookie": "string",
  "revenueBasis": "gross",
  "pricesIncludeTax": true,
  "overviewTiles": [
    {
      "metric": "string",
      "breakdown": "string"
    }
  ],
  "adsKpis": [
    "string"
  ],
  "modules": [
    "ads"
  ],
  "defaultAlertRecipients": {
    "inApp": true,
    "userIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ],
    "emails": [
      "string"
    ],
    "channelIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ]
  },
  "searchBrandTerms": [
    "string"
  ],
  "defaultOverviewTiles": [
    {
      "metric": "string",
      "breakdown": "string"
    }
  ],
  "defaultAdsKpis": [
    "string"
  ],
  "status": "active",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PATCH/v1/apps/{appId}

Uygulamayı güncelle

Ayarlar (13. dalga): revenueBasis (gross | net — başlık gelir), pricesIncludeTax (tutarlar KDV dahil mi; brüt para metriklerinin etiketi bunu söyler), overviewTiles (Genel bakış kutuları, en çok 12: katalog metriği ve isteğe bağlı kırılım — metrik ve boyut katalogla doğrulanır), adsKpis (Reklam KPI seti, en çok 12; boş: varsayılan), modules (açık modüller: ads, social, messaging, content, leads, behavior; kapalı modülün uçları 403 APP_MODULE_DISABLED), defaultAlertRecipients (alıcı vermeyen yeni uyarı kuralının alıcıları; üyeler ve kanallar doğrulanır), searchBrandTerms (Search Console marka ayrımı, küçük harfe çevrilir). Hatalı alan fields altında (ör. overviewTiles.0.metric).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpdateAppRequest

Alan	Tip	Açıklama
`slug`	`string`	Desen: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 karakter
`name`	`string`	1–200 karakter
`description`	`string`	null olabilir
`websiteUrl`	`string`	null olabilir
`iconUrl`	`string`	null olabilir
`timezone`	`string`	en çok 64 karakter
`currency`	`string`	Desen: `^[A-Z]{3}$`
`schemaMode`	`string`	Değerler: strict, lenient, discover
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`	`integer`	1–365
`conversionRoles`	`string[]`	1–16 öğe
`leadContactClicks`	`boolean`
`retention`	`object`
`retention.eventsMonths`zorunlu	`integer`	1–120
`retention.interactionsMonths`zorunlu	`integer`	1–60
`retention.sessionsMonths`zorunlu	`integer`	1–120
`internalIpRanges`	`string[]`	en çok 100 öğe
`internalCookie`	`string`	null olabilir
`revenueBasis`	`string`	Değerler: gross, net
`pricesIncludeTax`	`boolean`
`overviewTiles`	`OverviewTileRequest[]`	en çok 12 öğe
`adsKpis`	`string[]`	en çok 12 öğe
`modules`	`string[]`	en çok 6 öğe
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	en çok 50 öğe

Örnek · JSON

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "websiteUrl": "string",
  "iconUrl": "string",
  "timezone": "string",
  "currency": "string",
  "schemaMode": "strict",
  "attributionModel": "first_touch",
  "attributionWindowDays": 1,
  "conversionRoles": [
    "signup"
  ],
  "leadContactClicks": true,
  "retention": {
    "eventsMonths": 1,
    "interactionsMonths": 1,
    "sessionsMonths": 1
  },
  "internalIpRanges": [
    "string"
  ],
  "internalCookie": "string",
  "revenueBasis": "gross",
  "pricesIncludeTax": true,
  "overviewTiles": [
    {
      "metric": "string"
    }
  ],
  "adsKpis": [
    "string"
  ],
  "modules": [
    "ads"
  ],
  "defaultAlertRecipients": {
    "inApp": true,
    "userIds": []
  },
  "searchBrandTerms": [
    "string"
  ]
}

Yanıtlar

200

Başarılı.

application/jsonApp

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "slug": "string",
  "name": "string",
  "description": "string",
  "websiteUrl": "string",
  "iconUrl": "string",
  "timezone": "string",
  "currency": "string",
  "schemaMode": "strict",
  "schemaRevision": 0,
  "attributionModel": "first_touch",
  "attributionWindowDays": 0,
  "conversionRoles": [
    "signup"
  ],
  "leadContactClicks": true,
  "retention": {
    "eventsMonths": 0,
    "interactionsMonths": 0,
    "sessionsMonths": 0
  },
  "internalIpRanges": [
    "string"
  ],
  "internalCookie": "string",
  "revenueBasis": "gross",
  "pricesIncludeTax": true,
  "overviewTiles": [
    {
      "metric": "string",
      "breakdown": "string"
    }
  ],
  "adsKpis": [
    "string"
  ],
  "modules": [
    "ads"
  ],
  "defaultAlertRecipients": {
    "inApp": true,
    "userIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ],
    "emails": [
      "string"
    ],
    "channelIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ]
  },
  "searchBrandTerms": [
    "string"
  ],
  "defaultOverviewTiles": [
    {
      "metric": "string",
      "breakdown": "string"
    }
  ],
  "defaultAdsKpis": [
    "string"
  ],
  "status": "active",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Kaynaklar

8 uç

Veri gönderen istemciler, yakalama ayarları, yazma anahtarları ve imza anahtarları, kaynak sağlığı.

GET/v1/apps/{appId}/sources

Kaynaklar

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	Değerler: active, disabled
`kind`	sorgu	`string`	Değerler: web, ios, android, server, other

Yanıtlar

200

Başarılı.

application/jsonSourcePage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "kind": "web",
      "environment": "production",
      "status": "active",
      "requireSignature": true,
      "allowedOrigins": [
        "string"
      ],
      "consentMode": "required",
      "excludedPaths": [
        "string"
      ],
      "maskSelectors": [
        "string"
      ],
      "ignoreSelectors": [
        "string"
      ],
      "stripQueryParams": [
        "string"
      ],
      "sessionTimeoutMinutes": 0,
      "interactionSampleRate": 0,
      "autocapture": {
        "pageviews": true,
        "pageleave": true,
        "clicks": true,
        "rageClicks": true,
        "deadClicks": true,
        "scroll": true,
        "errors": true,
        "forms": true,
        "layout": true,
        "outboundLinks": true,
        "downloads": true,
        "webVitals": true
      },
      "dataLayerEvents": [
        "string"
      ],
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/sources

Kaynak ekle

Tür (web, ios, android, server, other), ortam, rıza kipi ve yakalama ayarları. Planın kaynak sınırı organizasyonun bütün uygulamalarındaki kaynakları sayar; sınıra ulaşılmışsa 403 PLAN_LIMIT_REACHED. Anahtar ayrıca oluşturulur (POST …/keys). Kapsam: management:write; denetim kaydıyla (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonCreateSourceRequest

Alan	Tip	Açıklama
`name`zorunlu	`string`	1–200 karakter
`kind`zorunlu	`string`	Değerler: web, ios, android, server, other
`environment`	`string`	Değerler: production, staging, development · Varsayılan: production
`requireSignature`	`boolean`	Varsayılan: false
`allowedOrigins`	`string[]`	en çok 100 öğe · Varsayılan: []
`consentMode`	`string`	Değerler: required, implied, none · Varsayılan: required
`excludedPaths`	`string[]`	en çok 200 öğe · Varsayılan: []
`maskSelectors`	`string[]`	en çok 100 öğe · Varsayılan: []
`ignoreSelectors`	`string[]`	en çok 100 öğe · Varsayılan: []
`stripQueryParams`	`string[]`	en çok 100 öğe · Varsayılan: []
`sessionTimeoutMinutes`	`integer`	5–240 · Varsayılan: 30
`interactionSampleRate`	`number`	0–1 · Varsayılan: 1
`autocapture`	`object`	Varsayılan: {}
`autocapture.pageviews`	`boolean`
`autocapture.pageleave`	`boolean`
`autocapture.clicks`	`boolean`
`autocapture.rageClicks`	`boolean`
`autocapture.deadClicks`	`boolean`
`autocapture.scroll`	`boolean`
`autocapture.errors`	`boolean`
`autocapture.forms`	`boolean`
`autocapture.layout`	`boolean`
`autocapture.outboundLinks`	`boolean`
`autocapture.downloads`	`boolean`
`autocapture.webVitals`	`boolean`
`dataLayerEvents`	`string[]`	en çok 100 öğe · Varsayılan: []

Örnek · JSON

{
  "name": "string",
  "kind": "web",
  "environment": "production",
  "requireSignature": false,
  "allowedOrigins": [],
  "consentMode": "required",
  "excludedPaths": [],
  "maskSelectors": [],
  "ignoreSelectors": [],
  "stripQueryParams": [],
  "sessionTimeoutMinutes": 30,
  "interactionSampleRate": 1,
  "autocapture": {},
  "dataLayerEvents": []
}

Yanıtlar

201

Oluşturuldu.

application/jsonSource

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "kind": "web",
  "environment": "production",
  "status": "active",
  "requireSignature": true,
  "allowedOrigins": [
    "string"
  ],
  "consentMode": "required",
  "excludedPaths": [
    "string"
  ],
  "maskSelectors": [
    "string"
  ],
  "ignoreSelectors": [
    "string"
  ],
  "stripQueryParams": [
    "string"
  ],
  "sessionTimeoutMinutes": 0,
  "interactionSampleRate": 0,
  "autocapture": {
    "pageviews": true,
    "pageleave": true,
    "clicks": true,
    "rageClicks": true,
    "deadClicks": true,
    "scroll": true,
    "errors": true,
    "forms": true,
    "layout": true,
    "outboundLinks": true,
    "downloads": true,
    "webVitals": true
  },
  "dataLayerEvents": [
    "string"
  ],
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/sources/{sourceId}

Kaynak

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`sourceId`zorunlu	yol	`string`	Kaynağın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonSource

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "kind": "web",
  "environment": "production",
  "status": "active",
  "requireSignature": true,
  "allowedOrigins": [
    "string"
  ],
  "consentMode": "required",
  "excludedPaths": [
    "string"
  ],
  "maskSelectors": [
    "string"
  ],
  "ignoreSelectors": [
    "string"
  ],
  "stripQueryParams": [
    "string"
  ],
  "sessionTimeoutMinutes": 0,
  "interactionSampleRate": 0,
  "autocapture": {
    "pageviews": true,
    "pageleave": true,
    "clicks": true,
    "rageClicks": true,
    "deadClicks": true,
    "scroll": true,
    "errors": true,
    "forms": true,
    "layout": true,
    "outboundLinks": true,
    "downloads": true,
    "webVitals": true
  },
  "dataLayerEvents": [
    "string"
  ],
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PATCH/v1/apps/{appId}/sources/{sourceId}

Kaynağı güncelle

Yakalama ayarları SDK'lara uzak yapılandırma olarak sunulur; autocapture gönderilen anahtarları kaynağın ayarlarıyla birleştirir. Kaynak Management API ile silinmez (panelde). Kapsam: management:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`sourceId`zorunlu	yol	`string`	Kaynağın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpdateSourceRequest

Alan	Tip	Açıklama
`name`	`string`	1–200 karakter
`environment`	`string`	Değerler: production, staging, development
`status`	`string`	Değerler: active, disabled
`requireSignature`	`boolean`
`allowedOrigins`	`string[]`	en çok 100 öğe
`consentMode`	`string`	Değerler: required, implied, none
`excludedPaths`	`string[]`	en çok 200 öğe
`maskSelectors`	`string[]`	en çok 100 öğe
`ignoreSelectors`	`string[]`	en çok 100 öğe
`stripQueryParams`	`string[]`	en çok 100 öğe
`sessionTimeoutMinutes`	`integer`	5–240
`interactionSampleRate`	`number`	0–1
`autocapture`	`object`
`autocapture.pageviews`	`boolean`
`autocapture.pageleave`	`boolean`
`autocapture.clicks`	`boolean`
`autocapture.rageClicks`	`boolean`
`autocapture.deadClicks`	`boolean`
`autocapture.scroll`	`boolean`
`autocapture.errors`	`boolean`
`autocapture.forms`	`boolean`
`autocapture.layout`	`boolean`
`autocapture.outboundLinks`	`boolean`
`autocapture.downloads`	`boolean`
`autocapture.webVitals`	`boolean`
`dataLayerEvents`	`string[]`	en çok 100 öğe

Örnek · JSON

{
  "name": "string",
  "environment": "production",
  "status": "active",
  "requireSignature": true,
  "allowedOrigins": [
    "string"
  ],
  "consentMode": "required",
  "excludedPaths": [
    "string"
  ],
  "maskSelectors": [
    "string"
  ],
  "ignoreSelectors": [
    "string"
  ],
  "stripQueryParams": [
    "string"
  ],
  "sessionTimeoutMinutes": 5,
  "interactionSampleRate": 0,
  "autocapture": {
    "pageviews": true,
    "pageleave": true
  },
  "dataLayerEvents": [
    "string"
  ]
}

Yanıtlar

200

Başarılı.

application/jsonSource

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "kind": "web",
  "environment": "production",
  "status": "active",
  "requireSignature": true,
  "allowedOrigins": [
    "string"
  ],
  "consentMode": "required",
  "excludedPaths": [
    "string"
  ],
  "maskSelectors": [
    "string"
  ],
  "ignoreSelectors": [
    "string"
  ],
  "stripQueryParams": [
    "string"
  ],
  "sessionTimeoutMinutes": 0,
  "interactionSampleRate": 0,
  "autocapture": {
    "pageviews": true,
    "pageleave": true,
    "clicks": true,
    "rageClicks": true,
    "deadClicks": true,
    "scroll": true,
    "errors": true,
    "forms": true,
    "layout": true,
    "outboundLinks": true,
    "downloads": true,
    "webVitals": true
  },
  "dataLayerEvents": [
    "string"
  ],
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/sources/{sourceId}/health

Kaynak sağlığı

Durum, son olay ve son ret, son kütüphane; son 24 saatte kabul edilen olay, ret, örneklenmiş uyarı ve ret oranı (Σ ret ÷ (Σ olay + Σ ret)). Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`sourceId`zorunlu	yol	`string`	Kaynağın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonSourceHealth

Örnek · JSON

{
  "sourceId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "state": "no_data",
  "lastEventAt": "2026-11-06T14:46:00+03:00",
  "lastRejectionAt": "2026-11-06T14:46:00+03:00",
  "lastLibrary": "string",
  "rejectionsLast24h": 0,
  "eventsLast24h": 0,
  "warningsLast24h": 0,
  "rejectionRate": 0
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/sources/{sourceId}/keys

Kaynak anahtarları (maskeli)

Önek ve son dört karakter, kip, oluşturma, iptal ve geçiş süresi; anahtarın tamamı hiç dönmez. Kapsam: management:write (panelde de yalnız kaynak yöneticisi görür).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`sourceId`zorunlu	yol	`string`	Kaynağın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonSourceKeyList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "kind": "write",
      "mode": "live",
      "maskedKey": "string",
      "displayPrefix": "string",
      "last4": "string",
      "state": "active",
      "revokedAt": "2026-11-06T14:46:00+03:00",
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/sources/{sourceId}/keys

Anahtar oluştur

Yazma anahtarı pk_live_…/pk_test_… (SHA-256 özetiyle saklanır) ya da imza anahtarı sk_live_…/sk_test_… (sır kutusunda mühürlü). Anahtarın tamamı yalnız bu yanıtta görünür. Kapsam: management:write; denetim kaydıyla.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`sourceId`zorunlu	yol	`string`	Kaynağın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonCreateSourceKeyRequest

Alan	Tip	Açıklama
`kind`zorunlu	`string`	Değerler: write, signing
`mode`	`string`	Değerler: live, test · Varsayılan: live

Örnek · JSON

{
  "kind": "write",
  "mode": "live"
}

Yanıtlar

201

Oluşturuldu.

application/jsonCreatedSourceKey

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "kind": "write",
  "mode": "live",
  "maskedKey": "string",
  "displayPrefix": "string",
  "last4": "string",
  "state": "active",
  "revokedAt": "2026-11-06T14:46:00+03:00",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "key": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/sources/{sourceId}/keys/{keyId}/revoke

Anahtarı iptal et

graceMinutes kadar daha geçerli kalır (anahtar yenilemede geçiş süresi, en çok 7 gün). Kapsam: management:write; denetim kaydıyla.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`sourceId`zorunlu	yol	`string`	Kaynağın kimliği. Biçim: uuid
`keyId`zorunlu	yol	`string`	Biçim: uuid

İstek gövdesi

application/jsonRevokeSourceKeyRequest

Alan	Tip	Açıklama
`graceMinutes`	`integer`	0–10080 · Varsayılan: 0

Örnek · JSON

{
  "graceMinutes": 0
}

Yanıtlar

200

Başarılı.

application/jsonSourceKey

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "kind": "write",
  "mode": "live",
  "maskedKey": "string",
  "displayPrefix": "string",
  "last4": "string",
  "state": "active",
  "revokedAt": "2026-11-06T14:46:00+03:00",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Olay şeması

16 uç

Olay ve özellik tanımları, kişi/hesap özellikleri, değişiklik geçmişi, keşfedilen olaylar, şema paketi.

GET/v1/apps/{appId}/event-definitions

Olay tanımları

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	Değerler: draft, active, deprecated, blocked
`role`	sorgu	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`search`	sorgu	`string`	en çok 100 karakter

Yanıtlar

200

Başarılı.

application/jsonEventDefinitionPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "displayName": "string",
      "description": "string",
      "category": "string",
      "roles": [
        "signup"
      ],
      "status": "draft",
      "aliases": [
        "string"
      ],
      "version": 1,
      "propertyCount": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/event-definitions

Olay tanımı ekle

Her değişiklik tanımın sürümünü bir artırır, uygulamanın şema revizyonunu ilerletir ve schema_changes geçmişine yazılır. $ ile başlayan adlar sistem olaylarına ayrılmıştır; seçenekli (enum) tip izinli değer ister; kişisel ve hassas veri allow ile saklanamaz.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonCreateEventDefinitionRequest

Alan	Tip	Açıklama
`name`zorunlu	`string`	1–200 karakter
`displayName`zorunlu	`string`	1–200 karakter
`description`	`string`	null olabilir
`category`	`string`	null olabilir
`roles`	`string[]`	en çok 16 öğe · Varsayılan: []
`status`	`string`	Değerler: draft, active, deprecated, blocked · Varsayılan: active
`aliases`	`string[]`	en çok 20 öğe · Varsayılan: []
`properties`	`PropertyDefinitionInput[]`	en çok 200 öğe
`displayNames`	`LocalizedNames`

Örnek · JSON

{
  "name": "string",
  "displayName": "string",
  "description": "string",
  "category": "string",
  "roles": [],
  "status": "active",
  "aliases": [],
  "properties": [
    {
      "key": "string",
      "type": "string"
    }
  ],
  "displayNames": {
    "tr": "string",
    "en": "string"
  }
}

Yanıtlar

201

Oluşturuldu.

application/jsonEventDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "displayName": "string",
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "description": "string",
  "category": "string",
  "roles": [
    "signup"
  ],
  "status": "draft",
  "aliases": [
    "string"
  ],
  "version": 1,
  "propertyCount": 0,
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "properties": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scope": "event",
      "key": "string",
      "type": "string",
      "itemType": "string",
      "required": true,
      "description": "string",
      "piiClass": "none",
      "piiAction": "allow",
      "enumValues": [
        "string"
      ],
      "maxLength": 0,
      "minimum": 0,
      "maximum": 0,
      "example": {},
      "sortOrder": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/event-definitions/{eventId}

Olay tanımı

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`eventId`zorunlu	yol	`string`	Olay tanımının kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonEventDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "displayName": "string",
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "description": "string",
  "category": "string",
  "roles": [
    "signup"
  ],
  "status": "draft",
  "aliases": [
    "string"
  ],
  "version": 1,
  "propertyCount": 0,
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "properties": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scope": "event",
      "key": "string",
      "type": "string",
      "itemType": "string",
      "required": true,
      "description": "string",
      "piiClass": "none",
      "piiAction": "allow",
      "enumValues": [
        "string"
      ],
      "maxLength": 0,
      "minimum": 0,
      "maximum": 0,
      "example": {},
      "sortOrder": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PATCH/v1/apps/{appId}/event-definitions/{eventId}

Olay tanımını güncelle

properties gönderilirse listenin tamamını değiştirir (anahtarı korunan özelliğin kimliği kalır). Ad değişmez; eski adlar aliases ile eşlenir. Her değişiklik tanımın sürümünü bir artırır, uygulamanın şema revizyonunu ilerletir ve schema_changes geçmişine yazılır. $ ile başlayan adlar sistem olaylarına ayrılmıştır; seçenekli (enum) tip izinli değer ister; kişisel ve hassas veri allow ile saklanamaz.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`eventId`zorunlu	yol	`string`	Olay tanımının kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpdateEventDefinitionRequest

Alan	Tip	Açıklama
`displayName`	`string`	1–200 karakter
`description`	`string`	null olabilir
`category`	`string`	null olabilir
`roles`	`string[]`	en çok 16 öğe
`aliases`	`string[]`	en çok 20 öğe
`properties`	`PropertyDefinitionInput[]`	en çok 200 öğe
`displayNames`	`LocalizedNames`

Örnek · JSON

{
  "displayName": "string",
  "description": "string",
  "category": "string",
  "roles": [
    "signup"
  ],
  "aliases": [
    "string"
  ],
  "properties": [
    {
      "key": "string",
      "type": "string"
    }
  ],
  "displayNames": {
    "tr": "string",
    "en": "string"
  }
}

Yanıtlar

200

Başarılı.

application/jsonEventDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "displayName": "string",
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "description": "string",
  "category": "string",
  "roles": [
    "signup"
  ],
  "status": "draft",
  "aliases": [
    "string"
  ],
  "version": 1,
  "propertyCount": 0,
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "properties": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scope": "event",
      "key": "string",
      "type": "string",
      "itemType": "string",
      "required": true,
      "description": "string",
      "piiClass": "none",
      "piiAction": "allow",
      "enumValues": [
        "string"
      ],
      "maxLength": 0,
      "minimum": 0,
      "maximum": 0,
      "example": {},
      "sortOrder": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

DELETE/v1/apps/{appId}/event-definitions/{eventId}

Olay tanımını sil

Geçmişe silme kaydı yazılır; saklanan olaylar kalır. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`eventId`zorunlu	yol	`string`	Olay tanımının kimliği. Biçim: uuid

Yanıtlar

204
Başarılı; yanıt gövdesi yok.
400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/event-definitions/{eventId}/json-schema

Olayın JSON Schema belgesi

Özellikler JSON Schema (draft 2020-12) olarak; katı kipte tanımsız özellik reddedilir (additionalProperties: false).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`eventId`zorunlu	yol	`string`	Olay tanımının kimliği. Biçim: uuid

Yanıtlar

200
Başarılı.
application/jsonJsonSchemaDocument
Örnek · JSON
```
{}
```
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/event-definitions/{eventId}/status

Olay tanımının durumunu değiştir

draft, active, deprecated (uyarıyla kabul) ya da blocked (alımda reddedilir); geçmişe yazılır. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`eventId`zorunlu	yol	`string`	Olay tanımının kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonChangeEventStatusRequest

Alan	Tip	Açıklama
`status`zorunlu	`string`	Değerler: draft, active, deprecated, blocked

Örnek · JSON

{
  "status": "draft"
}

Yanıtlar

200

Başarılı.

application/jsonEventDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "displayName": "string",
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "description": "string",
  "category": "string",
  "roles": [
    "signup"
  ],
  "status": "draft",
  "aliases": [
    "string"
  ],
  "version": 1,
  "propertyCount": 0,
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "properties": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scope": "event",
      "key": "string",
      "type": "string",
      "itemType": "string",
      "required": true,
      "description": "string",
      "piiClass": "none",
      "piiAction": "allow",
      "enumValues": [
        "string"
      ],
      "maxLength": 0,
      "minimum": 0,
      "maximum": 0,
      "example": {},
      "sortOrder": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/group-traits

Hesap özelliği tanımları

Uygulamanın hesap (group) özellik tanımları (anahtar, tür, kişisel veri sınıfı ve eylemi, iki dilde ad). Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonTraitList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scope": "event",
      "key": "string",
      "type": "string",
      "itemType": "string",
      "required": true,
      "description": "string",
      "piiClass": "none",
      "piiAction": "allow",
      "enumValues": [
        "string"
      ],
      "maxLength": 0,
      "minimum": 0,
      "maximum": 0,
      "example": {},
      "sortOrder": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/group-traits

Hesap özelliği tanımı ekle

Kişisel veri sınıfı (piiClass) ve eylemi (piiAction: allow, hash, drop, reject) alımda ve profillerde uygulanır. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonPropertyDefinitionInput

Alan	Tip	Açıklama
`key`zorunlu	`string`	Desen: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 karakter
`type`zorunlu	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	null olabilir
`required`	`boolean`	Varsayılan: false
`description`	`string`	null olabilir
`piiClass`	`string`	Değerler: none, pseudonymous, personal, sensitive · Varsayılan: none
`piiAction`	`string`	Değerler: allow, hash, drop, reject · Varsayılan: allow
`enumValues`	`string[]`	null olabilir
`maxLength`	`integer`	null olabilir
`minimum`	`number`	null olabilir
`maximum`	`number`	null olabilir
`example`	`any`
`displayNames`	`LocalizedNames`

Örnek · JSON

{
  "key": "string",
  "type": "string",
  "itemType": "string",
  "required": false,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 1,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "displayNames": {
    "tr": "string",
    "en": "string"
  }
}

Yanıtlar

201

Oluşturuldu.

application/jsonPropertyDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "scope": "event",
  "key": "string",
  "type": "string",
  "itemType": "string",
  "required": true,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 0,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "sortOrder": 0,
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PATCH/v1/apps/{appId}/group-traits/{propertyId}

Hesap özelliği tanımını güncelle

Anahtar değişmez. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`propertyId`zorunlu	yol	`string`	Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpdateTraitRequest

Alan	Tip	Açıklama
`type`	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	null olabilir
`required`	`boolean`
`description`	`string`	null olabilir
`piiClass`	`string`	Değerler: none, pseudonymous, personal, sensitive
`piiAction`	`string`	Değerler: allow, hash, drop, reject
`enumValues`	`string[]`	null olabilir
`maxLength`	`integer`	null olabilir
`minimum`	`number`	null olabilir
`maximum`	`number`	null olabilir
`example`	`any`
`displayNames`	`LocalizedNames`

Örnek · JSON

{
  "type": "string",
  "itemType": "string",
  "required": true,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 1,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "displayNames": {
    "tr": "string",
    "en": "string"
  }
}

Yanıtlar

200

Başarılı.

application/jsonPropertyDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "scope": "event",
  "key": "string",
  "type": "string",
  "itemType": "string",
  "required": true,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 0,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "sortOrder": 0,
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

DELETE/v1/apps/{appId}/group-traits/{propertyId}

Hesap özelliği tanımını sil

Saklanan değerler kalır; tanımsız özellik uygulamanın şema kipine göre işlenir. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`propertyId`zorunlu	yol	`string`	Biçim: uuid

Yanıtlar

204
Başarılı; yanıt gövdesi yok.
400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/schema

Şema paketi

Uygulamanın bütün olay kataloğu (schemaBundleSchema, formatVersion 1): her durumdaki olay tanımı, özellikleri, kişi ve hesap özellikleri, revision. metrics pull TypeScript tiplerini, alım servisi şema önbelleğini bundan üretir.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonSchemaBundle

Örnek · JSON

{
  "formatVersion": 1,
  "app": {
    "id": "string",
    "slug": "string",
    "name": "string"
  },
  "schemaMode": "strict",
  "revision": 0,
  "generatedAt": "2026-11-06T14:46:00+03:00",
  "events": [
    {
      "name": "string",
      "displayName": "string",
      "roles": [
        "signup"
      ],
      "status": "draft",
      "version": 1,
      "properties": [
        {
          "key": "string",
          "type": "string",
          "required": true,
          "piiClass": "none",
          "piiAction": "allow"
        }
      ]
    }
  ],
  "traits": [
    {
      "key": "string",
      "type": "string",
      "required": true,
      "piiClass": "none",
      "piiAction": "allow"
    }
  ],
  "groupTraits": [
    {
      "key": "string",
      "type": "string",
      "required": true,
      "piiClass": "none",
      "piiAction": "allow"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/traits

Kişi özelliği tanımları

Uygulamanın kişi (identify) özellik tanımları (anahtar, tür, kişisel veri sınıfı ve eylemi, iki dilde ad). Kapsam: management:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonTraitList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scope": "event",
      "key": "string",
      "type": "string",
      "itemType": "string",
      "required": true,
      "description": "string",
      "piiClass": "none",
      "piiAction": "allow",
      "enumValues": [
        "string"
      ],
      "maxLength": 0,
      "minimum": 0,
      "maximum": 0,
      "example": {},
      "sortOrder": 0,
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/traits

Kişi özelliği tanımı ekle

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonPropertyDefinitionInput

Alan	Tip	Açıklama
`key`zorunlu	`string`	Desen: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 karakter
`type`zorunlu	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	null olabilir
`required`	`boolean`	Varsayılan: false
`description`	`string`	null olabilir
`piiClass`	`string`	Değerler: none, pseudonymous, personal, sensitive · Varsayılan: none
`piiAction`	`string`	Değerler: allow, hash, drop, reject · Varsayılan: allow
`enumValues`	`string[]`	null olabilir
`maxLength`	`integer`	null olabilir
`minimum`	`number`	null olabilir
`maximum`	`number`	null olabilir
`example`	`any`
`displayNames`	`LocalizedNames`

Örnek · JSON

{
  "key": "string",
  "type": "string",
  "itemType": "string",
  "required": false,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 1,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "displayNames": {
    "tr": "string",
    "en": "string"
  }
}

Yanıtlar

201

Oluşturuldu.

application/jsonPropertyDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "scope": "event",
  "key": "string",
  "type": "string",
  "itemType": "string",
  "required": true,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 0,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "sortOrder": 0,
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PATCH/v1/apps/{appId}/traits/{propertyId}

Kişi özelliği tanımını güncelle

Anahtar değişmez. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`propertyId`zorunlu	yol	`string`	Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpdateTraitRequest

Alan	Tip	Açıklama
`type`	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	null olabilir
`required`	`boolean`
`description`	`string`	null olabilir
`piiClass`	`string`	Değerler: none, pseudonymous, personal, sensitive
`piiAction`	`string`	Değerler: allow, hash, drop, reject
`enumValues`	`string[]`	null olabilir
`maxLength`	`integer`	null olabilir
`minimum`	`number`	null olabilir
`maximum`	`number`	null olabilir
`example`	`any`
`displayNames`	`LocalizedNames`

Örnek · JSON

{
  "type": "string",
  "itemType": "string",
  "required": true,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 1,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "displayNames": {
    "tr": "string",
    "en": "string"
  }
}

Yanıtlar

200

Başarılı.

application/jsonPropertyDefinitionRecord

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "scope": "event",
  "key": "string",
  "type": "string",
  "itemType": "string",
  "required": true,
  "description": "string",
  "piiClass": "none",
  "piiAction": "allow",
  "enumValues": [
    "string"
  ],
  "maxLength": 0,
  "minimum": 0,
  "maximum": 0,
  "example": {},
  "sortOrder": 0,
  "displayNames": {
    "tr": "string",
    "en": "string"
  },
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

DELETE/v1/apps/{appId}/traits/{propertyId}

Kişi özelliği tanımını sil

Saklanan değerler kalır; tanımsız özellik uygulamanın şema kipine göre işlenir. Kapsam: management:write; panelle aynı kurallar ve denetim kaydı (işlemi yapan anahtar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`propertyId`zorunlu	yol	`string`	Biçim: uuid

Yanıtlar

204
Başarılı; yanıt gövdesi yok.
400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Ölçüm

2 uç

Metrik kataloğu ve sorgu servisi: metrik sorgusu, katalog, Trafik ekranı, tüm uygulamalar, uygulamanın tanımladığı metrikler ve Query API.

POST/v1/query

Query API: metrik sorgusu

Panelin metrik sorgusu entegrasyonlar için: Authorization: Bearer mk_…, kapsam query:read, uygulama gövdede (appId); anahtarın uygulama kapsamı dışındaki uygulama bulunamaz (404). Tarih aralığı uygulamanın saat dilimindeki yerel tarihlerdir (iki uç dahil; günler yaz saati geçişinde 23 ya da 25 saat sürer). Test, iç ve bot trafiği include ile açıkça istenmedikçe dışarıdadır. Oranlar pay ve paydanın toplamından hesaplanır (oranların ortalaması alınmaz); tekil metrikler (ziyaretçi) her satır ve dönem için yeniden sayılır, toplanmaz. Paydası 0 olan oran ve ölçüm başlamadan önceki dönem null döner (0 değil). Karşılaştırma: previous_period eşit uzunlukta önceki dönem (tam takvim ayı → önceki ay, ay başından bugüne → önceki ayın aynı günleri), previous_year aynı tarihler bir yıl önce, custom + compareRange; zaman kovaları sırayla eşlenir. Değişim (deltas): önceki değer 0 ya da metriğin tabanının altındaysa yüzde verilmez (mode: "absolute", reason: "zero_base" | "small_base"), oranlarda puan (mode: "points"), ölçüm öncesi karşılaştırma comparable: false. meta: saat dilimi, veri tazeliği (işleme izleme noktası), her metriğin sayım modu (event_date) ve kaynağı (rollup | raw | none), uyarılar (desteklenmeyen boyut/filtre, kesilen satırlar). Özet tablolar ile ham tablolar aynı sayıyı verir; servis hangisini okuyacağına kendisi karar verir. Dalga 16: her metriğin katalog etiketi isteğin dilinde metrics[].label’da (rollü metrikte rolle: «Dönüşen kişi · Kayıt»; custom: için uygulamanın verdiği ad); definitions (en çok 5) kaydedilmemiş metrik tanımlarını taslak olarak taşır — custom:<anahtar> önce taslağa, sonra kayıtlı tanıma çözülür (önizleme; hiçbir şey saklanmaz, aynı anahtarlı kayıtlı tanımı gölgeler); türler kayıtlı tanımınkiler, artı unique_accounts (olayı yapan farklı hesap). segmentId uygulamanın bir kişi ya da hesap segmentini (…/analytics/segments) adlandırır: kişilerin olguları — oturum, olay, etkileşim, sayfa ayrılışı, kredili dönüşüm — segmentin üyelerine daralır (hesap segmentinde hesapların olayları ve üyelerinin oturumları); reklam, sosyal, Search Console, GA4, bütçe ve ileti metrikleri segment için FILTER_NOT_AVAILABLE der; segmentli sorgu her zaman ham tablolardan okunur, meta.segment segmentin adını taşır.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

İstek gövdesiGövde zorunlu

application/jsonQueryApiRequest

Alan	Tip	Açıklama
`appId`zorunlu	`string`	Biçim: uuid
`metrics`zorunlu	`string[]`	1–20 öğe
`dimensions`	`string[]`	en çok 3 öğe · Varsayılan: []
`filters`	`QueryFilterInput[]`	en çok 20 öğe · Varsayılan: []
`dateRange`zorunlu	`DateRange`
`compare`	`string`	Değerler: none, previous_period, previous_year, custom · Varsayılan: none
`compareRange`	`DateRange`
`include`	`TrafficInclude`
`granularity`	`string`	Değerler: day, week, month
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`orderBy`	`object`
`orderBy.metric`zorunlu	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`orderBy.direction`	`string`	Değerler: asc, desc · Varsayılan: desc
`limit`	`integer`	1–10000 · Varsayılan: 1000
`segmentId`	`string`	Biçim: uuid
`definitions`	`DraftMetricDefinition[]`	en çok 5 öğe

Örnek · JSON

{
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "metrics": [
    "string"
  ],
  "dimensions": [],
  "filters": [],
  "dateRange": {
    "from": "string",
    "to": "string"
  },
  "compare": "none",
  "compareRange": {
    "from": "string",
    "to": "string"
  },
  "include": {
    "test": false,
    "internal": false
  },
  "granularity": "day",
  "attributionModel": "first_touch",
  "orderBy": {
    "metric": "string"
  },
  "limit": 1000,
  "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "definitions": [
    {
      "key": "string",
      "kind": "event_count"
    }
  ]
}

Yanıtlar

200

Başarılı.

application/jsonAnalyticsQueryResult

Örnek · JSON

{
  "metrics": [
    {
      "key": "string",
      "unit": "count",
      "goodDirection": "higher",
      "aggregation": "sum",
      "countingMode": "event_date",
      "source": "rollup"
    }
  ],
  "dimensions": [
    "string"
  ],
  "rows": [
    {
      "dimensions": {},
      "values": {},
      "bucket": {
        "start": "string",
        "end": "string",
        "days": 0,
        "complete": true,
        "beforeTracking": true
      },
      "previous": {},
      "previousBucket": {
        "start": "string",
        "end": "string"
      },
      "deltas": {}
    }
  ],
  "totals": {
    "values": {},
    "deltas": {}
  },
  "comparison": {
    "dateRange": {
      "from": "string",
      "to": "string"
    },
    "comparable": true,
    "totals": {}
  },
  "meta": {
    "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "timezone": "string",
    "currency": "string",
    "dateRange": {
      "from": "string",
      "to": "string"
    },
    "compare": "none",
    "comparisonRange": {
      "from": "string",
      "to": "string"
    },
    "include": {
      "test": true,
      "internal": true,
      "bot": true
    },
    "trackingStartedOn": "string",
    "freshness": {
      "processedUntil": "2026-11-06T14:46:00+03:00",
      "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
      "upToDate": true,
      "updatedAt": "2026-11-06T14:46:00+03:00",
      "pendingRollupDays": 0
    },
    "countingModes": {},
    "sources": {},
    "conversionRoles": [
      "signup"
    ],
    "attribution": {
      "model": "first_touch",
      "windowDays": 0
    },
    "warnings": [
      {
        "code": "DIMENSION_NOT_AVAILABLE",
        "message": "string",
        "metric": "string",
        "dimension": "string"
      }
    ],
    "truncated": true,
    "generatedAt": "2026-11-06T14:46:00+03:00"
  }
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/query/catalogue

Query API: metrik kataloğu

Uygulamanın metrik ve boyut kataloğu (Accept-Language dilinde etiketlerle). Kapsam query:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	sorgu	`string`	Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonAnalyticsCatalogue

Örnek · JSON

{
  "metrics": [
    {
      "key": "string",
      "label": "string",
      "description": "string",
      "unit": "count",
      "goodDirection": "higher",
      "aggregation": "sum",
      "countingMode": "event_date",
      "formula": {
        "numerator": "string",
        "denominator": "string",
        "scale": 0
      },
      "tables": [
        "string"
      ],
      "dimensions": [
        "string"
      ],
      "parameter": {
        "name": "role",
        "values": []
      },
      "custom": true,
      "definitionId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    }
  ],
  "dimensions": [
    {
      "key": "string",
      "label": "string",
      "description": "string",
      "kind": "time",
      "values": [
        {
          "key": "string",
          "label": "string"
        }
      ]
    }
  ],
  "roles": [
    {
      "key": "string",
      "label": "string"
    }
  ],
  "conversionRoles": [
    "signup"
  ],
  "compareModes": [
    "none"
  ],
  "filterOperators": [
    "eq"
  ],
  "attributionModels": [
    {
      "key": "first_touch",
      "label": "string",
      "description": "string"
    }
  ],
  "defaultAttributionModel": "first_touch",
  "attributionWindowDays": 0,
  "revenueBasis": "gross",
  "pricesIncludeTax": true
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Davranış

7 uç

Oturumlar ve zaman çizelgesi, ısı haritası, takılma sinyalleri ve hızlı geri dönüş, JS hataları, ziyaretçi yolları ve sayfadan sayfaya geçişler, kişi ve hesap profilleri.

GET/v1/apps/{appId}/accounts

Hesaplar

Uygulamanın hesapları (group çağrıları ve context.groupId; B2B müşteri hesabı), son görülme, ilk görülme ya da üye sayısı sırasıyla, imleç sayfalı, toplamla. search hesap kimliğinin başı ya da name özelliğinin bir parçası. Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`search`	sorgu	`string`	1–200 karakter
`sort`	sorgu	`string`	Değerler: last_seen, first_seen, members · Varsayılan: last_seen

Yanıtlar

200

Başarılı.

application/jsonAccountPage

Örnek · JSON

{
  "items": [
    {
      "groupId": "string",
      "name": "string",
      "traits": {},
      "memberCount": 0,
      "firstSeenAt": "2026-11-06T14:46:00+03:00",
      "lastSeenAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/accounts/{groupId}

Hesap profili

Hesabın özellikleri (olay zamanına göre en yeni değer; kişisel veri tanımlı olanlar özetlenir ya da gösterilmez), ilk ve son görülme (olay zamanı), üyeleri (en son görülen 20), üyelerin son oturumları, olayları, dönüşümleri, ulaşılan roller, summary (üye, oturum, olay, dönüşüm, brüt gelir, iade, net gelir; metrik kataloğunun kurallarıyla, bütün geçmiş), talepler (leads.read ile). Bir olay hesabındır: kendi groupIdsi, yoksa kişisinin tek hesabıysa (hunilerin group kuralı). Hesap kimliği uygulamanın opak kimliğidir (adreste URL kodlu). Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`groupId`zorunlu	yol	`string`	Sayfa grubunun kimliği (sayfa grubu uçları) ya da hesabın kimliği (`groupId`, hesap uçları). Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonAccountProfile

Örnek · JSON

{
  "account": {
    "groupId": "string",
    "name": "string",
    "traits": {},
    "memberCount": 0,
    "firstSeenAt": "2026-11-06T14:46:00+03:00",
    "lastSeenAt": "2026-11-06T14:46:00+03:00"
  },
  "summary": {
    "members": 0,
    "sessions": 0,
    "events": 0,
    "conversions": 0,
    "revenue": 0,
    "refunds": 0,
    "netRevenue": 0,
    "currency": "string",
    "leads": 0
  },
  "roles": [
    "string"
  ],
  "members": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "userId": "string",
      "firstSeenAt": "2026-11-06T14:46:00+03:00",
      "lastSeenAt": "2026-11-06T14:46:00+03:00",
      "firstChannel": "string",
      "eventCount": 0,
      "sessionCount": 0,
      "isTest": true,
      "isInternal": true,
      "joinedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "sessions": [
    {
      "id": "string",
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "anonymousId": "string",
      "userId": "string",
      "startedAt": "2026-11-06T14:46:00+03:00",
      "endedAt": "2026-11-06T14:46:00+03:00",
      "durationMs": 0,
      "activeMs": 0,
      "pageviews": 0,
      "screenViews": 0,
      "events": 0,
      "interactions": 0,
      "rageClicks": 0,
      "deadClicks": 0,
      "errors": 0,
      "entryPath": "string",
      "exitPath": "string",
      "channel": "string",
      "source": "string",
      "medium": "string",
      "campaign": "string",
      "referrerHost": "string",
      "deviceType": "string",
      "os": "string",
      "browser": "string",
      "country": "string",
      "region": "string",
      "city": "string",
      "isEngaged": true,
      "isBounce": true,
      "roles": [
        "string"
      ],
      "converted": true,
      "revenue": 0,
      "isTest": true,
      "isInternal": true,
      "isBot": true
    }
  ],
  "events": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "at": "2026-11-06T14:46:00+03:00",
      "type": "track",
      "eventName": "string",
      "roles": [
        "string"
      ],
      "conversion": true,
      "revenue": 0,
      "path": "string",
      "sessionId": "string",
      "properties": {},
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    }
  ],
  "conversions": [
    {
      "eventId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "at": "2026-11-06T14:46:00+03:00",
      "eventName": "string",
      "roles": [
        "string"
      ],
      "revenue": 0,
      "sessionId": "string",
      "channel": "string"
    }
  ],
  "leads": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "kind": "demo_request",
      "status": "new",
      "eventName": "string",
      "eventAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "withheldTraits": [
    "string"
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/accounts/{groupId}/events

Hesabın olay zaman çizelgesi

Hesabın bütün olayları (kişisiyle), yeniden eskiye, imleç sayfalı; type, conversions=true süzgeçleri. Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`groupId`zorunlu	yol	`string`	Sayfa grubunun kimliği (sayfa grubu uçları) ya da hesabın kimliği (`groupId`, hesap uçları). Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`type`	sorgu	`string`	Değerler: track, identify, page, screen, group, alias
`conversions`	sorgu	`string`	Değerler: true, false

Yanıtlar

200

Başarılı.

application/jsonAccountEventPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "at": "2026-11-06T14:46:00+03:00",
      "type": "track",
      "eventName": "string",
      "roles": [
        "string"
      ],
      "conversion": true,
      "revenue": 0,
      "path": "string",
      "sessionId": "string",
      "properties": {},
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/accounts/{groupId}/members

Hesabın üyeleri

Hesabın bütün kişileri, son görülme sırasıyla, imleç sayfalı, toplamla; joinedAt kişinin hesapta ilk görüldüğü olay zamanı. Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`groupId`zorunlu	yol	`string`	Sayfa grubunun kimliği (sayfa grubu uçları) ya da hesabın kimliği (`groupId`, hesap uçları). Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50

Yanıtlar

200

Başarılı.

application/jsonAccountMemberPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "userId": "string",
      "firstSeenAt": "2026-11-06T14:46:00+03:00",
      "lastSeenAt": "2026-11-06T14:46:00+03:00",
      "firstChannel": "string",
      "eventCount": 0,
      "sessionCount": 0,
      "isTest": true,
      "isInternal": true,
      "joinedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/persons

Kişiler

Uygulamanın kişileri (birleştirilmiş kişiler hariç), son görülme ya da ilk görülme sırasıyla, imleç sayfalı. search bir kullanıcı kimliği, anonim kimlik ya da kişi kimliğiyle tam eşleşir; searchMatch=prefix ile kişi kimliğinin başıyla da (en az 6 onaltılık karakter, tireler yok sayılır; birincil anahtarda kimlik aralığı) ve 16. dalgadan kullanıcı ya da anonim kimliğin başıyla (en az 3 karakter, büyük/küçük harf duyarlı, % ve _ harf olarak; desen dizini). Kimlikler opaktır; kişisel veri dönmez. Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`search`	sorgu	`string`	1–200 karakter
`searchMatch`	sorgu	`string`	Değerler: exact, prefix · Varsayılan: exact
`sort`	sorgu	`string`	Değerler: last_seen, first_seen · Varsayılan: last_seen
`includeTest`	sorgu	`string`	Değerler: true, false
`includeInternal`	sorgu	`string`	Değerler: true, false
`includeBot`	sorgu	`string`	Değerler: true, false

Yanıtlar

200

Başarılı.

application/jsonPersonPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "userId": "string",
      "firstSeenAt": "2026-11-06T14:46:00+03:00",
      "lastSeenAt": "2026-11-06T14:46:00+03:00",
      "firstChannel": "string",
      "eventCount": 0,
      "sessionCount": 0,
      "isTest": true,
      "isInternal": true
    }
  ],
  "nextCursor": "string",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/persons/{personId}

Kişi profili

Kimlikler (anonim ve kullanıcı kimliği; kişisel veri değil; ilk görülme olay zamanına göre), özellikler (olay zamanına göre en yeni değer; kişisel veri tanımlı özellik özetlenir — hash — ya da gösterilmez — drop, reject: adı withheldTraitste), ilk ve son görülme olay zamanına göre, ilk ve son doğrudan olmayan temas, hesaplar, ulaşılan roller, birleşme geçmişi (merges), son oturumlar ve olaylar, dönüşümler, summary (oturum, olay, dönüşüm, brüt gelir, iade, net gelir — metrik kataloğunun kurallarıyla, bütün geçmiş, olay tarihine göre), talepler (yalnız leads.read ile; yoksa null). Birleştirilmiş bir kişi istenirse yaşayan kişi döner (requestedId isteneni söyler); birleşen kişilerin olayları arka planda yeniden yazılmadan önce de profildedir. Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`personId`zorunlu	yol	`string`	Kişinin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonPersonProfile

Örnek · JSON

{
  "requestedId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "person": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "userId": "string",
    "traits": {},
    "firstSeenAt": "2026-11-06T14:46:00+03:00",
    "lastSeenAt": "2026-11-06T14:46:00+03:00",
    "firstChannel": "string",
    "firstTouch": {},
    "lastNonDirectTouch": {},
    "eventCount": 0,
    "sessionCount": 0,
    "isTest": true,
    "isInternal": true,
    "mergedFrom": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ]
  },
  "identities": [
    {
      "kind": "anonymous_id",
      "value": "string",
      "firstSeenAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "groups": [
    {
      "groupId": "string",
      "traits": {},
      "memberCount": 0,
      "firstSeenAt": "2026-11-06T14:46:00+03:00",
      "lastSeenAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "roles": [
    "string"
  ],
  "sessions": [
    {
      "id": "string",
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "anonymousId": "string",
      "userId": "string",
      "startedAt": "2026-11-06T14:46:00+03:00",
      "endedAt": "2026-11-06T14:46:00+03:00",
      "durationMs": 0,
      "activeMs": 0,
      "pageviews": 0,
      "screenViews": 0,
      "events": 0,
      "interactions": 0,
      "rageClicks": 0,
      "deadClicks": 0,
      "errors": 0,
      "entryPath": "string",
      "exitPath": "string",
      "channel": "string",
      "source": "string",
      "medium": "string",
      "campaign": "string",
      "referrerHost": "string",
      "deviceType": "string",
      "os": "string",
      "browser": "string",
      "country": "string",
      "region": "string",
      "city": "string",
      "isEngaged": true,
      "isBounce": true,
      "roles": [
        "string"
      ],
      "converted": true,
      "revenue": 0,
      "isTest": true,
      "isInternal": true,
      "isBot": true
    }
  ],
  "events": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "at": "2026-11-06T14:46:00+03:00",
      "type": "track",
      "eventName": "string",
      "roles": [
        "string"
      ],
      "conversion": true,
      "revenue": 0,
      "path": "string",
      "sessionId": "string",
      "properties": {}
    }
  ],
  "summary": {
    "sessions": 0,
    "events": 0,
    "conversions": 0,
    "revenue": 0,
    "refunds": 0,
    "netRevenue": 0,
    "currency": "string",
    "leads": 0
  },
  "conversions": [
    {
      "eventId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "at": "2026-11-06T14:46:00+03:00",
      "eventName": "string",
      "roles": [
        "string"
      ],
      "revenue": 0,
      "sessionId": "string",
      "channel": "string"
    }
  ],
  "leads": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "kind": "demo_request",
      "status": "new",
      "eventName": "string",
      "eventAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "merges": [
    {
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "reason": "identify",
      "mergedAt": "2026-11-06T14:46:00+03:00",
      "rewritten": true
    }
  ],
  "withheldTraits": [
    "string"
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/persons/{personId}/events

Kişinin olay zaman çizelgesi

Kişinin (ve ona birleşen kişilerin) bütün olayları, yeniden eskiye, imleç sayfalı; type mesaj türü, conversions=true yalnız dönüşüm rolündeki olaylar. Management API (dalga 16; 07 YEN-13): kapsam persons:read; panelle aynı saklama kuralları — kişisel ya da hassas veri tanımlı ya da eylemi allow olmayan özellik özetiyle döner (hash) ya da hiç dönmez (drop, reject: yalnız adı withheldTraitste), kimlikler opak; profildeki talepler yalnız anahtarda leads:read de varsa.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: persons:read.

Kimlik: apiKey
Gerekli kapsam: persons:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`personId`zorunlu	yol	`string`	Kişinin kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`type`	sorgu	`string`	Değerler: track, identify, page, screen, group, alias
`conversions`	sorgu	`string`	Değerler: true, false

Yanıtlar

200

Başarılı.

application/jsonPersonEventPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "at": "2026-11-06T14:46:00+03:00",
      "type": "track",
      "eventName": "string",
      "roles": [
        "string"
      ],
      "conversion": true,
      "revenue": 0,
      "path": "string",
      "sessionId": "string",
      "properties": {}
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Veri hakları

4 uç

Kişisel veri silme talepleri (KVKK): kullanıcı kimliği, anonim kimlik ya da kişi kimliğiyle bir kişinin uygulamadaki bütün verisi silinir, talep kaydı ve silinenler kalır.

GET/v1/apps/{appId}/privacy/deletion-requests

Silme talepleri

Uygulamanın talepleri, yeniden eskiye, imleç sayfalı, toplamla; status süzgeci; kapsam management:read. result silinen satırları türüne göre sayar (sürerken o ana kadar).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	Yalnız bu durumdaki talepler. Değerler: pending, running, completed, failed, cancelled

Yanıtlar

200

Başarılı.

application/jsonDeletionRequestPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "subjectKind": "user_id",
      "subjectHint": "string",
      "status": "pending",
      "note": "string",
      "requestedVia": "panel",
      "requestedBy": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "name": "string"
      },
      "result": {},
      "errorCode": "string",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "startedAt": "2026-11-06T14:46:00+03:00",
      "completedAt": "2026-11-06T14:46:00+03:00",
      "nothingFound": true
    }
  ],
  "nextCursor": "string",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/privacy/deletion-requests

Silme talebi oluştur

Ürünün sunucusu, kullanıcısı unutulmak istediğinde (KVKK) talebi açar; kapsam management:write. Worker talebi dakikalar içinde yürütür: kişi ve ona birleşmiş bütün kişiler, kimlikleri, olayları (ve atıf satırları, webhook kopyaları), etkileşimleri, oturumları, hesap üyelikleri, talepleri, kilometre taşları ve aynı kullanıcı kimliğiyle bağlı Mailing & SMS kişisi (izin kanıtı yasa gereği kör dizinle kalır) silinir; özet tablolar kalan veriden yeniden hesaplanır. Talep başladıktan sonra alınan veri talebe girmez. Kimliğin değeri yalnız talep bitene kadar tutulur; listede son karakterleri (subjectHint) görünür. E-posta ya da telefon gibi görünen kimlik alımdaki gibi özetlenerek aranır. Açık talebi olan kimliğe yeni talep aynı talebi döndürür.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonCreateDeletionRequest

Alan	Tip	Açıklama
`subjectKind`zorunlu	`string`	Kimliğin türü: ürünün kullanıcı kimliği (`user_id`), SDK'nın anonim kimliği (`anonymous_id`) ya da Postlip Metrics'in kişi kimliği (`person_id`). Değerler: user_id, anonymous_id, person_id
`subjectValue`zorunlu	`string`	Kimliğin değeri (en çok 200 karakter). E-posta ya da telefon gibi görünen kimlik alımdaki gibi özetlenerek aranır; değer talep bitene kadar tutulur. 1–200 karakter
`note`	`string`	Neden (talep numarası, başvurunun kanalı); kişisel veri yazmayın. En çok 500 karakter. null olabilir

Örnek · JSON

{
  "subjectKind": "user_id",
  "subjectValue": "string",
  "note": "string"
}

Yanıtlar

201

Oluşturuldu.

application/jsonDeletionRequest

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "subjectKind": "user_id",
  "subjectHint": "string",
  "status": "pending",
  "note": "string",
  "requestedVia": "panel",
  "requestedBy": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string"
  },
  "result": {},
  "errorCode": "string",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "startedAt": "2026-11-06T14:46:00+03:00",
  "completedAt": "2026-11-06T14:46:00+03:00",
  "nothingFound": true
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/privacy/deletion-requests/{requestId}

Silme talebi

Talebin durumu ve silinenler; kapsam management:read. nothingFound: talep tamamlandı ama kimliğe ait veri yoktu.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`requestId`zorunlu	yol	`string`	Silme talebinin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonDeletionRequest

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "subjectKind": "user_id",
  "subjectHint": "string",
  "status": "pending",
  "note": "string",
  "requestedVia": "panel",
  "requestedBy": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string"
  },
  "result": {},
  "errorCode": "string",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "startedAt": "2026-11-06T14:46:00+03:00",
  "completedAt": "2026-11-06T14:46:00+03:00",
  "nothingFound": true
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/privacy/deletion-requests/{requestId}/cancel

Silme talebini iptal et

Yalnız bekleyen talep (409 DELETION_REQUEST_NOT_CANCELLABLE); kimliğin değeri silinir; kapsam management:write. Denetim kaydına anahtarın adıyla yazılır.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:write.

Kimlik: apiKey
Gerekli kapsam: management:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`requestId`zorunlu	yol	`string`	Silme talebinin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonDeletionRequest

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "subjectKind": "user_id",
  "subjectHint": "string",
  "status": "pending",
  "note": "string",
  "requestedVia": "panel",
  "requestedBy": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string"
  },
  "result": {},
  "errorCode": "string",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "startedAt": "2026-11-06T14:46:00+03:00",
  "completedAt": "2026-11-06T14:46:00+03:00",
  "nothingFound": true
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Dönüşüm

4 uç

Huniler (tanım, sonuç, dönüşüm süresi, kırılım, adımın kişileri) ve atıf servisinin modelleri.

GET/v1/apps/{appId}/funnels

Management API: huniler

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonFunnelList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "description": "string",
      "steps": [
        {
          "event": "string",
          "role": "signup",
          "filters": [],
          "label": "string"
        }
      ],
      "order": "ordered",
      "countBy": "person",
      "conversionWindow": {
        "value": 0,
        "unit": "minutes"
      },
      "countingMode": "event_date",
      "isDefault": true,
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/funnels/{funnelId}

Management API: huni tanımı

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: management:read.

Kimlik: apiKey
Gerekli kapsam: management:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`funnelId`zorunlu	yol	`string`	Huninin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonFunnel

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "description": "string",
  "steps": [
    {
      "event": "string",
      "role": "signup",
      "filters": [
        {
          "property": "string",
          "op": "eq",
          "value": "string"
        }
      ],
      "label": "string"
    }
  ],
  "order": "ordered",
  "countBy": "person",
  "conversionWindow": {
    "value": 0,
    "unit": "minutes"
  },
  "countingMode": "event_date",
  "isDefault": true,
  "sideMetrics": [
    {
      "event": "string",
      "role": "signup",
      "filters": [
        {
          "property": "string",
          "op": "eq",
          "value": "string"
        }
      ],
      "label": "string",
      "without": {
        "event": "string",
        "role": "signup",
        "filters": [],
        "withinDays": 0
      }
    }
  ],
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/funnels/{funnelId}/results

Management API: huni sonucu

Panelin huni sonucu entegrasyonlar için (tazelik ve isteğe bağlı karşılaştırmayla); kapsam query:read. Adım: bir olay adı (event) ya da iş rolü (role) ve olay özelliği filtreleri (eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty; sayısal gt, gte, lt, lte). Giriş: öznenin dönem içindeki ilk 1. adım olayı (uygulamanın yerel günleri). ordered: k. adım, (k−1). adımdan sonraki ilk k. adım olayıdır (zaman, sonra kimlik); any_order: girişten sonraki ilk k. adım olayıdır, diğerlerinin sırası aranmaz — yanıtta adım başına "ulaşan" verilir, kayıp verilmez (negatif kayıp çıkmaz). Pencere (conversionWindow) girişten itibaren sayılır; yoksa sınır yok. Sayım birimi: person (birleşmiş kimlikler tek kişi), session, group (olayın hesabı, yoksa kişinin tek hesabı). Sayım modu yanıtta açıkça yazar: cohort dönemde giren özneleri bugüne (ya da pencerenin sonuna) kadar izler (followedUntil); event_date bütün adımların dönem içinde olmasını ister. Test, iç ve bot trafiği istenmedikçe dışarıdadır. Dönüşüm süresi: adım başına önceki adımdan (yalnız ordered) ve girişten saniye olarak ortalama, medyan, p75, p90 ve dağılım (1 dk, 5 dk, 15 dk, 1 sa, 6 sa, 1 g, 3 g, 7 g, 14 g, 30 g, üstü). $pageview / $screen adımında path süzgeci olayın sayfa yolunu (page_path) okur (metin kuralları; sayısal işleçler eşleşmez). Yan göstergeler (sideMetrics, en çok 5): girenlerden girişte ya da sonrasında (pencere içinde; event_date'te dönem içinde) göstergenin olayı olan özne sayısı ve girenlere oranı; without ile yalnız ilk bu olaydan sonra withinDays gün içinde without olayı olmayanlar — süresi dolmamışlar pending.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`funnelId`zorunlu	yol	`string`	Huninin kimliği. Biçim: uuid
`from`zorunlu	sorgu	`string`
`to`zorunlu	sorgu	`string`
`countingMode`	sorgu	`string`	Değerler: event_date, cohort
`breakdown`	sorgu	`string`
`attributionModel`	sorgu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`includeTest`	sorgu	`string`	Değerler: true, false
`includeInternal`	sorgu	`string`	Değerler: true, false
`includeBot`	sorgu	`string`	Değerler: true, false
`compare`	sorgu	`string`	Değerler: none, previous_period, previous_year · Varsayılan: none
`alignment`	sorgu	`string`	Değerler: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year
`series`	sorgu	`string`	Değerler: day, week, month
`seriesBasis`	sorgu	`string`	Değerler: step_date, entry_date · Varsayılan: step_date

Yanıtlar

200

Başarılı.

application/jsonFunnelScreenResult

Örnek · JSON

{
  "funnel": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string",
    "order": "ordered",
    "countBy": "person",
    "conversionWindow": {
      "value": 0,
      "unit": "minutes"
    }
  },
  "countingMode": "event_date",
  "dateRange": {
    "from": "string",
    "to": "string"
  },
  "timezone": "string",
  "followedUntil": "2026-11-06T14:46:00+03:00",
  "include": {
    "test": true,
    "internal": true,
    "bot": true
  },
  "steps": [
    {
      "index": 0,
      "label": "string",
      "event": "string",
      "role": "signup",
      "count": 0,
      "ofFirst": 0,
      "ofPrevious": 0,
      "dropOff": 0,
      "timeFromPrevious": {
        "count": 0,
        "averageSeconds": 0,
        "medianSeconds": 0,
        "p75Seconds": 0,
        "p90Seconds": 0,
        "histogram": []
      },
      "timeFromFirst": {
        "count": 0,
        "averageSeconds": 0,
        "medianSeconds": 0,
        "p75Seconds": 0,
        "p90Seconds": 0,
        "histogram": []
      }
    }
  ],
  "breakdown": {
    "dimension": "channel",
    "attributionModel": "first_touch",
    "rows": [
      {
        "value": "string",
        "steps": []
      }
    ],
    "others": [
      0
    ]
  },
  "extraBreakdown": {
    "dimension": "channel",
    "attributionModel": null,
    "rows": [
      {
        "value": "string",
        "steps": []
      }
    ],
    "others": [
      0
    ]
  },
  "warnings": [
    {
      "code": "ATTRIBUTION_NOT_CONVERSION",
      "message": "string"
    }
  ],
  "series": {
    "granularity": "day",
    "basis": "step_date",
    "points": [
      {
        "date": "string",
        "start": "string",
        "end": "string",
        "steps": []
      }
    ],
    "afterRange": [
      0
    ]
  },
  "sideMetrics": [
    {
      "index": 0,
      "label": "string",
      "event": "string",
      "role": "signup",
      "count": 0,
      "ofEntered": 0,
      "pending": 0,
      "withinDays": 0
    }
  ],
  "generatedAt": "2026-11-06T14:46:00+03:00",
  "freshness": {
    "processedUntil": "2026-11-06T14:46:00+03:00",
    "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
    "upToDate": true,
    "updatedAt": "2026-11-06T14:46:00+03:00",
    "pendingRollupDays": 0
  },
  "comparison": {
    "dateRange": {
      "from": "string",
      "to": "string"
    },
    "comparable": true,
    "steps": [
      {
        "index": 0,
        "count": 0,
        "ofFirst": 0,
        "ofPrevious": 0
      }
    ]
  }
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/funnels/{funnelId}/results/cohorts

Management API: huni kohort ısı haritası

Panelin kohort ısı haritası entegrasyonlar için; kapsam query:read. Haftalık giriş kohortları, girişten sonraki haftalara göre birikimli ulaşma, düşük örnek işareti.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`funnelId`zorunlu	yol	`string`	Huninin kimliği. Biçim: uuid
`from`zorunlu	sorgu	`string`
`to`zorunlu	sorgu	`string`
`step`	sorgu	`integer`	2–10
`weeks`	sorgu	`integer`	1–26 · Varsayılan: 8
`includeTest`	sorgu	`string`	Değerler: true, false
`includeInternal`	sorgu	`string`	Değerler: true, false
`includeBot`	sorgu	`string`	Değerler: true, false

Yanıtlar

200

Başarılı.

application/jsonFunnelCohorts

Örnek · JSON

{
  "funnel": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string",
    "countBy": "person"
  },
  "basis": "entry_week",
  "countingMode": "cohort",
  "dateRange": {
    "from": "string",
    "to": "string"
  },
  "timezone": "string",
  "followedUntil": "2026-11-06T14:46:00+03:00",
  "step": 0,
  "weeks": 0,
  "minSubjects": 0,
  "include": {
    "test": true,
    "internal": true,
    "bot": true
  },
  "cohorts": [
    {
      "week": "string",
      "start": "string",
      "end": "string",
      "entered": 0,
      "lowSample": true,
      "cells": [
        {
          "week": 0,
          "reached": 0,
          "rate": 0,
          "complete": true
        }
      ]
    }
  ],
  "total": [
    {
      "week": 0,
      "entered": 0,
      "reached": 0,
      "rate": 0
    }
  ],
  "freshness": {
    "processedUntil": "2026-11-06T14:46:00+03:00",
    "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
    "upToDate": true,
    "updatedAt": "2026-11-06T14:46:00+03:00",
    "pendingRollupDays": 0
  },
  "generatedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Talepler

2 uç

Talep kutusu: durum, sorumlu, notlar, kaynak ve atıf anlık görüntüsü; kişisel veri yok.

GET/v1/apps/{appId}/leads

Management API: talepler

Ürünün kendi arka ofisi için talep kutusu; kapsam leads:read. Talep kişisel veri taşımaz: ad, telefon ve e-posta saklanmaz; olayın yalnız kişisel olmayan özellikleri (tanımı pii_class: none ya da tanımsız, anahtarı iletişim alanı olmayan) tutulur, kişi opak kimlikleriyle bağlanır.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: leads:read.

Kimlik: apiKey
Gerekli kapsam: leads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`status`	sorgu	`string`	en çok 500 karakter
`stage`	sorgu	`string \| string[]`
`kind`	sorgu	`string`	en çok 500 karakter
`assignee`	sorgu	`string`
`channel`	sorgu	`string \| string[]`
`campaign`	sorgu	`string \| string[]`
`overdue`	sorgu	`string`	Değerler: true, false
`cta`	sorgu	`string \| string[]`
`source`	sorgu	`string \| string[]`
`medium`	sorgu	`string \| string[]`
`deviceType`	sorgu	`string`	1–50 karakter
`country`	sorgu	`string`	2–2 karakter
`from`	sorgu	`string`
`to`	sorgu	`string`
`includeTest`	sorgu	`string`	Değerler: true, false
`includeInternal`	sorgu	`string`	Değerler: true, false

Yanıtlar

200

Başarılı.

application/jsonLeadPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "kind": "demo_request",
      "status": "new",
      "statusReason": "string",
      "assignee": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "name": "string"
      },
      "eventId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "eventName": "string",
      "occurredAt": "2026-11-06T14:46:00+03:00",
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "userId": "string",
      "groupId": "string",
      "source": {
        "sessionId": "string",
        "channel": "string",
        "source": "string",
        "medium": "string",
        "campaign": "string",
        "referrerHost": "string",
        "entryPath": "string",
        "pagePath": "string",
        "deviceType": "string",
        "country": "string"
      },
      "attribution": {
        "model": "first_touch",
        "windowDays": 0,
        "firstTouch": {
          "sessionId": "string",
          "at": "string",
          "channel": "string",
          "source": "string",
          "medium": "string",
          "campaign": "string",
          "resolution": "click_id",
          "weight": 0
        },
        "lastTouch": {
          "sessionId": "string",
          "at": "string",
          "channel": "string",
          "source": "string",
          "medium": "string",
          "campaign": "string",
          "resolution": "click_id",
          "weight": 0
        },
        "lastNonDirect": {
          "sessionId": "string",
          "at": "string",
          "channel": "string",
          "source": "string",
          "medium": "string",
          "campaign": "string",
          "resolution": "click_id",
          "weight": 0
        }
      },
      "properties": {},
      "isTest": true,
      "isInternal": true,
      "noteCount": 0,
      "statusChangedAt": "2026-11-06T14:46:00+03:00",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string",
  "total": 0,
  "counts": {},
  "stageCounts": {},
  "overdue": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/leads/{leadId}

Management API: talep

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: leads:read.

Kimlik: apiKey
Gerekli kapsam: leads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`leadId`zorunlu	yol	`string`	Talebin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonLeadDetail

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "kind": "demo_request",
  "status": "new",
  "stage": "string",
  "dueAt": "2026-11-06T14:46:00+03:00",
  "overdue": true,
  "statusReason": "string",
  "assignee": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string"
  },
  "eventId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "eventName": "string",
  "occurredAt": "2026-11-06T14:46:00+03:00",
  "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "userId": "string",
  "groupId": "string",
  "source": {
    "sessionId": "string",
    "channel": "string",
    "source": "string",
    "medium": "string",
    "campaign": "string",
    "referrerHost": "string",
    "entryPath": "string",
    "pagePath": "string",
    "deviceType": "string",
    "country": "string"
  },
  "attribution": {
    "model": "first_touch",
    "windowDays": 0,
    "firstTouch": {
      "sessionId": "string",
      "at": "string",
      "channel": "string",
      "source": "string",
      "medium": "string",
      "campaign": "string",
      "resolution": "click_id",
      "weight": 0
    },
    "lastTouch": {
      "sessionId": "string",
      "at": "string",
      "channel": "string",
      "source": "string",
      "medium": "string",
      "campaign": "string",
      "resolution": "click_id",
      "weight": 0
    },
    "lastNonDirect": {
      "sessionId": "string",
      "at": "string",
      "channel": "string",
      "source": "string",
      "medium": "string",
      "campaign": "string",
      "resolution": "click_id",
      "weight": 0
    }
  },
  "lastClick": {
    "at": "2026-11-06T14:46:00+03:00",
    "path": "string",
    "selector": "string",
    "label": "string",
    "kind": "string",
    "section": "string",
    "contact": "phone"
  },
  "properties": {},
  "isTest": true,
  "isInternal": true,
  "noteCount": 0,
  "statusChangedAt": "2026-11-06T14:46:00+03:00",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "notes": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "body": "string",
      "author": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "name": "string"
      },
      "createdAt": "2026-11-06T14:46:00+03:00",
      "editedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "statusHistory": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "from": "new",
      "to": "new",
      "reason": "string",
      "changedBy": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "name": "string"
      },
      "changedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Bağlantılar

1 uç

Reklam ve analytics platformlarına bağlantılar (OAuth 2.0 + PKCE, API anahtarı, CSV), hesap seçimi, senkron, çalışma günlüğü, sağlık.

GET/v1/apps/{appId}/connections

Management API: bağlantılar

Uygulamanın bağlantıları ve sağlıkları; kapsam ads:read. Erişim belirteçleri ve API anahtarları sır kutusunda (AES-GCM) saklanır, hiçbir yanıtta dönmez.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: ads:read.

Kimlik: apiKey
Gerekli kapsam: ads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonConnectionList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "provider": "google_ads",
      "kind": "ads",
      "authType": "oauth2",
      "mode": "live",
      "label": "string",
      "scopes": [
        "string"
      ],
      "syncIntervalMinutes": 0,
      "lookbackDays": 0,
      "backfillDays": 0,
      "health": {
        "status": "active",
        "lastSuccessAt": "2026-11-06T14:46:00+03:00",
        "lastRunAt": "2026-11-06T14:46:00+03:00",
        "lastRunStatus": "running",
        "lastError": {
          "code": "auth_failed",
          "message": "string"
        },
        "consecutiveFailures": 0,
        "nextRunAt": "2026-11-06T14:46:00+03:00",
        "syncedUntil": "string",
        "tokenExpiresAt": "2026-11-06T14:46:00+03:00"
      },
      "accounts": [
        {
          "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
          "kind": "ad_account",
          "externalId": "string",
          "name": "string",
          "currency": "string",
          "timezone": "string",
          "platformStatus": "string",
          "selected": true
        }
      ],
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Reklam

4 uç

Reklam özeti, kampanyalar ve reklamlar, raporlar, kırılımlar, bütçe planı ve tempo, kampanya planları.

GET/v1/apps/{appId}/ads/accounts

Management API: reklam hesapları

Kapsam ads:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: ads:read.

Kimlik: apiKey
Gerekli kapsam: ads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonAdAccountList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "platform": "string",
      "externalId": "string",
      "name": "string",
      "currency": "string",
      "timezone": "string",
      "status": "active",
      "connectionId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "lastSyncedAt": "2026-11-06T14:46:00+03:00",
      "link": "string"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/ads/budget

Management API: bütçe ve tempo

Kapsam ads:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: ads:read.

Kimlik: apiKey
Gerekli kapsam: ads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`month`	sorgu	`string`	Desen: `^\d{4}-(0[1-9]\|1[0-2])$` · 7–7 karakter

Yanıtlar

200

Başarılı.

application/jsonAdsBudget

Örnek · JSON

{
  "month": "string",
  "currency": "string",
  "daysInMonth": 0,
  "daysElapsed": 0,
  "tolerance": 0,
  "total": {
    "platform": "string",
    "adAccountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "budget": 0,
    "spent": 0,
    "remaining": 0,
    "used": 0,
    "expectedToDate": 0,
    "dailyAverage": 0,
    "requiredDaily": 0,
    "forecast": 0,
    "forecastRatio": 0,
    "activeDailyBudgets": 0,
    "state": "on_track"
  },
  "lines": [
    {
      "platform": "string",
      "adAccountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "budget": 0,
      "spent": 0,
      "remaining": 0,
      "used": 0,
      "expectedToDate": 0,
      "dailyAverage": 0,
      "requiredDaily": 0,
      "forecast": 0,
      "forecastRatio": 0,
      "activeDailyBudgets": 0,
      "state": "on_track"
    }
  ],
  "plans": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "month": "string",
      "platform": "string",
      "adAccountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "amount": 0,
      "currency": "string",
      "note": "string",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "supersededAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "cumulative": [
    {
      "day": "string",
      "spend": 0,
      "cumulative": 0,
      "plan": 0
    }
  ],
  "campaigns": [
    {
      "campaign": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "platform": "string",
        "accountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "accountName": "string",
        "externalId": "string",
        "name": "string",
        "status": "active",
        "platformStatus": "string",
        "objective": "awareness",
        "platformObjective": "string",
        "channelType": "string",
        "budget": {
          "amount": 0,
          "type": "daily",
          "level": "campaign",
          "currency": "string"
        },
        "startDate": "string",
        "endDate": "string",
        "campaignGroup": {
          "externalId": "string",
          "name": "string"
        },
        "hasVideo": true,
        "adGroups": 0,
        "ads": 0,
        "link": "string"
      },
      "last7DaysSpend": 0,
      "dailyAverage": 0,
      "budgetUse": 0,
      "lastDataDay": "string"
    }
  ]
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/ads/campaigns

Management API: kampanyalar

Kapsam ads:read. Her sayı metrik kataloğundandır (sorgu servisi): platformun sayıları (spend, impressions, ad_clicks, ctr, cpc, cpm, platform_conversions) ve Postlip Metrics’in atıf servisiyle reklama verdiği dönüşümler (ad_conversions, ad_conversions:<rol>, cpa, cpa:<rol>, ad_revenue, roas) yan yana, hiç karıştırılmaz. Harcama KDV hariç, günün kuruyla uygulamanın para biriminde; ROAS net gelir ÷ harcama. Hepsi olay tarihiyle sayılır (harcama harcandığı gün, dönüşüm gerçekleştiği gün). Aynı metrikler Query API'de (POST /v1/query, ad_* boyutları) de vardır.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: ads:read.

Kimlik: apiKey
Gerekli kapsam: ads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`from`zorunlu	sorgu	`string`
`to`zorunlu	sorgu	`string`
`compare`	sorgu	`string`	Değerler: none, previous_period, previous_year · Varsayılan: previous_period
`alignment`	sorgu	`string`	Değerler: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year
`includeTest`	sorgu	`string`	Değerler: true, false
`includeInternal`	sorgu	`string`	Değerler: true, false
`includeBot`	sorgu	`string`	Değerler: true, false
`platforms`	sorgu	`string`	en çok 4000 karakter
`accountIds`	sorgu	`string`	en çok 4000 karakter
`attributionModel`	sorgu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`status`	sorgu	`string`	Değerler: active, paused, ended, all · Varsayılan: all
`orderBy`	sorgu	`string`	1–100 karakter · Varsayılan: spend
`direction`	sorgu	`string`	Değerler: asc, desc · Varsayılan: desc
`minClicks`	sorgu	`integer`	0–10000000 · Varsayılan: 20
`search`	sorgu	`string`	1–100 karakter
`naming`	sorgu	`string`	Değerler: all, off_template, follows_template · Varsayılan: all

Yanıtlar

200

Başarılı.

application/jsonAdsCampaigns

Örnek · JSON

{
  "metrics": {
    "metrics": [
      {
        "key": "string",
        "unit": "count",
        "goodDirection": "higher",
        "aggregation": "sum",
        "countingMode": "event_date",
        "source": "rollup"
      }
    ],
    "dimensions": [
      "string"
    ],
    "rows": [
      {
        "dimensions": {},
        "values": {},
        "bucket": {
          "start": "string",
          "end": "string",
          "days": 0,
          "complete": true,
          "beforeTracking": true
        },
        "previous": {},
        "previousBucket": {
          "start": "string",
          "end": "string"
        },
        "deltas": {}
      }
    ],
    "totals": {
      "values": {},
      "deltas": {}
    },
    "comparison": {
      "dateRange": {
        "from": "string",
        "to": "string"
      },
      "comparable": true,
      "totals": {}
    },
    "meta": {
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "timezone": "string",
      "currency": "string",
      "dateRange": {
        "from": "string",
        "to": "string"
      },
      "compare": "none",
      "comparisonRange": {
        "from": "string",
        "to": "string"
      },
      "include": {
        "test": true,
        "internal": true,
        "bot": true
      },
      "trackingStartedOn": "string",
      "freshness": {
        "processedUntil": "2026-11-06T14:46:00+03:00",
        "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
        "upToDate": true,
        "updatedAt": "2026-11-06T14:46:00+03:00",
        "pendingRollupDays": 0
      },
      "countingModes": {},
      "sources": {},
      "conversionRoles": [
        "signup"
      ],
      "attribution": {
        "model": "first_touch",
        "windowDays": 0
      },
      "warnings": [
        {
          "code": "DIMENSION_NOT_AVAILABLE",
          "message": "string",
          "metric": "string",
          "dimension": "string"
        }
      ],
      "truncated": true,
      "generatedAt": "2026-11-06T14:46:00+03:00"
    }
  },
  "campaigns": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "platform": "string",
      "accountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "accountName": "string",
      "externalId": "string",
      "name": "string",
      "status": "active",
      "platformStatus": "string",
      "objective": "awareness",
      "platformObjective": "string",
      "channelType": "string",
      "budget": {
        "amount": 0,
        "type": "daily",
        "level": "campaign",
        "currency": "string"
      },
      "startDate": "string",
      "endDate": "string",
      "campaignGroup": {
        "externalId": "string",
        "name": "string"
      },
      "hasVideo": true,
      "adGroups": 0,
      "ads": 0,
      "link": "string"
    }
  ],
  "unmatched": {
    "metrics": [
      {
        "key": "string",
        "unit": "count",
        "goodDirection": "higher",
        "aggregation": "sum",
        "countingMode": "event_date",
        "source": "rollup"
      }
    ],
    "dimensions": [
      "string"
    ],
    "rows": [
      {
        "dimensions": {},
        "values": {},
        "bucket": {
          "start": "string",
          "end": "string",
          "days": 0,
          "complete": true,
          "beforeTracking": true
        },
        "previous": {},
        "previousBucket": {
          "start": "string",
          "end": "string"
        },
        "deltas": {}
      }
    ],
    "totals": {
      "values": {},
      "deltas": {}
    },
    "comparison": {
      "dateRange": {
        "from": "string",
        "to": "string"
      },
      "comparable": true,
      "totals": {}
    },
    "meta": {
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "timezone": "string",
      "currency": "string",
      "dateRange": {
        "from": "string",
        "to": "string"
      },
      "compare": "none",
      "comparisonRange": {
        "from": "string",
        "to": "string"
      },
      "include": {
        "test": true,
        "internal": true,
        "bot": true
      },
      "trackingStartedOn": "string",
      "freshness": {
        "processedUntil": "2026-11-06T14:46:00+03:00",
        "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
        "upToDate": true,
        "updatedAt": "2026-11-06T14:46:00+03:00",
        "pendingRollupDays": 0
      },
      "countingModes": {},
      "sources": {},
      "conversionRoles": [
        "signup"
      ],
      "attribution": {
        "model": "first_touch",
        "windowDays": 0
      },
      "warnings": [
        {
          "code": "DIMENSION_NOT_AVAILABLE",
          "message": "string",
          "metric": "string",
          "dimension": "string"
        }
      ],
      "truncated": true,
      "generatedAt": "2026-11-06T14:46:00+03:00"
    }
  },
  "counts": {
    "active": 0,
    "paused": 0,
    "ended": 0,
    "all": 0
  },
  "naming": {
    "hasTemplate": true,
    "offTemplate": 0,
    "followsTemplate": 0
  },
  "conversionRoles": [
    "signup"
  ],
  "originalSpend": {},
  "conversionRates": {
    "minClicks": 0,
    "items": [
      {
        "campaignId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "adClicks": 0,
        "adConversions": 0,
        "rate": 0
      }
    ]
  }
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/ads/conversions

Management API: reklamdan gelen dönüşümler

Kapsam ads:read. Panelin listesiyle aynı (07 REK-38): reklama atfedilen dönüşümler, ulaşılan en ileri aşama, opak kimlikler; kişisel veri yoktur.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: ads:read.

Kimlik: apiKey
Gerekli kapsam: ads:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`from`zorunlu	sorgu	`string`
`to`zorunlu	sorgu	`string`
`includeTest`	sorgu	`string`	Değerler: true, false
`includeInternal`	sorgu	`string`	Değerler: true, false
`includeBot`	sorgu	`string`	Değerler: true, false
`platforms`	sorgu	`string`	en çok 4000 karakter
`accountIds`	sorgu	`string`	en çok 4000 karakter
`campaignIds`	sorgu	`string`	en çok 4000 karakter
`role`	sorgu	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`model`	sorgu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`scope`	sorgu	`string`	Değerler: ads, all · Varsayılan: ads
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50

Yanıtlar

200

Başarılı.

application/jsonAdConversionPage

Örnek · JSON

{
  "items": [
    {
      "eventId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "occurredAt": "2026-11-06T14:46:00+03:00",
      "role": "signup",
      "furthestRole": "signup",
      "sold": true,
      "accountId": "string",
      "personId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "channel": "string",
      "source": "string",
      "medium": "string",
      "platform": "string",
      "adAccountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "campaignId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "campaignName": "string",
      "utmCampaign": "string",
      "adId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "adName": "string",
      "landingPage": "string",
      "resolution": "click_id",
      "model": "first_touch",
      "weight": 0,
      "isTest": true
    }
  ],
  "nextCursor": "string",
  "total": 0,
  "conversions": 0,
  "sold": 0,
  "model": "first_touch",
  "conversionRoles": [
    "signup"
  ],
  "countingMode": "event_date"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Raporlar

7 uç

Bölüm kataloğu, raporlar ve şablonlar, donmuş çıktılar ve PDF, e-posta ve zamanlanmış gönderim, teslim günlüğü, paylaşım bağlantıları, AI özeti, tahmin.

GET/v1/apps/{appId}/forecast/scenarios

Tahmin senaryoları

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonForecastScenarioList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "description": "string",
      "inputs": {
        "horizonMonths": 6,
        "basisDays": 90,
        "funnelId": null,
        "budgets": [],
        "elasticityMode": "estimate",
        "elasticity": 0.75,
        "scenarios": [
          {
            "key": "bad",
            "label": null,
            "costMultiplier": 1.25,
            "conversionMultiplier": 0.85,
            "organicMultiplier": 0.5
          },
          {
            "key": "realistic",
            "label": null,
            "costMultiplier": 1,
            "conversionMultiplier": 1,
            "organicMultiplier": 1
          },
          {
            "key": "good",
            "label": null,
            "costMultiplier": 0.85,
            "conversionMultiplier": 1.12,
            "organicMultiplier": 1.4
          }
        ],
        "includeOrganic": true
      },
      "computedAt": "2026-11-06T14:46:00+03:00",
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/forecast/scenarios/{scenarioId}

Tahmin senaryosu

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`scenarioId`zorunlu	yol	`string`	Tahmin senaryosunun kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonForecastScenario

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "description": "string",
  "inputs": {
    "horizonMonths": 6,
    "basisDays": 90,
    "funnelId": null,
    "budgets": [],
    "elasticityMode": "estimate",
    "elasticity": 0.75,
    "scenarios": [
      {
        "key": "bad",
        "label": null,
        "costMultiplier": 1.25,
        "conversionMultiplier": 0.85,
        "organicMultiplier": 0.5
      },
      {
        "key": "realistic",
        "label": null,
        "costMultiplier": 1,
        "conversionMultiplier": 1,
        "organicMultiplier": 1
      },
      {
        "key": "good",
        "label": null,
        "costMultiplier": 0.85,
        "conversionMultiplier": 1.12,
        "organicMultiplier": 1.4
      }
    ],
    "includeOrganic": true
  },
  "result": {
    "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "currency": "string",
    "timezone": "string",
    "generatedAt": "2026-11-06T14:46:00+03:00",
    "method": {
      "key": "log_log_bootstrap",
      "description": "string",
      "assumptions": [
        "string"
      ]
    },
    "basis": {
      "from": "string",
      "to": "string",
      "days": 0,
      "role": "signup",
      "attributionModel": "first_touch",
      "countingModes": {
        "channels": "event_date",
        "steps": "event_date"
      },
      "channels": [
        {
          "platform": "string",
          "label": "string",
          "status": "ok",
          "reason": "string",
          "spend": 0,
          "conversions": 0,
          "spendPerDay": 0,
          "conversionsPerDay": 0,
          "cpa": 0,
          "elasticity": 0,
          "elasticitySource": "estimated",
          "rSquared": 0,
          "weeks": 0,
          "weeksWithSpend": 0,
          "maxSpendPerDay": 0,
          "plannedMonthlyBudget": 0,
          "marginalCpa": 0
        }
      ],
      "organic": {
        "conversions": 0,
        "perDay": 0,
        "trendPerMonth": 0
      },
      "steps": [
        {
          "role": "signup",
          "rate": 0,
          "lagDays": 0
        }
      ],
      "revenuePerConversion": 0,
      "elasticityPrior": 0
    },
    "scenarios": [
      {
        "key": "string",
        "label": "string",
        "costMultiplier": 0,
        "conversionMultiplier": 0,
        "organicMultiplier": 0,
        "months": [],
        "totals": {
          "budget": 0,
          "paid": {
            "p10": 0,
            "p50": 0,
            "p90": 0
          },
          "organic": {
            "p10": 0,
            "p50": 0,
            "p90": 0
          },
          "total": {
            "p10": 0,
            "p50": 0,
            "p90": 0
          },
          "steps": [],
          "revenue": {
            "p10": 0,
            "p50": 0,
            "p90": 0
          }
        }
      }
    ],
    "goal": {
      "monthlyConversions": 0,
      "monthlyBudget": 0,
      "scale": 0
    },
    "warnings": [
      {
        "code": "EXTRAPOLATION",
        "message": "string",
        "platform": "string"
      }
    ]
  },
  "computedAt": "2026-11-06T14:46:00+03:00",
  "actuals": [
    {
      "month": "string",
      "complete": true,
      "spend": 0,
      "paid": 0,
      "total": 0,
      "forecastPaid": 0
    }
  ],
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/reports

Raporlar

Anahtarın uygulama kapsamındaki raporlar. Kapsam: reports:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`appId`	sorgu	`string`	Biçim: uuid
`search`	sorgu	`string`	1–200 karakter

Yanıtlar

200

Başarılı.

application/jsonReportPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "description": "string",
      "appIds": [
        "01a1b249-9ed2-77e8-af53-0c99529e68cb"
      ],
      "apps": [
        {
          "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
          "slug": "string",
          "name": "string",
          "timezone": "string",
          "currency": "string"
        }
      ],
      "sections": [
        {
          "type": "kpi",
          "metric": "string",
          "spark": true,
          "filters": []
        }
      ],
      "period": {
        "kind": "relative",
        "preset": "yesterday"
      },
      "compare": "none",
      "filters": [
        {
          "dimension": "string",
          "op": "eq",
          "value": "string"
        }
      ],
      "include": {
        "test": true,
        "internal": true,
        "bot": true
      },
      "attributionModel": "first_touch",
      "locale": "tr",
      "timezone": "string",
      "subtitle": "string",
      "templateKey": "string",
      "lastSnapshot": {
        "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "generatedAt": "2026-11-06T14:46:00+03:00",
        "from": "string",
        "to": "string"
      },
      "schedules": 0,
      "shareLinks": {
        "active": 0,
        "total": 0
      },
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/reports/{reportId}

Rapor

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`reportId`zorunlu	yol	`string`	Raporun kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonReport

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "description": "string",
  "appIds": [
    "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  ],
  "apps": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "slug": "string",
      "name": "string",
      "timezone": "string",
      "currency": "string"
    }
  ],
  "sections": [
    {
      "type": "kpi",
      "metric": "string",
      "spark": true,
      "filters": []
    }
  ],
  "period": {
    "kind": "relative",
    "preset": "yesterday"
  },
  "compare": "none",
  "filters": [
    {
      "dimension": "string",
      "op": "eq",
      "value": "string"
    }
  ],
  "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "include": {
    "test": true,
    "internal": true,
    "bot": true
  },
  "attributionModel": "first_touch",
  "locale": "tr",
  "timezone": "string",
  "subtitle": "string",
  "templateKey": "string",
  "lastSnapshot": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "generatedAt": "2026-11-06T14:46:00+03:00",
    "from": "string",
    "to": "string"
  },
  "schedules": 0,
  "shareLinks": {
    "active": 0,
    "total": 0
  },
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/reports/{reportId}/snapshots

Rapor çıktıları

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`reportId`zorunlu	yol	`string`	Raporun kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50

Yanıtlar

200

Başarılı.

application/jsonReportSnapshotPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "reportId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "subtitle": "string",
      "trigger": "manual",
      "period": {
        "from": "string",
        "to": "string",
        "preset": "yesterday"
      },
      "comparison": {
        "mode": "none",
        "from": "string",
        "to": "string"
      },
      "timezone": "string",
      "locale": "tr",
      "generatedAt": "2026-11-06T14:46:00+03:00",
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "scheduleId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "aiSummaryStatus": "disabled"
    }
  ],
  "nextCursor": "string"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/reports/{reportId}/snapshots/{snapshotId}

Rapor çıktısı

Donmuş sayılar: her bölümün sorgu servisi yanıtları, tazelik, AI özeti. Her sayı sorgu servisinin (metrik kataloğu) yanıtıdır: bölümün kendi formülü yoktur; oranlar pay ve paydanın toplamından, her sonuç sayım modunu (event_date / cohort) söyler.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`reportId`zorunlu	yol	`string`	Raporun kimliği. Biçim: uuid
`snapshotId`zorunlu	yol	`string`	Rapor çıktısının kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonReportSnapshot

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "reportId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "subtitle": "string",
  "trigger": "manual",
  "period": {
    "from": "string",
    "to": "string",
    "preset": "yesterday"
  },
  "comparison": {
    "mode": "none",
    "from": "string",
    "to": "string"
  },
  "timezone": "string",
  "locale": "tr",
  "generatedAt": "2026-11-06T14:46:00+03:00",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "scheduleId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "apps": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "slug": "string",
      "name": "string",
      "timezone": "string",
      "currency": "string"
    }
  ],
  "filters": [
    {
      "dimension": "string",
      "op": "eq",
      "value": "string"
    }
  ],
  "include": {
    "test": true,
    "internal": true,
    "bot": true
  },
  "attributionModel": "first_touch",
  "freshness": [
    {
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "processedUntil": "2026-11-06T14:46:00+03:00",
      "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
      "upToDate": true,
      "pendingRollupDays": 0,
      "adsSyncedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "sections": [
    {
      "id": "string",
      "type": "kpi",
      "title": "string",
      "subtitle": "string",
      "size": "kpi",
      "definition": {
        "type": "kpi",
        "metric": "string",
        "spark": true,
        "filters": []
      },
      "metrics": [
        {
          "key": "string",
          "label": "string",
          "description": "string",
          "unit": "count",
          "goodDirection": "higher",
          "countingMode": "event_date"
        }
      ],
      "countingModes": [
        "event_date"
      ],
      "text": "string",
      "apps": [
        {
          "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
          "status": "ok",
          "message": "string",
          "results": {},
          "funnel": {
            "funnel": {
              "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
              "name": "string",
              "order": "ordered",
              "countBy": "person",
              "conversionWindow": {
                "value": 0,
                "unit": "minutes"
              }
            },
            "countingMode": "event_date",
            "dateRange": {
              "from": "string",
              "to": "string"
            },
            "timezone": "string",
            "followedUntil": "2026-11-06T14:46:00+03:00",
            "include": {
              "test": true,
              "internal": true,
              "bot": true
            },
            "steps": [],
            "breakdown": {
              "dimension": "channel",
              "attributionModel": "first_touch",
              "rows": [],
              "others": []
            },
            "warnings": [],
            "generatedAt": "2026-11-06T14:46:00+03:00"
          },
          "labels": {},
          "lines": [],
          "derived": {
            "share": {
              "metric": "string",
              "total": 0,
              "rows": []
            },
            "steps": [],
            "stack": {
              "metric": "string",
              "dimension": "string",
              "buckets": [],
              "series": [],
              "others": []
            }
          }
        }
      ]
    }
  ],
  "aiSummary": {
    "status": "disabled",
    "locale": "tr",
    "text": "string",
    "model": "string",
    "generatedAt": "2026-11-06T14:46:00+03:00",
    "error": "string"
  }
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/reports/{reportId}/snapshots/{snapshotId}/pdf

PDF indir

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: reports:read.

Kimlik: apiKey
Gerekli kapsam: reports:read

Parametreler

Ad	Yer	Tip	Açıklama
`reportId`zorunlu	yol	`string`	Raporun kimliği. Biçim: uuid
`snapshotId`zorunlu	yol	`string`	Rapor çıktısının kimliği. Biçim: uuid

Yanıtlar

200
Rapor çıktısının PDF’i (sunucuda çizilir: kapak, içindekiler, vektör grafikler, sayfa numaraları).
Yanıt başlıkları
- Content-Dispositionstring
  attachment; filename="…"
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Sosyal medya

4 uç

Instagram, Facebook sayfası ve LinkedIn şirket sayfası hesapları; özet, en iyi paylaşım zamanı, gönderiler ve sayıları; içerik takvimi, planlanan gönderiler, onay akışı, zamanlanmış yayın ve hatırlatmalar.

GET/v1/apps/{appId}/social/accounts

Uygulamanın sosyal medya hesapları, yetenekleri ve tazelikleri. Kapsam: social:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: social:read.

Kimlik: apiKey
Gerekli kapsam: social:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonSocialAccountList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "platform": "instagram",
      "status": "active",
      "connectionId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "externalId": "string",
      "username": "string",
      "name": "string",
      "profile": {
        "bio": "string",
        "website": "string",
        "avatarUrl": "string",
        "pageUrl": "string"
      },
      "followers": 0,
      "mediaCount": 0,
      "autoPublish": true,
      "capabilities": {
        "insights": true,
        "publish": true,
        "formats": [],
        "autoPublishFormats": []
      },
      "freshness": {
        "lastSyncedAt": "2026-11-06T14:46:00+03:00",
        "nextSyncAt": "2026-11-06T14:46:00+03:00",
        "lastError": {
          "code": "string",
          "message": "string"
        }
      },
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/social/overview

KPI’lar ve günlük seriler. Her sayı metrik kataloğundandır (social.<platform|all>.<metrik>, sorgu servisi): raporlar, bildirim eşikleri ve Query API aynı tanımı okur. Oranlar pay ve paydanın toplamından hesaplanır (etkileşim oranı = Σ etkileşim ÷ Σ erişim). Tekil erişim toplanamaz: dönemin tekil erişimi (reach, platformun verdiği pencerelerde) ile günlük erişimlerin toplamı (daily_reach) ayrı metriklerdir; birden çok hesapta tekil erişim yalnız uyarıyla gösterilir. Değeri olmayan her metrik sebebini söyler (bağlı değil, izin yok, platform vermiyor, dönem sınırı, geçmiş sınırı, veri yok). Aynı metrikler Query API’de (POST /v1/query, query:read) de sorgulanır. Kapsam: social:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: social:read.

Kimlik: apiKey
Gerekli kapsam: social:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`platform`	sorgu	`string`	Değerler: all, instagram, facebook, linkedin · Varsayılan: all
`accountIds`	sorgu	`string`	en çok 4000 karakter
`from`zorunlu	sorgu	`string`
`to`zorunlu	sorgu	`string`
`compare`	sorgu	`string`	Değerler: none, previous_period, previous_year · Varsayılan: previous_period
`alignment`	sorgu	`string`	Değerler: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year
`granularity`	sorgu	`string`	Değerler: day, week, month · Varsayılan: day

Yanıtlar

200

Başarılı.

application/jsonSocialOverview

Örnek · JSON

{
  "scope": {
    "platform": "all",
    "accountIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ]
  },
  "accounts": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "platform": "instagram",
      "name": "string",
      "username": "string",
      "lastSyncedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "kpis": [
    {
      "metric": "string",
      "label": "string",
      "description": "string",
      "unit": "count",
      "goodDirection": "higher",
      "countingMode": "event_date",
      "value": 0,
      "previous": 0,
      "delta": {
        "previous": 0,
        "absolute": 0,
        "relative": 0,
        "mode": "relative",
        "direction": "up",
        "tone": "positive",
        "comparable": true,
        "reason": "zero_base"
      },
      "unavailable": {
        "reason": "not_provided",
        "message": "string"
      },
      "notAdditive": true
    }
  ],
  "series": {
    "metrics": [
      {
        "key": "string",
        "unit": "count",
        "goodDirection": "higher",
        "aggregation": "sum",
        "countingMode": "event_date",
        "source": "rollup"
      }
    ],
    "dimensions": [
      "string"
    ],
    "rows": [
      {
        "dimensions": {},
        "values": {},
        "bucket": {
          "start": "string",
          "end": "string",
          "days": 0,
          "complete": true,
          "beforeTracking": true
        },
        "previous": {},
        "previousBucket": {
          "start": "string",
          "end": "string"
        },
        "deltas": {}
      }
    ],
    "totals": {
      "values": {},
      "deltas": {}
    },
    "comparison": {
      "dateRange": {
        "from": "string",
        "to": "string"
      },
      "comparable": true,
      "totals": {}
    },
    "meta": {
      "appId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "timezone": "string",
      "currency": "string",
      "dateRange": {
        "from": "string",
        "to": "string"
      },
      "compare": "none",
      "comparisonRange": {
        "from": "string",
        "to": "string"
      },
      "include": {
        "test": true,
        "internal": true,
        "bot": true
      },
      "trackingStartedOn": "string",
      "freshness": {
        "processedUntil": "2026-11-06T14:46:00+03:00",
        "lastEventReceivedAt": "2026-11-06T14:46:00+03:00",
        "upToDate": true,
        "updatedAt": "2026-11-06T14:46:00+03:00",
        "pendingRollupDays": 0
      },
      "countingModes": {},
      "sources": {},
      "conversionRoles": [
        "signup"
      ],
      "attribution": {
        "model": "first_touch",
        "windowDays": 0
      },
      "warnings": [
        {
          "code": "DIMENSION_NOT_AVAILABLE",
          "message": "string",
          "metric": "string",
          "dimension": "string"
        }
      ],
      "truncated": true,
      "generatedAt": "2026-11-06T14:46:00+03:00"
    }
  },
  "warnings": [
    {
      "code": "DIMENSION_NOT_AVAILABLE",
      "message": "string",
      "metric": "string",
      "dimension": "string"
    }
  ],
  "posts": 0,
  "uniqueByAccount": [
    {
      "accountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "kpis": [
        {
          "metric": "string",
          "value": 0,
          "previous": 0,
          "delta": {
            "previous": 0,
            "absolute": 0,
            "relative": 0,
            "mode": "relative",
            "direction": "up",
            "tone": "positive",
            "comparable": true,
            "reason": "zero_base"
          },
          "unavailable": {
            "reason": "not_provided",
            "message": "string"
          }
        }
      ]
    }
  ]
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/social/posts

Eşitlenen gönderiler ve sayıları. Gönderiler yayın tarihine göre sayılır (kohort): bir gönderinin sonradan gelen etkileşimi yayın gününe yazılır. Platformda doğrudan paylaşılan gönderiler de vardır; Postlip Metrics’ten yayımlanan gönderi planlanan gönderiye bağlanır (plannedPostId). Kapsam: social:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: social:read.

Kimlik: apiKey
Gerekli kapsam: social:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`platform`	sorgu	`string`	Değerler: all, instagram, facebook, linkedin · Varsayılan: all
`accountIds`	sorgu	`string`	en çok 4000 karakter
`from`	sorgu	`string`
`to`	sorgu	`string`
`type`	sorgu	`string`	Değerler: image, carousel, video, reel, story, text, link, other
`search`	sorgu	`string`	en çok 200 karakter
`campaign`	sorgu	`string`	en çok 120 karakter
`sort`	sorgu	`string`	Değerler: newest, engagement, reach · Varsayılan: newest

Yanıtlar

200

Başarılı.

application/jsonSocialPublishedPostPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "accountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "platform": "instagram",
      "externalId": "string",
      "type": "image",
      "caption": "string",
      "permalink": "string",
      "publishedAt": "2026-11-06T14:46:00+03:00",
      "publishedLocal": {
        "date": "string",
        "time": "string"
      },
      "thumbnailUrl": "string",
      "metrics": {
        "likes": 0,
        "comments": 0,
        "shares": 0,
        "saves": 0,
        "reach": 0,
        "views": 0,
        "clicks": 0,
        "engagement": 0,
        "engagementRate": 0
      },
      "unavailable": {},
      "plannedPostId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "campaignKey": "string",
      "metricsUpdatedAt": "2026-11-06T14:46:00+03:00",
      "nextRefreshAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string",
  "countingMode": "event_date",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/social/posts/{postId}

Gönderinin sayıları ve zaman içindeki değişimi. Kapsam: social:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: social:read.

Kimlik: apiKey
Gerekli kapsam: social:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`postId`zorunlu	yol	`string`	Gönderinin ya da yazının kimliği (planlanan / eşitlenen sosyal gönderi ya da blog yazısı, uca göre). Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonSocialPublishedPostDetail

Örnek · JSON

{
  "post": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "accountId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "platform": "instagram",
    "externalId": "string",
    "type": "image",
    "caption": "string",
    "permalink": "string",
    "publishedAt": "2026-11-06T14:46:00+03:00",
    "publishedLocal": {
      "date": "string",
      "time": "string"
    },
    "thumbnailUrl": "string",
    "metrics": {
      "likes": 0,
      "comments": 0,
      "shares": 0,
      "saves": 0,
      "reach": 0,
      "views": 0,
      "clicks": 0,
      "engagement": 0,
      "engagementRate": 0
    },
    "unavailable": {},
    "plannedPostId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "campaignKey": "string",
    "metricsUpdatedAt": "2026-11-06T14:46:00+03:00",
    "nextRefreshAt": "2026-11-06T14:46:00+03:00"
  },
  "history": [
    {
      "capturedAt": "2026-11-06T14:46:00+03:00",
      "likes": 0,
      "comments": 0,
      "shares": 0,
      "saves": 0,
      "reach": 0,
      "views": 0,
      "clicks": 0
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Segmentler

3 uç

Kural tabanlı kişi kümeleri: kişi alanları, izinler, listeler ve bağlı kişinin olayları (iş rolüyle); kullanıldıkları anda değerlendirilir.

GET/v1/apps/{appId}/analytics/segments

Kişi ve hesap segmentleri

Query API isteğinin segmentId ile adlandırabileceği segmentler (subject ile yalnız biri). Kapsam: query:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`subject`	sorgu	`string`	Değerler: person, account

Yanıtlar

200

Başarılı.

application/jsonAnalyticsSegmentList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "description": "string",
      "subject": "person",
      "rules": {
        "match": "all",
        "conditions": []
      },
      "lastCount": 0,
      "lastCountedAt": "2026-11-06T14:46:00+03:00",
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/analytics/segments/{segmentId}

Kişi ya da hesap segmenti

Analitik kişi (person) ya da hesap (account) segmenti (dalga 16; 07 YEN-18). Kurallar (en çok 20, all ya da any): özellik (trait: kişinin identify ya da hesabın group özelliği, olay zamanına göre en yeni değer — metin olarak büyük/küçük harf farksız eq, neq, in, contains, starts_with, is_empty, is_not_empty, yalnız JSON sayısına gt, gte, lt, lte), olay (event: iş rolü ya da olay adı, son N günde en az K kez — has: false ile yapmamış —, en çok 5 olay özelliği süzgeciyle; test ve bot trafiği sayılmaz, kişiye birleşen kişilerin olayları sayılır; hesapta kendi groupIdsi olan olaylar ve tek hesabı bu olan üyelerin hesapsız olayları) ve görülme (seen: ilk / son görülme son N günde ya da değil). Değerini profilde gizleyen özellik (kişisel ya da hassas veri sınıfı, allow dışı eylem) kural olamaz (trait_personal, property_personal). Segment kullanıldığı anda değerlendirilir, üye listesi saklanmaz. Kullanım: sorgunun, rapor ve bölümünün, eşik kuralının segmentId’si; 18. dalgadan Mailing kişi segmentinin analytics_segment kuralı ve Mailing metrikleri (alıcının kişisi, kullanıcı kimliğiyle) ile kampanya sonuçlarının segmentId’si. Kapsam: query:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`segmentId`zorunlu	yol	`string`	Segmentin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonAnalyticsSegment

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "name": "string",
  "description": "string",
  "subject": "person",
  "rules": {
    "match": "all",
    "conditions": [
      {}
    ]
  },
  "lastCount": 0,
  "lastCountedAt": "2026-11-06T14:46:00+03:00",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00"
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/analytics/segments/{segmentId}/count

Kişi ya da hesap segmentini say

Segmentin şimdi eşleştiği kişi ya da hesap sayısı ve en son görülen ilk 10’unun opak kimliği; kişisel veri dönmez. Kapsam: query:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: query:read.

Kimlik: apiKey
Gerekli kapsam: query:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`segmentId`zorunlu	yol	`string`	Segmentin kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonAnalyticsSegmentCount

Örnek · JSON

{
  "subject": "person",
  "count": 0,
  "sample": [
    "string"
  ],
  "readsEvents": true
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Mailing & SMS

12 uç

Kişiler (kimlik bilgileri yalnız şifreli), listeler, özel alanlar, izinler ve kanıtları, içe / dışa aktarma, şablonlar, kampanyalar (test, onay, zamanlama, sonuçlar), işlemsel tetikleyiciler, sağlayıcılar, gönderen kimlikleri; iletilerin herkese açık adresleri (açılma pikseli, tıklama yönlendirmesi, abonelikten çıkma) ve sağlayıcı webhook'ları.

GET/v1/apps/{appId}/messaging/campaigns

Kampanyalar

Kapsam: messaging:read. Sayılar metrik kataloğundandır (email.*, sms.*; raporlar, bildirim eşikleri ve Query API aynı tanımı okur). İletiler gönderildikleri zamana göre sayılır (kohort): sonradan gelen açılma gönderim gününe yazılır. Oranlar pay ve paydanın toplamından hesaplanır (açılma oranı = Σ açılan ÷ Σ teslim).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:read.

Kimlik: apiKey
Gerekli kapsam: messaging:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`cursor`	sorgu	`string`	Desen: `^[A-Za-z0-9_-]{1,512}$`
`limit`	sorgu	`integer`	1–200 · Varsayılan: 50
`channel`	sorgu	`string`	Değerler: email, sms
`status`	sorgu	`string`	Değerler: draft, awaiting_approval, scheduled, sending, paused, sent, cancelled, failed

Yanıtlar

200

Başarılı.

application/jsonMessageCampaignPage

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "channel": "email",
      "name": "string",
      "slug": "string",
      "utm": {
        "source": "string",
        "medium": "string",
        "campaign": "string"
      },
      "templateId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "subject": "string",
      "preheader": "string",
      "body": "string",
      "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "audience": {
        "listIds": [],
        "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
      },
      "locale": "tr",
      "status": "draft",
      "schedule": {
        "date": "string",
        "time": "string",
        "timezone": "string",
        "at": "2026-11-06T14:46:00+03:00"
      },
      "start": {
        "at": "2026-11-06T14:46:00+03:00",
        "immediate": true
      },
      "throttlePerMinute": 0,
      "confirmation": {
        "testSentAt": "2026-11-06T14:46:00+03:00",
        "testSentBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "testCurrent": true,
        "confirmedAt": "2026-11-06T14:46:00+03:00",
        "confirmedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
      },
      "approval": {
        "status": "pending",
        "requestedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "requestedAt": "2026-11-06T14:46:00+03:00",
        "decidedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
        "decidedAt": "2026-11-06T14:46:00+03:00",
        "note": "string"
      },
      "counts": {
        "recipients": 0,
        "queued": 0,
        "sending": 0,
        "sent": 0,
        "delivered": 0,
        "failed": 0,
        "bounced": 0,
        "unknown": 0,
        "skipped": 0,
        "opened": 0,
        "clicked": 0,
        "complained": 0,
        "unsubscribed": 0
      },
      "skippedByReason": {},
      "progress": 0,
      "errorCode": "string",
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00",
      "startedAt": "2026-11-06T14:46:00+03:00",
      "finishedAt": "2026-11-06T14:46:00+03:00"
    }
  ],
  "nextCursor": "string",
  "total": 0
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/campaigns

Kampanya oluştur

17. dalga (D8): panelin kurallarıyla taslak kampanya — kanal, ad, şablon ya da içerik, kitle (liste / segment), gönderen. Kapsam: messaging:write; denetim kaydına anahtar işlemi yapan olarak yazılır. Yanıtta kişisel veri yok.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonCreateMessageCampaignRequest

Alan	Tip	Açıklama
`channel`zorunlu	`string`	Değerler: email, sms
`name`zorunlu	`string`	1–200 karakter
`templateId`	`string`	Biçim: uuid
`templateKey`	`string`	en çok 80 karakter
`subject`	`string`	null olabilir
`preheader`	`string`	null olabilir
`body`	`string`	en çok 20000 karakter
`senderId`	`string`	null olabilir
`audience`	`object`
`audience.listIds`	`string[]`	en çok 20 öğe · Varsayılan: []
`audience.segmentId`	`string`	null olabilir
`locale`	`string`	Değerler: tr, en
`throttlePerMinute`	`integer`	null olabilir
`utmSource`	`string`	1–100 karakter

Örnek · JSON

{
  "channel": "email",
  "name": "string",
  "templateId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "templateKey": "string",
  "subject": "string",
  "preheader": "string",
  "body": "string",
  "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "audience": {
    "listIds": [],
    "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "locale": "tr",
  "throttlePerMinute": 1,
  "utmSource": "string"
}

Yanıtlar

201

Oluşturuldu.

application/jsonMessageCampaign

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "channel": "email",
  "name": "string",
  "slug": "string",
  "utm": {
    "source": "string",
    "medium": "string",
    "campaign": "string"
  },
  "templateId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "subject": "string",
  "preheader": "string",
  "body": "string",
  "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "audience": {
    "listIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ],
    "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "locale": "tr",
  "status": "draft",
  "schedule": {
    "date": "string",
    "time": "string",
    "timezone": "string",
    "at": "2026-11-06T14:46:00+03:00"
  },
  "start": {
    "at": "2026-11-06T14:46:00+03:00",
    "immediate": true
  },
  "throttlePerMinute": 0,
  "confirmation": {
    "testSentAt": "2026-11-06T14:46:00+03:00",
    "testSentBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "testCurrent": true,
    "confirmedAt": "2026-11-06T14:46:00+03:00",
    "confirmedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "approval": {
    "status": "pending",
    "requestedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "requestedAt": "2026-11-06T14:46:00+03:00",
    "decidedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "decidedAt": "2026-11-06T14:46:00+03:00",
    "note": "string"
  },
  "counts": {
    "recipients": 0,
    "queued": 0,
    "sending": 0,
    "sent": 0,
    "delivered": 0,
    "failed": 0,
    "bounced": 0,
    "unknown": 0,
    "skipped": 0,
    "opened": 0,
    "clicked": 0,
    "complained": 0,
    "unsubscribed": 0
  },
  "skippedByReason": {},
  "progress": 0,
  "errorCode": "string",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "startedAt": "2026-11-06T14:46:00+03:00",
  "finishedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PATCH/v1/apps/{appId}/messaging/campaigns/{campaignId}

Kampanyayı düzenle

17. dalga (D8): yalnız taslak; içerik değişince önceki test geçersiz olur. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`campaignId`zorunlu	yol	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpdateMessageCampaignRequest

Alan	Tip	Açıklama
`name`	`string`	1–200 karakter
`subject`	`string`	null olabilir
`preheader`	`string`	null olabilir
`body`	`string`	en çok 20000 karakter
`senderId`	`string`	null olabilir
`audience`	`object`
`audience.listIds`	`string[]`	en çok 20 öğe · Varsayılan: []
`audience.segmentId`	`string`	null olabilir
`locale`	`string`	Değerler: tr, en
`throttlePerMinute`	`integer`	null olabilir
`utmSource`	`string`	1–100 karakter

Örnek · JSON

{
  "name": "string",
  "subject": "string",
  "preheader": "string",
  "body": "string",
  "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "audience": {
    "listIds": [],
    "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "locale": "tr",
  "throttlePerMinute": 1,
  "utmSource": "string"
}

Yanıtlar

200

Başarılı.

application/jsonMessageCampaign

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "channel": "email",
  "name": "string",
  "slug": "string",
  "utm": {
    "source": "string",
    "medium": "string",
    "campaign": "string"
  },
  "templateId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "subject": "string",
  "preheader": "string",
  "body": "string",
  "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "audience": {
    "listIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ],
    "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "locale": "tr",
  "status": "draft",
  "schedule": {
    "date": "string",
    "time": "string",
    "timezone": "string",
    "at": "2026-11-06T14:46:00+03:00"
  },
  "start": {
    "at": "2026-11-06T14:46:00+03:00",
    "immediate": true
  },
  "throttlePerMinute": 0,
  "confirmation": {
    "testSentAt": "2026-11-06T14:46:00+03:00",
    "testSentBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "testCurrent": true,
    "confirmedAt": "2026-11-06T14:46:00+03:00",
    "confirmedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "approval": {
    "status": "pending",
    "requestedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "requestedAt": "2026-11-06T14:46:00+03:00",
    "decidedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "decidedAt": "2026-11-06T14:46:00+03:00",
    "note": "string"
  },
  "counts": {
    "recipients": 0,
    "queued": 0,
    "sending": 0,
    "sent": 0,
    "delivered": 0,
    "failed": 0,
    "bounced": 0,
    "unknown": 0,
    "skipped": 0,
    "opened": 0,
    "clicked": 0,
    "complained": 0,
    "unsubscribed": 0
  },
  "skippedByReason": {},
  "progress": 0,
  "errorCode": "string",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "startedAt": "2026-11-06T14:46:00+03:00",
  "finishedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/messaging/campaigns/{campaignId}/results

Kampanya sonuçları

Kapsam: messaging:read; isteğe bağlı segmentId (18. dalga). Sayılar metrik kataloğundandır (email.*, sms.*; raporlar, bildirim eşikleri ve Query API aynı tanımı okur). İletiler gönderildikleri zamana göre sayılır (kohort): sonradan gelen açılma gönderim gününe yazılır. Oranlar pay ve paydanın toplamından hesaplanır (açılma oranı = Σ açılan ÷ Σ teslim).

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:read.

Kimlik: apiKey
Gerekli kapsam: messaging:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`campaignId`zorunlu	yol	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Biçim: uuid
`segmentId`	sorgu	`string`	Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonCampaignResults

Örnek · JSON

{
  "campaignId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "channel": "email",
  "status": "draft",
  "counts": {
    "recipients": 0,
    "queued": 0,
    "sending": 0,
    "sent": 0,
    "delivered": 0,
    "failed": 0,
    "bounced": 0,
    "unknown": 0,
    "skipped": 0,
    "opened": 0,
    "clicked": 0,
    "complained": 0,
    "unsubscribed": 0
  },
  "metrics": {},
  "progress": 0,
  "utm": {
    "source": "string",
    "medium": "string",
    "campaign": "string"
  },
  "traffic": {
    "from": "string",
    "to": "string",
    "sessions": 0,
    "conversions": 0,
    "conversionsByRole": {},
    "revenue": 0,
    "countingMode": "event_date"
  },
  "countingMode": "cohort",
  "unavailable": {},
  "segment": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "name": "string"
  }
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/campaigns/{campaignId}/send

Kampanyayı gönder

17. dalga (D8): şimdi ya da bir zamanda (schedule, uygulamanın saat diliminde); içeriğin gözden geçirildiği ve onay (contentReviewed, confirm) zorunlu. Uygulama onay istiyorsa kampanya onaya düşer — anahtar onaylayamaz, bir üyenin onayını bekler. Kapsam: messaging:write, denetim kaydıyla.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`campaignId`zorunlu	yol	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonSendCampaignRequest

Alan	Tip	Açıklama
`contentReviewed`zorunlu	`boolean`	Sabit: true
`confirm`zorunlu	`boolean`	Sabit: true
`schedule`	`MessagingLocalTime`	null olabilir
`note`	`string`	null olabilir

Örnek · JSON

{
  "contentReviewed": true,
  "confirm": true,
  "schedule": {
    "date": "string",
    "time": "string"
  },
  "note": "string"
}

Yanıtlar

200

Başarılı.

application/jsonMessageCampaign

Örnek · JSON

{
  "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "channel": "email",
  "name": "string",
  "slug": "string",
  "utm": {
    "source": "string",
    "medium": "string",
    "campaign": "string"
  },
  "templateId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "subject": "string",
  "preheader": "string",
  "body": "string",
  "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "audience": {
    "listIds": [
      "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    ],
    "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "locale": "tr",
  "status": "draft",
  "schedule": {
    "date": "string",
    "time": "string",
    "timezone": "string",
    "at": "2026-11-06T14:46:00+03:00"
  },
  "start": {
    "at": "2026-11-06T14:46:00+03:00",
    "immediate": true
  },
  "throttlePerMinute": 0,
  "confirmation": {
    "testSentAt": "2026-11-06T14:46:00+03:00",
    "testSentBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "testCurrent": true,
    "confirmedAt": "2026-11-06T14:46:00+03:00",
    "confirmedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  },
  "approval": {
    "status": "pending",
    "requestedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "requestedAt": "2026-11-06T14:46:00+03:00",
    "decidedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "decidedAt": "2026-11-06T14:46:00+03:00",
    "note": "string"
  },
  "counts": {
    "recipients": 0,
    "queued": 0,
    "sending": 0,
    "sent": 0,
    "delivered": 0,
    "failed": 0,
    "bounced": 0,
    "unknown": 0,
    "skipped": 0,
    "opened": 0,
    "clicked": 0,
    "complained": 0,
    "unsubscribed": 0
  },
  "skippedByReason": {},
  "progress": 0,
  "errorCode": "string",
  "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "createdAt": "2026-11-06T14:46:00+03:00",
  "updatedAt": "2026-11-06T14:46:00+03:00",
  "startedAt": "2026-11-06T14:46:00+03:00",
  "finishedAt": "2026-11-06T14:46:00+03:00"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/campaigns/{campaignId}/test

Test gönder

17. dalga (D8): verilen adreslere (en çok birkaç) test iletisi; panelde olduğu gibi gönderimden önce gerekir. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`campaignId`zorunlu	yol	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonTestSendRequest

Alan	Tip	Açıklama
`recipients`zorunlu	`string[]`	1–5 öğe
`contactId`	`string`	Biçim: uuid

Örnek · JSON

{
  "recipients": [
    "string"
  ],
  "contactId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
}

Yanıtlar

200

Başarılı.

application/jsonTestSendResult

Örnek · JSON

{
  "results": [
    {
      "to": "string",
      "status": "sent",
      "errorCode": "string"
    }
  ],
  "sms": {
    "encoding": "gsm7",
    "characters": 0,
    "units": 0,
    "parts": 0,
    "perPart": 0,
    "remaining": 0,
    "credits": 0,
    "unsupported": [
      "string"
    ]
  },
  "campaign": {
    "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "channel": "email",
    "name": "string",
    "slug": "string",
    "utm": {
      "source": "string",
      "medium": "string",
      "campaign": "string"
    },
    "templateId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "subject": "string",
    "preheader": "string",
    "body": "string",
    "senderId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "audience": {
      "listIds": [
        "01a1b249-9ed2-77e8-af53-0c99529e68cb"
      ],
      "segmentId": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    },
    "locale": "tr",
    "status": "draft",
    "schedule": {
      "date": "string",
      "time": "string",
      "timezone": "string",
      "at": "2026-11-06T14:46:00+03:00"
    },
    "start": {
      "at": "2026-11-06T14:46:00+03:00",
      "immediate": true
    },
    "throttlePerMinute": 0,
    "confirmation": {
      "testSentAt": "2026-11-06T14:46:00+03:00",
      "testSentBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "testCurrent": true,
      "confirmedAt": "2026-11-06T14:46:00+03:00",
      "confirmedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb"
    },
    "approval": {
      "status": "pending",
      "requestedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "requestedAt": "2026-11-06T14:46:00+03:00",
      "decidedBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "decidedAt": "2026-11-06T14:46:00+03:00",
      "note": "string"
    },
    "counts": {
      "recipients": 0,
      "queued": 0,
      "sending": 0,
      "sent": 0,
      "delivered": 0,
      "failed": 0,
      "bounced": 0,
      "unknown": 0,
      "skipped": 0,
      "opened": 0,
      "clicked": 0,
      "complained": 0,
      "unsubscribed": 0
    },
    "skippedByReason": {},
    "progress": 0,
    "errorCode": "string",
    "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
    "createdAt": "2026-11-06T14:46:00+03:00",
    "updatedAt": "2026-11-06T14:46:00+03:00",
    "startedAt": "2026-11-06T14:46:00+03:00",
    "finishedAt": "2026-11-06T14:46:00+03:00"
  }
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/consents

İzni değiştir

Kişi kimliği, e-postası, telefonu ya da kullanıcı kimliğiyle. Hiçbir kişide olmayan bir adres için ret (opt_out) yine kaydedilir: adres bastırılır, kanıt kör dizinle saklanır. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonManagementConsentRequest

Alan	Tip	Açıklama
`contactId`	`string`	Biçim: uuid
`email`	`string`	en çok 320 karakter
`phone`	`string`	en çok 40 karakter
`userId`	`string`	1–200 karakter
`channel`zorunlu	`string`	Değerler: email, sms
`kind`zorunlu	`string`	Değerler: none, merchant, opt_in, opt_out
`reason`	`string`	null olabilir
`evidence`	`string`	null olabilir
`form`	`string`	null olabilir
`occurredAt`	`string`	Biçim: date-time

Örnek · JSON

{
  "contactId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "email": "string",
  "phone": "string",
  "userId": "string",
  "channel": "email",
  "kind": "none",
  "reason": "string",
  "evidence": "string",
  "form": "string",
  "occurredAt": "2026-11-06T14:46:00+03:00"
}

Yanıtlar

200

Başarılı.

application/jsonConsentResult

Örnek · JSON

{
  "contactId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "kind": "none"
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

PUT/v1/apps/{appId}/messaging/contacts

Kişi ekle ya da güncelle

E-posta, telefon ya da uygulamanın kullanıcı kimliğiyle eşleşen kişi güncellenir, yoksa oluşturulur (kopya yok). İzinler kanıtıyla (formun adı, zaman, gerekçe). İzin kanal × uygulama başına: none (onay yok), merchant (tacir / esnaf), opt_in (onaylı), opt_out (ret). Gönderilebilir = merchant ya da opt_in, adres var, bastırma listesinde değil. Her değişiklik değiştirilemez bir kanıt kaydı yazar (kaynak, zaman, form / ekran, kim, istemci adresinin özeti — adresin kendisi değil); izin vermek (opt_in, merchant) kanıt ister. Yanıt kişisel veri yankılamaz. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonUpsertContactRequest

Alan	Tip	Açıklama
`name`	`string`	null olabilir
`email`	`string`	null olabilir
`phone`	`string`	null olabilir
`mobile`	`string`	null olabilir
`landline`	`string`	null olabilir
`company`	`string`	null olabilir
`title`	`string`	null olabilir
`city`	`string`	null olabilir
`district`	`string`	null olabilir
`userId`	`string`	null olabilir
`locale`	`string`	null olabilir
`tags`	`string[]`	en çok 30 öğe
`consents`	`object`
`consents.email`	`ConsentChange`
`consents.sms`	`ConsentChange`
`listIds`	`string[]`	en çok 50 öğe

Örnek · JSON

{
  "name": "string",
  "email": "string",
  "phone": "string",
  "mobile": "string",
  "landline": "string",
  "company": "string",
  "title": "string",
  "city": "string",
  "district": "string",
  "userId": "string",
  "locale": "tr",
  "tags": [
    "string"
  ],
  "consents": {
    "email": {
      "kind": "none"
    },
    "sms": {
      "kind": "none"
    }
  },
  "listIds": [
    "01a1b249-9ed2-77e8-af53-0c99529e68cb"
  ]
}

Yanıtlar

200

Başarılı.

application/jsonUpsertContactResult

Örnek · JSON

{
  "contactId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "created": true,
  "consents": {
    "email": "none",
    "sms": "none"
  }
}

400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/contacts/erase

Kişiyi sil (KVKK)

Kişi ve şifreli değerleri silinir; izin kanıtı ve bastırma kör dizinle kalır. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonContactReference

Alan	Tip	Açıklama
`contactId`	`string`	Biçim: uuid
`email`	`string`	en çok 320 karakter
`phone`	`string`	en çok 40 karakter
`userId`	`string`	1–200 karakter

Örnek · JSON

{
  "contactId": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
  "email": "string",
  "phone": "string",
  "userId": "string"
}

Yanıtlar

200
Başarılı.
application/jsonEraseContactResult
Örnek · JSON
```
{
  "erased": 0
}
```
400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

GET/v1/apps/{appId}/messaging/lists

Listeler

Kapsam: messaging:read.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:read.

Kimlik: apiKey
Gerekli kapsam: messaging:read

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

Yanıtlar

200

Başarılı.

application/jsonContactListList

Örnek · JSON

{
  "items": [
    {
      "id": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "name": "string",
      "description": "string",
      "contacts": 0,
      "emailSendable": 0,
      "smsSendable": 0,
      "createdBy": "01a1b249-9ed2-77e8-af53-0c99529e68cb",
      "createdAt": "2026-11-06T14:46:00+03:00",
      "updatedAt": "2026-11-06T14:46:00+03:00"
    }
  ]
}

401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/lists/{listId}/members

Liste üyeliği

Kişiler kimlik, e-posta, telefon ya da kullanıcı kimliğiyle eklenir / çıkarılır; bulunamayanlar sayılır. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid
`listId`zorunlu	yol	`string`	Kişi listesinin kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonManagementListMembersRequest

Alan	Tip	Açıklama
`add`	`ContactReference[]`	en çok 1000 öğe · Varsayılan: []
`remove`	`ContactReference[]`	en çok 1000 öğe · Varsayılan: []

Örnek · JSON

{
  "add": [],
  "remove": []
}

Yanıtlar

200
Başarılı.
application/jsonListMembersResult
Örnek · JSON
```
{
  "added": 0,
  "removed": 0,
  "notFound": 0
}
```
400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

POST/v1/apps/{appId}/messaging/suppressions

Bastırma listesi

Bir adresi ya da numarayı bastırma listesine ekle / çıkar. Kapsam: messaging:write.

Management API anahtarı gerekir (Authorization: Bearer mk_…); işlem anahtarın organizasyonunda ve uygulama kapsamında tek bir RLS işleminde çalışır.

Gerekli kapsam: messaging:write.

Kimlik: apiKey
Gerekli kapsam: messaging:write

Parametreler

Ad	Yer	Tip	Açıklama
`appId`zorunlu	yol	`string`	Uygulamanın kimliği. Biçim: uuid

İstek gövdesiGövde zorunlu

application/jsonManagementSuppressionRequest

Alan	Tip	Açıklama
`channel`zorunlu	`string`	Değerler: email, sms
`email`	`string`	en çok 320 karakter
`phone`	`string`	en çok 40 karakter
`action`	`string`	Değerler: add, remove · Varsayılan: add
`reason`	`string`	Değerler: hard_bounce, complaint, unsubscribe, manual, invalid_address · Varsayılan: manual

Örnek · JSON

{
  "channel": "email",
  "email": "string",
  "phone": "string",
  "action": "add",
  "reason": "manual"
}

Yanıtlar

200
Başarılı.
application/jsonSuppressionResult
Örnek · JSON
```
{
  "suppressed": true,
  "channel": "email",
  "changed": true
}
```
400
İstek doğrulanamadı (VALIDATION_FAILED). error.fields her hatalı alan için isteğin dilinde mesajları taşır; alan yolu noktayla yazılır (properties.2.enumValues), gövdenin bütünü için _. Okunamayan JSON INVALID_REQUEST, bozuk imleç CURSOR_INVALID döner.
application/jsonErrorResponse
401
Kimlik yok ya da geçersiz: panelde oturum çerezi (SESSION_REQUIRED, ikinci adım bekleyen oturumda TWO_FACTOR_REQUIRED), Management API'de Authorization: Bearer mk_… (API_KEY_INVALID: yok, bilinmiyor, iptal edilmiş ya da süresi dolmuş). Giriş uçlarında hatalı bilgiler de 401 döner (INVALID_CREDENTIALS, TOTP_CODE_INVALID).
application/jsonErrorResponse
403
Yetki yok: rol gereken izni vermiyor (PERMISSION_REQUIRED, error.details.permissions), API anahtarının kapsamı eksik (API_KEY_SCOPE_MISSING, error.details.scopes) ya da organizasyon askıda (ORGANIZATION_SUSPENDED).
application/jsonErrorResponse
404
Kayıt bulunamadı ya da çağıranın kapsamında değil; ikisi bilerek ayırt edilmez (ör. APP_NOT_FOUND, EVENT_DEFINITION_NOT_FOUND). Biçimi geçersiz kimlikler de 404 döner.
application/jsonErrorResponse
409
Kaydın güncel durumu bu işleme izin vermiyor ya da aynı kayıt zaten var (ör. APP_SLUG_TAKEN, EVENT_NAME_TAKEN, LAST_OWNER).
application/jsonErrorResponse
422
İş kuralı ihlali. error.message kullanıcıya olduğu gibi gösterilebilir.
application/jsonErrorResponse
500
Beklenmeyen hata (INTERNAL_ERROR). Destek talebinde error.traceId iletilir.
application/jsonErrorResponse

Şemalar

İsteklerde ve yanıtlarda adıyla anılan şemalar.

`AccountEventobject`

AccountEvent
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`at`zorunlu	`Timestamp`	Biçim: date-time
`type`zorunlu	`string`	Değerler: track, page, screen, identify, group, alias
`eventName`zorunlu	`string`
`roles`zorunlu	`string[]`
`conversion`zorunlu	`boolean`
`revenue`zorunlu	`number`	null olabilir
`path`zorunlu	`string`	null olabilir
`sessionId`zorunlu	`string`	null olabilir
`properties`zorunlu	`object`	Serbest anahtarlar
`personId`zorunlu	`Id`	null olabilir

`AccountMemberobject`

AccountMember
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`userId`zorunlu	`string`	null olabilir
`firstSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`lastSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`firstChannel`zorunlu	`string`	null olabilir
`eventCount`zorunlu	`integer`
`sessionCount`zorunlu	`integer`
`isTest`zorunlu	`boolean`
`isInternal`zorunlu	`boolean`
`isBot`	`boolean`
`joinedAt`zorunlu	`Timestamp`	Biçim: date-time

`AccountProfileobject`

AccountProfile
Alan	Tip	Açıklama
`account`zorunlu	`AccountSummary`
`summary`zorunlu	`object`
`summary.members`zorunlu	`integer`
`summary.sessions`zorunlu	`integer`
`summary.events`zorunlu	`integer`
`summary.conversions`zorunlu	`integer`
`summary.revenue`zorunlu	`number`
`summary.refunds`zorunlu	`number`
`summary.netRevenue`zorunlu	`number`
`summary.currency`zorunlu	`string`
`summary.leads`zorunlu	`integer`	null olabilir
`roles`zorunlu	`string[]`
`members`zorunlu	`AccountMember[]`
`sessions`zorunlu	`SessionSummary[]`
`events`zorunlu	`AccountEvent[]`
`conversions`zorunlu	`PersonConversion[]`
`leads`zorunlu	`PersonLead`	null olabilir
`withheldTraits`zorunlu	`string[]`

`AccountSummaryobject`

AccountSummary
Alan	Tip	Açıklama
`groupId`zorunlu	`string`
`name`zorunlu	`string`	null olabilir
`traits`zorunlu	`object`	Serbest anahtarlar
`memberCount`zorunlu	`integer`
`firstSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`lastSeenAt`zorunlu	`Timestamp`	Biçim: date-time

`AdAccountobject`

AdAccount
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`platform`zorunlu	`string`
`externalId`zorunlu	`string`
`name`zorunlu	`string`
`currency`zorunlu	`string`
`timezone`zorunlu	`string`	null olabilir
`status`zorunlu	`string`	Değerler: active, disconnected
`connectionId`zorunlu	`Id`	null olabilir
`lastSyncedAt`zorunlu	`Timestamp`	null olabilir
`link`zorunlu	`string`	null olabilir

`AdCampaignobject`

AdCampaign
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`platform`zorunlu	`string`
`accountId`zorunlu	`Id`	Biçim: uuid
`accountName`zorunlu	`string`
`externalId`zorunlu	`string`
`name`zorunlu	`string`
`status`zorunlu	`string`	Değerler: active, paused, ended, removed, pending, unknown
`platformStatus`zorunlu	`string`	null olabilir
`objective`zorunlu	`string`	Değerler: awareness, traffic, engagement, leads, sales, app_promotion, video_views, search, other
`platformObjective`zorunlu	`string`	null olabilir
`channelType`zorunlu	`string`	null olabilir
`budget`zorunlu	`AdBudget`	null olabilir
`startDate`zorunlu	`LocalDate`	null olabilir
`endDate`zorunlu	`LocalDate`	null olabilir
`campaignGroup`zorunlu	`object`	null olabilir
`hasVideo`zorunlu	`boolean`
`adGroups`zorunlu	`integer`
`ads`zorunlu	`integer`
`link`zorunlu	`string`	null olabilir
`namingIssues`	`NamingIssue[]`

`AdConversionobject`

AdConversion
Alan	Tip	Açıklama
`eventId`zorunlu	`Id`	Biçim: uuid
`occurredAt`zorunlu	`Timestamp`	Biçim: date-time
`role`zorunlu	`string`	null olabilir
`furthestRole`zorunlu	`string`	null olabilir
`sold`zorunlu	`boolean`
`accountId`zorunlu	`string`	null olabilir
`personId`zorunlu	`Id`	null olabilir
`channel`zorunlu	`string`	null olabilir
`source`zorunlu	`string`	null olabilir
`medium`zorunlu	`string`	null olabilir
`platform`zorunlu	`string`	null olabilir
`adAccountId`zorunlu	`Id`	null olabilir
`campaignId`zorunlu	`Id`	null olabilir
`campaignName`zorunlu	`string`	null olabilir
`utmCampaign`zorunlu	`string`	null olabilir
`adId`zorunlu	`Id`	null olabilir
`adName`zorunlu	`string`	null olabilir
`landingPage`zorunlu	`string`	null olabilir
`resolution`zorunlu	`string`	Değerler: click_id, campaign_id, utm_name, unknown
`model`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`weight`zorunlu	`number`
`isTest`zorunlu	`boolean`
`lastClick`	`LeadLastClick`	null olabilir
`placement`	`string`	null olabilir

`AdConversionPageobject`

AdConversionPage
Alan	Tip	Açıklama
`items`zorunlu	`AdConversion[]`
`nextCursor`zorunlu	`string`	null olabilir
`total`zorunlu	`integer`
`conversions`zorunlu	`integer`
`sold`zorunlu	`integer`
`model`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`conversionRoles`zorunlu	`string[]`
`countingMode`zorunlu	`string`	Sabit: event_date

`AdConversionsListOptionsobject`

AdConversionsListOptions
Alan	Tip	Açıklama
`groupBy`zorunlu	`string`	Değerler: account, conversion · Varsayılan: account
`scope`zorunlu	`string`	Değerler: ads, all · Varsayılan: ads
`roles`	`string[]`	en çok 8 öğe

`AdConversionsListSectionobject`

AdConversionsListSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: ad_conversions_list
`groupBy`zorunlu	`string`	Değerler: account, conversion · Varsayılan: account
`scope`zorunlu	`string`	Değerler: ads, all · Varsayılan: ads
`roles`	`string[]`	en çok 8 öğe
`platforms`zorunlu	`string[]`	en çok 10 öğe · Varsayılan: []
`limit`zorunlu	`integer`	1–50 · Varsayılan: 25

`AdFunnelSectionobject`

AdFunnelSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: ad_funnel
`roles`	`string[]`	en çok 4 öğe
`platforms`zorunlu	`string[]`	en çok 10 öğe · Varsayılan: []

`AdsBudgetobject`

AdsBudget
Alan	Tip	Açıklama
`month`zorunlu	`string`
`currency`zorunlu	`string`
`daysInMonth`zorunlu	`integer`
`daysElapsed`zorunlu	`integer`
`tolerance`zorunlu	`number`
`total`zorunlu	`BudgetPacing`
`lines`zorunlu	`BudgetPacing[]`
`plans`zorunlu	`BudgetPlan[]`
`cumulative`zorunlu	`object[]`
`cumulative[].day`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`cumulative[].spend`zorunlu	`number`	null olabilir
`cumulative[].cumulative`zorunlu	`number`	null olabilir
`cumulative[].plan`zorunlu	`number`	null olabilir
`campaigns`zorunlu	`object[]`
`campaigns[].campaign`zorunlu	`AdCampaign`
`campaigns[].last7DaysSpend`zorunlu	`number`
`campaigns[].dailyAverage`zorunlu	`number`
`campaigns[].budgetUse`zorunlu	`number`	null olabilir
`campaigns[].lastDataDay`zorunlu	`LocalDate`	null olabilir

`AdsCampaignsobject`

AdsCampaigns
Alan	Tip	Açıklama
`metrics`zorunlu	`AnalyticsQueryResult`
`campaigns`zorunlu	`AdCampaign[]`
`unmatched`zorunlu	`AnalyticsQueryResult`
`counts`zorunlu	`object`
`counts.active`zorunlu	`integer`
`counts.paused`zorunlu	`integer`
`counts.ended`zorunlu	`integer`
`counts.all`zorunlu	`integer`
`naming`	`object`
`naming.hasTemplate`zorunlu	`boolean`
`naming.offTemplate`zorunlu	`integer`
`naming.followsTemplate`zorunlu	`integer`
`conversionRoles`zorunlu	`string[]`
`originalSpend`	`object`	Serbest anahtarlar
`conversionRates`	`object`
`conversionRates.minClicks`zorunlu	`integer`
`conversionRates.items`zorunlu	`object[]`
`conversionRates.items[].campaignId`zorunlu	`Id`	Biçim: uuid
`conversionRates.items[].adClicks`zorunlu	`number`
`conversionRates.items[].adConversions`zorunlu	`number`
`conversionRates.items[].rate`zorunlu	`number`	null olabilir

`AdsTableSectionobject`

AdsTableSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: ads_table
`level`zorunlu	`string`	Değerler: platform, account, campaign, ad_group, ad · Varsayılan: campaign
`metrics`	`string[]`	1–8 öğe
`platforms`zorunlu	`string[]`	en çok 10 öğe · Varsayılan: []
`limit`zorunlu	`integer`	1–50 · Varsayılan: 15
`conversions`	`AdConversionsListOptions`

`AiSummaryobject`

AiSummary
Alan	Tip	Açıklama
`status`zorunlu	`string`	Değerler: disabled, not_configured, pending, ready, failed
`locale`zorunlu	`string`	null olabilir
`text`zorunlu	`string`	null olabilir
`model`zorunlu	`string`	null olabilir
`generatedAt`zorunlu	`Timestamp`	null olabilir
`error`zorunlu	`string`	null olabilir

`AlertRecipientsobject`

AlertRecipients
Alan	Tip	Açıklama
`inApp`	`boolean`	Varsayılan: true
`userIds`	`string[]`	en çok 50 öğe · Varsayılan: []
`emails`	`string[]`	en çok 20 öğe · Varsayılan: []
`channelIds`	`string[]`	en çok 10 öğe · Varsayılan: []
`webPushUserIds`	`string[]`	en çok 50 öğe · Varsayılan: []

`AnalyticsCatalogueobject`

AnalyticsCatalogue
Alan	Tip	Açıklama
`metrics`zorunlu	`CatalogueMetric[]`
`dimensions`zorunlu	`CatalogueDimension[]`
`roles`zorunlu	`LabelledValue[]`
`conversionRoles`zorunlu	`string[]`
`compareModes`zorunlu	`string[]`
`filterOperators`zorunlu	`string[]`
`attributionModels`zorunlu	`object[]`
`attributionModels[].key`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionModels[].label`zorunlu	`string`
`attributionModels[].description`zorunlu	`string`
`defaultAttributionModel`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`zorunlu	`integer`
`revenueBasis`	`string`	Değerler: gross, net
`pricesIncludeTax`	`boolean`

`AnalyticsQueryResultobject`

AnalyticsQueryResult
Alan	Tip	Açıklama
`metrics`zorunlu	`QueryMetricMeta[]`
`dimensions`zorunlu	`string[]`
`rows`zorunlu	`QueryRow[]`
`totals`zorunlu	`object`
`totals.values`zorunlu	`QueryValues`
`totals.deltas`zorunlu	`QueryDeltas`	null olabilir
`comparison`zorunlu	`object`	null olabilir
`meta`zorunlu	`QueryMeta`

`AnalyticsSegmentobject`

AnalyticsSegment
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`subject`zorunlu	`string`	Değerler: person, account
`rules`zorunlu	`object`
`rules.match`zorunlu	`string`	Değerler: all, any
`rules.conditions`zorunlu	`object[]`
`lastCount`zorunlu	`integer`	null olabilir
`lastCountedAt`zorunlu	`Timestamp`	null olabilir
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`Appobject`

App
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`slug`zorunlu	`string`
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`websiteUrl`zorunlu	`string`	null olabilir
`iconUrl`zorunlu	`string`	null olabilir
`timezone`zorunlu	`string`
`currency`zorunlu	`string`
`schemaMode`zorunlu	`string`	Değerler: strict, lenient, discover
`schemaRevision`zorunlu	`integer`	en az 0
`attributionModel`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`zorunlu	`integer`
`conversionRoles`zorunlu	`string[]`
`leadContactClicks`zorunlu	`boolean`
`retention`zorunlu	`AppRetention`
`internalIpRanges`zorunlu	`string[]`
`internalCookie`zorunlu	`string`	null olabilir
`revenueBasis`	`string`	Değerler: gross, net
`pricesIncludeTax`	`boolean`
`overviewTiles`	`OverviewTile[]`
`adsKpis`	`string[]`
`modules`	`string[]`
`defaultAlertRecipients`	`AppAlertRecipients`
`searchBrandTerms`	`string[]`
`defaultOverviewTiles`	`OverviewTile[]`
`defaultAdsKpis`	`string[]`
`status`zorunlu	`string`	Değerler: active, archived
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`AttributedTouchobject`

AttributedTouch
Alan	Tip	Açıklama
`sessionId`zorunlu	`string`	null olabilir
`at`zorunlu	`string`	null olabilir
`channel`zorunlu	`string`	null olabilir
`source`zorunlu	`string`	null olabilir
`medium`zorunlu	`string`	null olabilir
`campaign`zorunlu	`string`	null olabilir
`resolution`zorunlu	`string`	Değerler: click_id, campaign_id, utm_name, unknown
`weight`zorunlu	`number`

`AttributionSectionobject`

AttributionSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: attribution
`metric`zorunlu	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter · Varsayılan: conversions
`dimension`zorunlu	`string`	Değerler: attributed_channel, attributed_source, attributed_medium, attributed_campaign · Varsayılan: attributed_channel
`models`zorunlu	`string[]`	2–7 öğe · Varsayılan: ["first_touch","last_touch","last_non_direct","linear","position_based","time_decay","last_paid"]
`limit`zorunlu	`integer`	1–20 · Varsayılan: 8

`Autocaptureobject`

Autocapture
Alan	Tip	Açıklama
`pageviews`zorunlu	`boolean`
`pageleave`zorunlu	`boolean`
`clicks`zorunlu	`boolean`
`rageClicks`zorunlu	`boolean`
`deadClicks`zorunlu	`boolean`
`scroll`zorunlu	`boolean`
`errors`zorunlu	`boolean`
`forms`zorunlu	`boolean`
`layout`zorunlu	`boolean`
`outboundLinks`zorunlu	`boolean`
`downloads`zorunlu	`boolean`
`webVitals`zorunlu	`boolean`

`BudgetPacingobject`

BudgetPacing
Alan	Tip	Açıklama
`platform`zorunlu	`string`	null olabilir
`adAccountId`zorunlu	`Id`	null olabilir
`budget`zorunlu	`number`	null olabilir
`spent`zorunlu	`number`
`remaining`zorunlu	`number`	null olabilir
`used`zorunlu	`number`	null olabilir
`expectedToDate`zorunlu	`number`	null olabilir
`dailyAverage`zorunlu	`number`
`requiredDaily`zorunlu	`number`	null olabilir
`forecast`zorunlu	`number`
`forecastRatio`zorunlu	`number`	null olabilir
`activeDailyBudgets`zorunlu	`number`
`state`zorunlu	`string`	Değerler: on_track, over, behind, no_budget

`BudgetPlanobject`

BudgetPlan
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`month`zorunlu	`string`
`platform`zorunlu	`string`	null olabilir
`adAccountId`zorunlu	`Id`	null olabilir
`amount`zorunlu	`number`
`currency`zorunlu	`string`
`note`zorunlu	`string`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`createdBy`zorunlu	`Id`	null olabilir
`supersededAt`zorunlu	`Timestamp`	null olabilir

`CampaignCountsobject`

CampaignCounts
Alan	Tip	Açıklama
`recipients`zorunlu	`integer`
`queued`zorunlu	`integer`
`sending`zorunlu	`integer`
`sent`zorunlu	`integer`
`delivered`zorunlu	`integer`
`failed`zorunlu	`integer`
`bounced`zorunlu	`integer`
`unknown`zorunlu	`integer`
`skipped`zorunlu	`integer`
`opened`zorunlu	`integer`
`clicked`zorunlu	`integer`
`complained`zorunlu	`integer`
`unsubscribed`zorunlu	`integer`

`CampaignResultsobject`

CampaignResults
Alan	Tip	Açıklama
`campaignId`zorunlu	`Id`	Biçim: uuid
`channel`zorunlu	`string`	Değerler: email, sms
`status`zorunlu	`string`	Değerler: draft, awaiting_approval, scheduled, sending, paused, sent, cancelled, failed
`counts`zorunlu	`CampaignCounts`
`metrics`zorunlu	`object`	Serbest anahtarlar
`progress`zorunlu	`number`	null olabilir
`utm`zorunlu	`object`
`utm.source`zorunlu	`string`
`utm.medium`zorunlu	`string`
`utm.campaign`zorunlu	`string`
`traffic`zorunlu	`object`
`traffic.from`zorunlu	`LocalDate`	null olabilir
`traffic.to`zorunlu	`LocalDate`	null olabilir
`traffic.sessions`zorunlu	`number`	null olabilir
`traffic.conversions`zorunlu	`number`	null olabilir
`traffic.conversionsByRole`zorunlu	`object`	Serbest anahtarlar
`traffic.revenue`zorunlu	`number`	null olabilir
`traffic.countingMode`zorunlu	`string`	Sabit: event_date
`countingMode`zorunlu	`string`	Sabit: cohort
`unavailable`zorunlu	`object`	Serbest anahtarlar
`segment`	`object`	null olabilir

`CatalogueMetricobject`

CatalogueMetric
Alan	Tip	Açıklama
`key`zorunlu	`string`
`label`zorunlu	`string`
`description`zorunlu	`string`
`unit`zorunlu	`string`	Değerler: count, duration_ms, percent, currency, ratio, number
`goodDirection`zorunlu	`string`	Değerler: higher, lower, neutral
`aggregation`zorunlu	`string`	Değerler: sum, distinct, ratio, last
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`formula`zorunlu	`object`
`formula.numerator`zorunlu	`string`
`formula.denominator`zorunlu	`string`	null olabilir
`formula.scale`zorunlu	`number`
`tables`zorunlu	`string[]`
`dimensions`zorunlu	`string[]`
`parameter`zorunlu	`object`	null olabilir
`custom`zorunlu	`boolean`
`definitionId`zorunlu	`Id`	null olabilir

`Connectionobject`

Connection
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`provider`zorunlu	`string`	Değerler: google_ads, meta_ads, linkedin_ads, tiktok_ads, yandex_direct, chatgpt_ads, ga4, search_console, manual_import, instagram, facebook_pages, linkedin_pages
`kind`zorunlu	`string`	Değerler: ads, analytics, search_console, social
`authType`zorunlu	`string`	Değerler: oauth2, api_key, none
`mode`zorunlu	`string`	Değerler: live, fake
`label`zorunlu	`string`	null olabilir
`scopes`zorunlu	`string[]`
`syncIntervalMinutes`zorunlu	`integer`
`lookbackDays`zorunlu	`integer`
`backfillDays`zorunlu	`integer`
`health`zorunlu	`ConnectionHealth`
`accounts`zorunlu	`ConnectionAccount[]`
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`ConnectionAccountobject`

ConnectionAccount
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`kind`zorunlu	`string`	Değerler: ad_account, ga4_property, search_console_site, social_account
`externalId`zorunlu	`string`
`name`zorunlu	`string`
`currency`zorunlu	`string`	null olabilir
`timezone`zorunlu	`string`	null olabilir
`platformStatus`zorunlu	`string`	null olabilir
`selected`zorunlu	`boolean`

`ConnectionHealthobject`

ConnectionHealth
Alan	Tip	Açıklama
`status`zorunlu	`string`	Değerler: active, needs_reauth, error, rate_limited, paused
`lastSuccessAt`zorunlu	`Timestamp`	null olabilir
`lastRunAt`zorunlu	`Timestamp`	null olabilir
`lastRunStatus`zorunlu	`string`	null olabilir
`lastError`zorunlu	`ConnectorError`	null olabilir
`consecutiveFailures`zorunlu	`integer`
`nextRunAt`zorunlu	`Timestamp`	null olabilir
`syncedUntil`zorunlu	`string`	null olabilir
`tokenExpiresAt`zorunlu	`Timestamp`	null olabilir

`ConnectorErrorobject`

ConnectorError
Alan	Tip	Açıklama
`code`zorunlu	`string`	Değerler: auth_failed, permission_missing, rate_limited, provider_error, network_error, timeout, invalid_response, not_configured, secret_unavailable
`message`zorunlu	`string`

`ConsentChangeobject`

ConsentChange
Alan	Tip	Açıklama
`kind`zorunlu	`string`	Değerler: none, merchant, opt_in, opt_out
`reason`	`string`	null olabilir
`evidence`	`string`	null olabilir
`form`	`string`	null olabilir
`occurredAt`	`string`	Biçim: date-time

`ContactListobject`

ContactList
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`contacts`zorunlu	`integer`
`emailSendable`zorunlu	`integer`
`smsSendable`zorunlu	`integer`
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`ContentCalendarSectionobject`

ContentCalendarSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: content_calendar
`sources`zorunlu	`string[]`	1–2 öğe · Varsayılan: ["social","blog"]
`platforms`zorunlu	`string[]`	en çok 3 öğe · Varsayılan: []
`limit`zorunlu	`integer`	1–100 · Varsayılan: 50

`CreateAppRequestobject`

CreateAppRequest
Alan	Tip	Açıklama
`slug`zorunlu	`string`	Desen: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 karakter
`name`zorunlu	`string`	1–200 karakter
`description`	`string`	null olabilir
`websiteUrl`	`string`	null olabilir
`iconUrl`	`string`	null olabilir
`timezone`	`string`	en çok 64 karakter
`currency`	`string`	Desen: `^[A-Z]{3}$`
`schemaMode`	`string`	Değerler: strict, lenient, discover · Varsayılan: lenient
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid · Varsayılan: last_non_direct
`attributionWindowDays`	`integer`	1–365 · Varsayılan: 90
`conversionRoles`	`string[]`	1–16 öğe · Varsayılan: ["signup","trial_start","lead","demo_request","purchase"]
`leadContactClicks`	`boolean`	Varsayılan: false
`retention`	`object`
`retention.eventsMonths`zorunlu	`integer`	1–120
`retention.interactionsMonths`zorunlu	`integer`	1–60
`retention.sessionsMonths`zorunlu	`integer`	1–120
`internalIpRanges`	`string[]`	en çok 100 öğe · Varsayılan: []
`internalCookie`	`string`	null olabilir
`revenueBasis`	`string`	Değerler: gross, net · Varsayılan: gross
`pricesIncludeTax`	`boolean`	Varsayılan: true
`overviewTiles`	`OverviewTileRequest[]`	en çok 12 öğe · Varsayılan: []
`adsKpis`	`string[]`	en çok 12 öğe · Varsayılan: []
`modules`	`string[]`	en çok 6 öğe · Varsayılan: ["ads","social","messaging","content","leads","behavior"]
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	en çok 50 öğe · Varsayılan: []

`CreateDeletionRequestobject`

CreateDeletionRequest
Alan	Tip	Açıklama
`subjectKind`zorunlu	`string`	Kimliğin türü: ürünün kullanıcı kimliği (`user_id`), SDK'nın anonim kimliği (`anonymous_id`) ya da Postlip Metrics'in kişi kimliği (`person_id`). Değerler: user_id, anonymous_id, person_id
`subjectValue`zorunlu	`string`	Kimliğin değeri (en çok 200 karakter). E-posta ya da telefon gibi görünen kimlik alımdaki gibi özetlenerek aranır; değer talep bitene kadar tutulur. 1–200 karakter
`note`	`string`	Neden (talep numarası, başvurunun kanalı); kişisel veri yazmayın. En çok 500 karakter. null olabilir

`CreateEventDefinitionRequestobject`

CreateEventDefinitionRequest
Alan	Tip	Açıklama
`name`zorunlu	`string`	1–200 karakter
`displayName`zorunlu	`string`	1–200 karakter
`description`	`string`	null olabilir
`category`	`string`	null olabilir
`roles`	`string[]`	en çok 16 öğe · Varsayılan: []
`status`	`string`	Değerler: draft, active, deprecated, blocked · Varsayılan: active
`aliases`	`string[]`	en çok 20 öğe · Varsayılan: []
`properties`	`PropertyDefinitionInput[]`	en çok 200 öğe
`displayNames`	`LocalizedNames`

`CreateInvitationRequestobject`

CreateInvitationRequest
Alan	Tip	Açıklama
`email`zorunlu	`string`	1–320 karakter
`roleId`zorunlu	`string`	Biçim: uuid
`appScope`	`string`	Değerler: all, selected · Varsayılan: all
`appIds`	`string[]`	en çok 200 öğe · Varsayılan: []

`CreateMessageCampaignRequestobject`

CreateMessageCampaignRequest
Alan	Tip	Açıklama
`channel`zorunlu	`string`	Değerler: email, sms
`name`zorunlu	`string`	1–200 karakter
`templateId`	`string`	Biçim: uuid
`templateKey`	`string`	en çok 80 karakter
`subject`	`string`	null olabilir
`preheader`	`string`	null olabilir
`body`	`string`	en çok 20000 karakter
`senderId`	`string`	null olabilir
`audience`	`object`
`audience.listIds`	`string[]`	en çok 20 öğe · Varsayılan: []
`audience.segmentId`	`string`	null olabilir
`locale`	`string`	Değerler: tr, en
`throttlePerMinute`	`integer`	null olabilir
`utmSource`	`string`	1–100 karakter

`CreateSourceRequestobject`

CreateSourceRequest
Alan	Tip	Açıklama
`name`zorunlu	`string`	1–200 karakter
`kind`zorunlu	`string`	Değerler: web, ios, android, server, other
`environment`	`string`	Değerler: production, staging, development · Varsayılan: production
`requireSignature`	`boolean`	Varsayılan: false
`allowedOrigins`	`string[]`	en çok 100 öğe · Varsayılan: []
`consentMode`	`string`	Değerler: required, implied, none · Varsayılan: required
`excludedPaths`	`string[]`	en çok 200 öğe · Varsayılan: []
`maskSelectors`	`string[]`	en çok 100 öğe · Varsayılan: []
`ignoreSelectors`	`string[]`	en çok 100 öğe · Varsayılan: []
`stripQueryParams`	`string[]`	en çok 100 öğe · Varsayılan: []
`sessionTimeoutMinutes`	`integer`	5–240 · Varsayılan: 30
`interactionSampleRate`	`number`	0–1 · Varsayılan: 1
`autocapture`	`object`	Varsayılan: {}
`autocapture.pageviews`	`boolean`
`autocapture.pageleave`	`boolean`
`autocapture.clicks`	`boolean`
`autocapture.rageClicks`	`boolean`
`autocapture.deadClicks`	`boolean`
`autocapture.scroll`	`boolean`
`autocapture.errors`	`boolean`
`autocapture.forms`	`boolean`
`autocapture.layout`	`boolean`
`autocapture.outboundLinks`	`boolean`
`autocapture.downloads`	`boolean`
`autocapture.webVitals`	`boolean`
`dataLayerEvents`	`string[]`	en çok 100 öğe · Varsayılan: []

`CreatedSourceKeyobject`

CreatedSourceKey
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`kind`zorunlu	`string`	Değerler: write, signing
`mode`zorunlu	`string`	Değerler: live, test
`maskedKey`zorunlu	`string`
`displayPrefix`zorunlu	`string`
`last4`zorunlu	`string`
`state`zorunlu	`string`	Değerler: active, expiring, revoked
`revokedAt`zorunlu	`Timestamp`	null olabilir
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`key`zorunlu	`string`

`DateRangeobject`

DateRange
Alan	Tip	Açıklama
`from`zorunlu	`string`
`to`zorunlu	`string`
`alignment`	`string`	Değerler: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year

`DeletionRequestobject`

DeletionRequest
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`appId`zorunlu	`Id`	Biçim: uuid
`subjectKind`zorunlu	`string`	Kimliğin türü (`user_id`, `anonymous_id`, `person_id`). Değerler: user_id, anonymous_id, person_id
`subjectHint`zorunlu	`string`	Kimliğin son karakterleri («…7c1e»); değerin kendisi hiçbir zaman dönmez.
`status`zorunlu	`string`	`pending` sırada, `running` yürütülüyor, `completed` bitti, `failed` üç denemeden sonra başarısız (`errorCode`), `cancelled` iptal edildi. Değerler: pending, running, completed, failed, cancelled
`note`zorunlu	`string`	Talebi açanın notu. null olabilir
`requestedVia`zorunlu	`string`	Talebin geldiği yer: panel ya da Management API. Değerler: panel, api
`requestedBy`zorunlu	`object`	Talebi açan üye (adı üye dizininden); API anahtarıyla açıldıysa `null`. null olabilir
`result`zorunlu	`object`	Silinen satırlar türüne göre (`events`, `sessions`, `persons`, `identities`, `interactions`, `accountMemberships`, `attributions`, `leads`, `milestones`, `deliveries`, `contacts`); sürerken o ana kadar. Serbest anahtarlar
`errorCode`zorunlu	`string`	Başarısız talebin hata kodu. null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`startedAt`zorunlu	`Timestamp`	Worker'ın talebi ilk aldığı an; bu andan sonra alınan veri talebe girmez. null olabilir
`completedAt`zorunlu	`Timestamp`	Talebin bittiği ya da iptal edildiği an. null olabilir
`nothingFound`zorunlu	`boolean`	Talep tamamlandı ama kimliğe ait veri yoktu.

`DraftMetricDefinitionobject`

DraftMetricDefinition
Alan	Tip	Açıklama
`key`zorunlu	`string`	Desen: `^[a-z][a-z0-9_]{1,49}$` · 1–50 karakter
`name`	`string`	1–200 karakter
`kind`zorunlu	`string`	Değerler: event_count, unique_persons, property_sum, property_average, ratio, unique_accounts
`eventName`	`string`	1–200 karakter
`role`	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`property`	`string`	Desen: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 karakter
`filters`	`QueryFilterInput[]`	en çok 10 öğe · Varsayılan: []
`numerator`	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`denominator`	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`unit`	`string`	Değerler: count, duration_ms, percent, currency, ratio, number
`goodDirection`	`string`	Değerler: higher, lower, neutral · Varsayılan: higher

`ErrorResponseobject`

ErrorResponse
Alan	Tip	Açıklama
`error`zorunlu	`object`
`error.code`zorunlu	`string`
`error.message`zorunlu	`string`
`error.fields`	`object`	Serbest anahtarlar
`error.details`	`object`	Serbest anahtarlar
`error.retryAfterSeconds`	`integer`
`error.traceId`zorunlu	`string`

`EventDefinitionobject`

EventDefinition
Alan	Tip	Açıklama
`name`zorunlu	`string`	Desen: `^(?!\$)[^\s\x00-\x1f][^\x00-\x1f]{0,199}$`
`displayName`zorunlu	`string`	en çok 200 karakter
`description`	`string`	en çok 2000 karakter
`category`	`string`	en çok 100 karakter
`roles`zorunlu	`string[]`
`status`zorunlu	`string`	Değerler: draft, active, deprecated, blocked
`aliases`	`string[]`
`version`zorunlu	`integer`	0 üstü
`properties`zorunlu	`PropertyDefinition[]`

`EventDefinitionRecordobject`

EventDefinitionRecord
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`appId`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`displayName`zorunlu	`string`
`displayNames`	`LocalizedNamesRecord`
`description`zorunlu	`string`	null olabilir
`category`zorunlu	`string`	null olabilir
`roles`zorunlu	`string[]`
`status`zorunlu	`string`	Değerler: draft, active, deprecated, blocked
`aliases`zorunlu	`string[]`
`version`zorunlu	`integer`	0 üstü
`propertyCount`zorunlu	`integer`	en az 0
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time
`properties`zorunlu	`PropertyDefinitionRecord[]`

`EventDefinitionSummaryobject`

EventDefinitionSummary
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`appId`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`displayName`zorunlu	`string`
`displayNames`	`LocalizedNamesRecord`
`description`zorunlu	`string`	null olabilir
`category`zorunlu	`string`	null olabilir
`roles`zorunlu	`string[]`
`status`zorunlu	`string`	Değerler: draft, active, deprecated, blocked
`aliases`zorunlu	`string[]`
`version`zorunlu	`integer`	0 üstü
`propertyCount`zorunlu	`integer`	en az 0
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`ForecastAllocationobject`

ForecastAllocation
Alan	Tip	Açıklama
`monthlyBudget`zorunlu	`number`
`channels`zorunlu	`object[]`
`channels[].platform`zorunlu	`string`
`channels[].label`zorunlu	`string`
`channels[].current`zorunlu	`number`
`channels[].suggested`zorunlu	`number`
`channels[].change`zorunlu	`number`
`channels[].marginalCpaCurrent`zorunlu	`number`	null olabilir
`channels[].marginalCpaSuggested`zorunlu	`number`	null olabilir
`channels[].bound`zorunlu	`string`	null olabilir
`paidCurrent`zorunlu	`number`
`paidSuggested`zorunlu	`number`
`gain`zorunlu	`number`

`ForecastChannelBasisobject`

ForecastChannelBasis
Alan	Tip	Açıklama
`platform`zorunlu	`string`
`label`zorunlu	`string`
`status`zorunlu	`string`	Değerler: ok, insufficient_history, no_spend
`reason`zorunlu	`string`	null olabilir
`spend`zorunlu	`number`
`conversions`zorunlu	`number`
`spendPerDay`zorunlu	`number`
`conversionsPerDay`zorunlu	`number`
`cpa`zorunlu	`number`	null olabilir
`elasticity`zorunlu	`number`	null olabilir
`elasticitySource`zorunlu	`string`	null olabilir
`rSquared`zorunlu	`number`	null olabilir
`weeks`zorunlu	`integer`
`weeksWithSpend`zorunlu	`integer`
`maxSpendPerDay`zorunlu	`number`
`plannedMonthlyBudget`zorunlu	`number`	null olabilir
`marginalCpa`zorunlu	`number`	null olabilir

`ForecastInputsobject`

ForecastInputs
Alan	Tip	Açıklama
`horizonMonths`zorunlu	`integer`	1–12 · Varsayılan: 6
`basisDays`zorunlu	`integer`	28–365 · Varsayılan: 90
`funnelId`zorunlu	`string`	Varsayılan: null · null olabilir
`role`	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`budgets`zorunlu	`ForecastBudget[]`	en çok 20 öğe · Varsayılan: []
`totalMonthlyBudget`	`number`	0–10000000000
`elasticityMode`zorunlu	`string`	Değerler: estimate, fixed · Varsayılan: estimate
`elasticity`zorunlu	`number`	0.05–1 · Varsayılan: 0.75
`scenarios`zorunlu	`ForecastScenarioParams[]`	1–5 öğe · Varsayılan: [{"key":"bad","label":null,"costMultiplier":1.25,"conversionMultiplier":0.85,"organicMultiplier":0.5},{"key":"realistic","label":null,"costMultiplier":1,"conversionMultiplier":1,"organicMultiplier":1},{"key":"good","label":null,"costMultiplier":0.85,"conversionMultiplier":1.12,"organicMultiplier":1.4}]
`goalMonthlyConversions`	`number`	0–1000000000
`includeOrganic`zorunlu	`boolean`	Varsayılan: true
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`seasonality`	`boolean`

`ForecastLagobject`

ForecastLag
Alan	Tip	Açıklama
`p50Days`zorunlu	`number`	null olabilir
`p75Days`zorunlu	`number`	null olabilir
`p90Days`zorunlu	`number`	null olabilir
`distribution`zorunlu	`object[]`
`distribution[].upToDays`zorunlu	`number`	null olabilir
`distribution[].share`zorunlu	`number`

`ForecastMonthobject`

ForecastMonth
Alan	Tip	Açıklama
`month`zorunlu	`string`
`days`zorunlu	`integer`
`budget`zorunlu	`number`
`budgetByPlatform`zorunlu	`object`	Serbest anahtarlar
`paid`zorunlu	`ForecastBand`
`organic`zorunlu	`ForecastBand`
`total`zorunlu	`ForecastBand`
`steps`zorunlu	`object[]`
`steps[].role`zorunlu	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`steps[].value`zorunlu	`ForecastBand`
`revenue`zorunlu	`ForecastBand`	null olabilir
`cpa`zorunlu	`number`	null olabilir
`cac`zorunlu	`number`	null olabilir

`ForecastResultobject`

ForecastResult
Alan	Tip	Açıklama
`appId`zorunlu	`Id`	Biçim: uuid
`currency`zorunlu	`string`
`timezone`zorunlu	`string`
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time
`method`zorunlu	`object`
`method.key`zorunlu	`string`	Sabit: log_log_bootstrap
`method.description`zorunlu	`string`
`method.assumptions`zorunlu	`string[]`
`basis`zorunlu	`object`
`basis.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`basis.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`basis.days`zorunlu	`integer`
`basis.role`zorunlu	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`basis.attributionModel`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`basis.countingModes`zorunlu	`object`
`basis.countingModes.channels`zorunlu	`string`	Değerler: event_date, cohort
`basis.countingModes.steps`zorunlu	`string`	Değerler: event_date, cohort
`basis.channels`zorunlu	`ForecastChannelBasis[]`
`basis.organic`zorunlu	`object`
`basis.organic.conversions`zorunlu	`number`
`basis.organic.perDay`zorunlu	`number`
`basis.organic.trendPerMonth`zorunlu	`number`	null olabilir
`basis.steps`zorunlu	`object[]`
`basis.steps[].role`zorunlu	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`basis.steps[].rate`zorunlu	`number`	null olabilir
`basis.steps[].lagDays`zorunlu	`number`	null olabilir
`basis.steps[].lag`	`ForecastLag`	null olabilir
`basis.revenuePerConversion`zorunlu	`number`	null olabilir
`basis.elasticityPrior`zorunlu	`number`
`basis.seasonality`	`ForecastSeasonality`	null olabilir
`basis.unforecastable`	`object`
`basis.unforecastable.spend`zorunlu	`number`
`basis.unforecastable.share`zorunlu	`number`	null olabilir
`basis.unforecastable.platforms`zorunlu	`string[]`
`scenarios`zorunlu	`ForecastScenarioResult[]`
`goal`zorunlu	`object`	null olabilir
`allocation`	`ForecastAllocation`	null olabilir
`warnings`zorunlu	`object[]`
`warnings[].code`zorunlu	`string`	Değerler: EXTRAPOLATION, ELASTICITY_ASSUMED, NO_TREND, STEP_RATES_UNKNOWN, NEW_CHANNEL, GOAL_UNREACHABLE, DATA_DELAYED, SEASONALITY_OFF, UNFORECASTABLE_SPEND
`warnings[].message`zorunlu	`string`
`warnings[].platform`zorunlu	`string`	null olabilir

`ForecastScenarioobject`

ForecastScenario
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`appId`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`inputs`zorunlu	`ForecastInputs`
`result`zorunlu	`ForecastResult`	null olabilir
`computedAt`zorunlu	`Timestamp`	null olabilir
`actuals`zorunlu	`object[]`	null olabilir
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`ForecastScenarioListobject`

ForecastScenarioList
Alan	Tip	Açıklama
`items`zorunlu	`object[]`
`items[].id`zorunlu	`Id`	Biçim: uuid
`items[].appId`zorunlu	`Id`	Biçim: uuid
`items[].name`zorunlu	`string`
`items[].description`zorunlu	`string`	null olabilir
`items[].inputs`zorunlu	`ForecastInputs`
`items[].computedAt`zorunlu	`Timestamp`	null olabilir
`items[].createdBy`zorunlu	`Id`	null olabilir
`items[].createdAt`zorunlu	`Timestamp`	Biçim: date-time
`items[].updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`ForecastScenarioParamsobject`

ForecastScenarioParams
Alan	Tip	Açıklama
`key`zorunlu	`string`	Desen: `^[a-z][a-z0-9_]{0,29}$` · 1–30 karakter
`label`	`string`	null olabilir
`costMultiplier`zorunlu	`number`	0.1–5
`conversionMultiplier`zorunlu	`number`	0.1–5
`organicMultiplier`zorunlu	`number`	0–5

`ForecastScenarioResultobject`

ForecastScenarioResult
Alan	Tip	Açıklama
`key`zorunlu	`string`
`label`zorunlu	`string`
`costMultiplier`zorunlu	`number`
`conversionMultiplier`zorunlu	`number`
`organicMultiplier`zorunlu	`number`
`months`zorunlu	`ForecastMonth[]`
`totals`zorunlu	`object`
`totals.budget`zorunlu	`number`
`totals.paid`zorunlu	`ForecastBand`
`totals.organic`zorunlu	`ForecastBand`
`totals.total`zorunlu	`ForecastBand`
`totals.steps`zorunlu	`object[]`
`totals.steps[].role`zorunlu	`string`	Değerler: signup, login, trial_start, trial_end, activation, core_action, lead, demo_request, contact_click, checkout_start, payment_failed, purchase, subscription_renewal, refund, churn, referral
`totals.steps[].value`zorunlu	`ForecastBand`
`totals.revenue`zorunlu	`ForecastBand`	null olabilir
`totals.cpa`	`number`	null olabilir
`totals.cac`	`number`	null olabilir
`totals.cacRole`	`string`	null olabilir

`ForecastSeasonalityobject`

ForecastSeasonality
Alan	Tip	Açıklama
`weekday`zorunlu	`number[]`	null olabilir
`month`zorunlu	`number[]`	null olabilir
`historyDays`zorunlu	`integer`
`conversions`zorunlu	`number`
`minimum`zorunlu	`object`
`minimum.weekdayDays`zorunlu	`integer`
`minimum.months`zorunlu	`integer`
`minimum.conversions`zorunlu	`integer`

`ForecastSectionobject`

ForecastSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: forecast
`scenarioId`zorunlu	`string`	Varsayılan: null · null olabilir
`horizonMonths`zorunlu	`integer`	1–12 · Varsayılan: 3
`scenario`zorunlu	`string`	Desen: `^[a-z][a-z0-9_]{0,29}$` · 1–30 karakter · Varsayılan: realistic

`Funnelobject`

Funnel
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`steps`zorunlu	`FunnelStepRecord[]`
`order`zorunlu	`string`	Değerler: ordered, any_order
`countBy`zorunlu	`string`	Değerler: person, session, group
`conversionWindow`zorunlu	`object`	null olabilir
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`isDefault`zorunlu	`boolean`
`sideMetrics`	`FunnelSideMetricRecord[]`
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`FunnelBreakdownRowobject`

FunnelBreakdownRow
Alan	Tip	Açıklama
`value`zorunlu	`string`	null olabilir
`steps`zorunlu	`object[]`
`steps[].count`zorunlu	`integer`
`steps[].ofFirst`zorunlu	`number`	null olabilir
`steps[].ofPrevious`zorunlu	`number`	null olabilir

`FunnelCohortsobject`

FunnelCohorts
Alan	Tip	Açıklama
`funnel`zorunlu	`object`
`funnel.id`zorunlu	`Id`	Biçim: uuid
`funnel.name`zorunlu	`string`
`funnel.countBy`zorunlu	`string`	Değerler: person, session, group
`basis`zorunlu	`string`	Sabit: entry_week
`countingMode`zorunlu	`string`	Sabit: cohort
`dateRange`zorunlu	`object`
`dateRange.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`timezone`zorunlu	`string`
`followedUntil`zorunlu	`Timestamp`	Biçim: date-time
`step`zorunlu	`integer`
`weeks`zorunlu	`integer`
`minSubjects`zorunlu	`integer`
`include`zorunlu	`object`
`include.test`zorunlu	`boolean`
`include.internal`zorunlu	`boolean`
`include.bot`zorunlu	`boolean`
`cohorts`zorunlu	`object[]`
`cohorts[].week`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`cohorts[].start`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`cohorts[].end`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`cohorts[].entered`zorunlu	`integer`
`cohorts[].lowSample`zorunlu	`boolean`
`cohorts[].cells`zorunlu	`object[]`
`cohorts[].cells[].week`zorunlu	`integer`
`cohorts[].cells[].reached`zorunlu	`integer`
`cohorts[].cells[].rate`zorunlu	`number`	null olabilir
`cohorts[].cells[].complete`zorunlu	`boolean`
`total`zorunlu	`object[]`
`total[].week`zorunlu	`integer`
`total[].entered`zorunlu	`integer`
`total[].reached`zorunlu	`integer`
`total[].rate`zorunlu	`number`	null olabilir
`freshness`	`QueryFreshness`
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time

`FunnelResultobject`

FunnelResult
Alan	Tip	Açıklama
`funnel`zorunlu	`object`
`funnel.id`zorunlu	`Id`	null olabilir
`funnel.name`zorunlu	`string`	null olabilir
`funnel.order`zorunlu	`string`	Değerler: ordered, any_order
`funnel.countBy`zorunlu	`string`	Değerler: person, session, group
`funnel.conversionWindow`zorunlu	`object`	null olabilir
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`dateRange`zorunlu	`object`
`dateRange.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`timezone`zorunlu	`string`
`followedUntil`zorunlu	`Timestamp`	Biçim: date-time
`include`zorunlu	`object`
`include.test`zorunlu	`boolean`
`include.internal`zorunlu	`boolean`
`include.bot`zorunlu	`boolean`
`steps`zorunlu	`FunnelStepResult[]`
`breakdown`zorunlu	`object`	null olabilir
`extraBreakdown`	`object`	null olabilir
`warnings`zorunlu	`object[]`
`warnings[].code`zorunlu	`string`	Değerler: ATTRIBUTION_NOT_CONVERSION, BREAKDOWN_TRUNCATED
`warnings[].message`zorunlu	`string`
`series`	`FunnelSeries`	null olabilir
`sideMetrics`	`FunnelSideMetricResult[]`
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time

`FunnelScreenResultobject`

FunnelScreenResult
Alan	Tip	Açıklama
`funnel`zorunlu	`object`
`funnel.id`zorunlu	`Id`	null olabilir
`funnel.name`zorunlu	`string`	null olabilir
`funnel.order`zorunlu	`string`	Değerler: ordered, any_order
`funnel.countBy`zorunlu	`string`	Değerler: person, session, group
`funnel.conversionWindow`zorunlu	`object`	null olabilir
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`dateRange`zorunlu	`object`
`dateRange.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`timezone`zorunlu	`string`
`followedUntil`zorunlu	`Timestamp`	Biçim: date-time
`include`zorunlu	`object`
`include.test`zorunlu	`boolean`
`include.internal`zorunlu	`boolean`
`include.bot`zorunlu	`boolean`
`steps`zorunlu	`FunnelStepResult[]`
`breakdown`zorunlu	`object`	null olabilir
`extraBreakdown`	`object`	null olabilir
`warnings`zorunlu	`object[]`
`warnings[].code`zorunlu	`string`	Değerler: ATTRIBUTION_NOT_CONVERSION, BREAKDOWN_TRUNCATED
`warnings[].message`zorunlu	`string`
`series`	`FunnelSeries`	null olabilir
`sideMetrics`	`FunnelSideMetricResult[]`
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time
`freshness`zorunlu	`QueryFreshness`
`comparison`zorunlu	`object`	null olabilir

`FunnelSectionobject`

FunnelSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: funnel
`funnelId`zorunlu	`string`	Varsayılan: null · null olabilir
`countingMode`	`string`	Değerler: event_date, cohort
`breakdown`	`string`	Değerler: channel, source, medium, campaign, device_type, country, attributed_channel, attributed_source, attributed_campaign, os, browser, region, app_version, language, channel_group

`FunnelSeriesobject`

FunnelSeries
Alan	Tip	Açıklama
`granularity`zorunlu	`string`	Değerler: day, week, month
`basis`zorunlu	`string`	Değerler: step_date, entry_date
`points`zorunlu	`object[]`
`points[].date`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`points[].start`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`points[].end`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`points[].steps`zorunlu	`integer[]`
`points[].complete`	`boolean`
`points[].beforeTracking`	`boolean`
`afterRange`zorunlu	`integer[]`

`FunnelSideMetricRecordobject`

FunnelSideMetricRecord
Alan	Tip	Açıklama
`event`zorunlu	`string`	null olabilir
`role`zorunlu	`string`	null olabilir
`filters`zorunlu	`PropertyFilterRecord[]`
`label`zorunlu	`string`	null olabilir
`without`zorunlu	`object`	null olabilir

`FunnelSideMetricResultobject`

FunnelSideMetricResult
Alan	Tip	Açıklama
`index`zorunlu	`integer`
`label`zorunlu	`string`	null olabilir
`event`zorunlu	`string`	null olabilir
`role`zorunlu	`string`	null olabilir
`count`zorunlu	`integer`
`ofEntered`zorunlu	`number`	null olabilir
`pending`zorunlu	`integer`	null olabilir
`withinDays`zorunlu	`integer`	null olabilir

`FunnelStepResultobject`

FunnelStepResult
Alan	Tip	Açıklama
`index`zorunlu	`integer`
`label`zorunlu	`string`	null olabilir
`event`zorunlu	`string`	null olabilir
`role`zorunlu	`string`	null olabilir
`count`zorunlu	`integer`
`ofFirst`zorunlu	`number`	null olabilir
`ofPrevious`zorunlu	`number`	null olabilir
`dropOff`zorunlu	`integer`	null olabilir
`timeFromPrevious`zorunlu	`TimeToConvert`	null olabilir
`timeFromFirst`zorunlu	`TimeToConvert`	null olabilir

`Invitationobject`

Invitation
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`email`zorunlu	`string`
`role`zorunlu	`RoleSummary`
`appScope`zorunlu	`string`	Değerler: all, selected
`appIds`zorunlu	`Id[]`
`status`zorunlu	`string`	Değerler: pending, accepted, revoked, expired
`invitedBy`zorunlu	`Id`	null olabilir
`expiresAt`zorunlu	`Timestamp`	Biçim: date-time
`acceptedAt`zorunlu	`Timestamp`	null olabilir
`revokedAt`zorunlu	`Timestamp`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time

`KpiSectionobject`

KpiSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: kpi
`metric`zorunlu	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`spark`zorunlu	`boolean`	Varsayılan: true
`filters`zorunlu	`QueryFilter[]`	en çok 10 öğe · Varsayılan: []
`segmentId`	`string`	null olabilir

`Leadobject`

Lead
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`kind`zorunlu	`string`	Değerler: demo_request, lead, contact_click
`status`zorunlu	`string`	Değerler: new, contacted, qualified, won, lost, spam
`stage`	`string`
`dueAt`	`Timestamp`	null olabilir
`overdue`	`boolean`
`statusReason`zorunlu	`string`	null olabilir
`assignee`zorunlu	`LeadAssignee`	null olabilir
`eventId`zorunlu	`Id`	Biçim: uuid
`eventName`zorunlu	`string`
`occurredAt`zorunlu	`Timestamp`	Biçim: date-time
`personId`zorunlu	`Id`	null olabilir
`userId`zorunlu	`string`	null olabilir
`groupId`zorunlu	`string`	null olabilir
`source`zorunlu	`LeadSource`
`attribution`zorunlu	`LeadAttribution`	null olabilir
`lastClick`	`LeadLastClick`	null olabilir
`properties`zorunlu	`object`	Serbest anahtarlar
`isTest`zorunlu	`boolean`
`isInternal`zorunlu	`boolean`
`noteCount`zorunlu	`integer`
`statusChangedAt`zorunlu	`Timestamp`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`LeadAttributionobject`

LeadAttribution
Alan	Tip	Açıklama
`model`zorunlu	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`windowDays`zorunlu	`integer`
`firstTouch`zorunlu	`AttributedTouch`	null olabilir
`lastTouch`zorunlu	`AttributedTouch`	null olabilir
`lastNonDirect`zorunlu	`AttributedTouch`	null olabilir
`method`	`string`	null olabilir

`LeadDetailobject`

LeadDetail
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`kind`zorunlu	`string`	Değerler: demo_request, lead, contact_click
`status`zorunlu	`string`	Değerler: new, contacted, qualified, won, lost, spam
`stage`	`string`
`dueAt`	`Timestamp`	null olabilir
`overdue`	`boolean`
`statusReason`zorunlu	`string`	null olabilir
`assignee`zorunlu	`LeadAssignee`	null olabilir
`eventId`zorunlu	`Id`	Biçim: uuid
`eventName`zorunlu	`string`
`occurredAt`zorunlu	`Timestamp`	Biçim: date-time
`personId`zorunlu	`Id`	null olabilir
`userId`zorunlu	`string`	null olabilir
`groupId`zorunlu	`string`	null olabilir
`source`zorunlu	`LeadSource`
`attribution`zorunlu	`LeadAttribution`	null olabilir
`lastClick`	`LeadLastClick`	null olabilir
`properties`zorunlu	`object`	Serbest anahtarlar
`isTest`zorunlu	`boolean`
`isInternal`zorunlu	`boolean`
`noteCount`zorunlu	`integer`
`statusChangedAt`zorunlu	`Timestamp`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time
`notes`zorunlu	`LeadNote[]`
`statusHistory`zorunlu	`LeadStatusChange[]`

`LeadLastClickobject`

LeadLastClick
Alan	Tip	Açıklama
`at`zorunlu	`Timestamp`	Biçim: date-time
`path`zorunlu	`string`	null olabilir
`selector`zorunlu	`string`	null olabilir
`label`zorunlu	`string`	null olabilir
`kind`zorunlu	`string`	null olabilir
`section`zorunlu	`string`	null olabilir
`contact`zorunlu	`string`	null olabilir
`tag`	`string`	null olabilir
`href`	`string`	null olabilir

`LeadSourceobject`

LeadSource
Alan	Tip	Açıklama
`sessionId`zorunlu	`string`	null olabilir
`channel`zorunlu	`string`	null olabilir
`source`zorunlu	`string`	null olabilir
`medium`zorunlu	`string`	null olabilir
`campaign`zorunlu	`string`	null olabilir
`referrerHost`zorunlu	`string`	null olabilir
`entryPath`zorunlu	`string`	null olabilir
`pagePath`zorunlu	`string`	null olabilir
`deviceType`zorunlu	`string`	null olabilir
`country`zorunlu	`string`	null olabilir

`LeadStatusChangeobject`

LeadStatusChange
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`from`zorunlu	`string`	null olabilir
`to`zorunlu	`string`	Değerler: new, contacted, qualified, won, lost, spam
`fromStage`	`string`	null olabilir
`toStage`	`string`	null olabilir
`reason`zorunlu	`string`	null olabilir
`changedBy`zorunlu	`LeadAssignee`	null olabilir
`changedAt`zorunlu	`Timestamp`	Biçim: date-time

`ManagementConsentRequestobject`

ManagementConsentRequest
Alan	Tip	Açıklama
`contactId`	`string`	Biçim: uuid
`email`	`string`	en çok 320 karakter
`phone`	`string`	en çok 40 karakter
`userId`	`string`	1–200 karakter
`channel`zorunlu	`string`	Değerler: email, sms
`kind`zorunlu	`string`	Değerler: none, merchant, opt_in, opt_out
`reason`	`string`	null olabilir
`evidence`	`string`	null olabilir
`form`	`string`	null olabilir
`occurredAt`	`string`	Biçim: date-time

`ManagementSuppressionRequestobject`

ManagementSuppressionRequest
Alan	Tip	Açıklama
`channel`zorunlu	`string`	Değerler: email, sms
`email`	`string`	en çok 320 karakter
`phone`	`string`	en çok 40 karakter
`action`	`string`	Değerler: add, remove · Varsayılan: add
`reason`	`string`	Değerler: hard_bounce, complaint, unsubscribe, manual, invalid_address · Varsayılan: manual

`Memberobject`

Member
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`user`zorunlu	`object`
`user.id`zorunlu	`Id`	Biçim: uuid
`user.email`zorunlu	`string`
`user.name`zorunlu	`string`
`role`zorunlu	`RoleSummary`
`appScope`zorunlu	`string`	Değerler: all, selected
`appIds`zorunlu	`Id[]`
`status`zorunlu	`string`	Değerler: active, disabled
`invitedBy`zorunlu	`Id`	null olabilir
`lastSignInAt`	`Timestamp`	null olabilir
`twoFactorEnabled`	`boolean`
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`MessageCampaignobject`

MessageCampaign
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`channel`zorunlu	`string`	Değerler: email, sms
`name`zorunlu	`string`
`slug`zorunlu	`string`
`utm`zorunlu	`object`
`utm.source`zorunlu	`string`
`utm.medium`zorunlu	`string`
`utm.campaign`zorunlu	`string`
`templateId`zorunlu	`Id`	null olabilir
`subject`zorunlu	`string`	null olabilir
`preheader`zorunlu	`string`	null olabilir
`body`zorunlu	`string`
`senderId`zorunlu	`Id`	null olabilir
`audience`zorunlu	`object`
`audience.listIds`zorunlu	`Id[]`
`audience.segmentId`zorunlu	`Id`	null olabilir
`locale`zorunlu	`string`	Değerler: tr, en
`status`zorunlu	`string`	Değerler: draft, awaiting_approval, scheduled, sending, paused, sent, cancelled, failed
`schedule`zorunlu	`object`	null olabilir
`start`zorunlu	`object`	null olabilir
`throttlePerMinute`zorunlu	`integer`	null olabilir
`confirmation`zorunlu	`object`
`confirmation.testSentAt`zorunlu	`Timestamp`	null olabilir
`confirmation.testSentBy`zorunlu	`Id`	null olabilir
`confirmation.testCurrent`zorunlu	`boolean`
`confirmation.confirmedAt`zorunlu	`Timestamp`	null olabilir
`confirmation.confirmedBy`zorunlu	`Id`	null olabilir
`approval`zorunlu	`object`	null olabilir
`counts`zorunlu	`CampaignCounts`
`skippedByReason`zorunlu	`object`	Serbest anahtarlar
`progress`zorunlu	`number`	null olabilir
`errorCode`zorunlu	`string`	null olabilir
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time
`startedAt`zorunlu	`Timestamp`	null olabilir
`finishedAt`zorunlu	`Timestamp`	null olabilir

`MessageCampaignPageobject`

MessageCampaignPage
Alan	Tip	Açıklama
`items`zorunlu	`MessageCampaign[]`
`nextCursor`zorunlu	`string`	null olabilir
`total`zorunlu	`integer`

`NamingIssueobject`

NamingIssue
Alan	Tip	Açıklama
`code`zorunlu	`string`	Değerler: missing_prefix, too_few_parts, too_many_parts, empty_part, value_not_allowed, invalid_date, too_long, invalid_characters, test_in_live_name
`severity`zorunlu	`string`	Değerler: error, warning
`token`zorunlu	`string`	null olabilir
`position`zorunlu	`integer`	null olabilir
`value`zorunlu	`string`	null olabilir
`expected`zorunlu	`string[]`	null olabilir

`NoteSectionobject`

NoteSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: note
`text`zorunlu	`string`	1–4000 karakter
`format`	`string`	Değerler: plain, markdown

`OverviewTileRequestobject`

OverviewTileRequest
Alan	Tip	Açıklama
`metric`zorunlu	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`breakdown`	`string`	Varsayılan: null · null olabilir

`PersonConversionobject`

PersonConversion
Alan	Tip	Açıklama
`eventId`zorunlu	`Id`	Biçim: uuid
`at`zorunlu	`Timestamp`	Biçim: date-time
`eventName`zorunlu	`string`
`roles`zorunlu	`string[]`
`revenue`zorunlu	`number`	null olabilir
`sessionId`zorunlu	`string`	null olabilir
`channel`zorunlu	`string`	null olabilir
`lastClick`	`string`	null olabilir

`PersonEventobject`

PersonEvent
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`at`zorunlu	`Timestamp`	Biçim: date-time
`type`zorunlu	`string`	Değerler: track, page, screen, identify, group, alias
`eventName`zorunlu	`string`
`roles`zorunlu	`string[]`
`conversion`zorunlu	`boolean`
`revenue`zorunlu	`number`	null olabilir
`path`zorunlu	`string`	null olabilir
`sessionId`zorunlu	`string`	null olabilir
`properties`zorunlu	`object`	Serbest anahtarlar

`PersonLeadobject`

PersonLead
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`kind`zorunlu	`string`	Değerler: demo_request, lead, contact_click
`status`zorunlu	`string`	Değerler: new, contacted, qualified, won, lost, spam
`eventName`zorunlu	`string`
`eventAt`zorunlu	`Timestamp`	Biçim: date-time

`PersonProfileobject`

PersonProfile
Alan	Tip	Açıklama
`requestedId`zorunlu	`Id`	Biçim: uuid
`person`zorunlu	`object`
`person.id`zorunlu	`Id`	Biçim: uuid
`person.userId`zorunlu	`string`	null olabilir
`person.traits`zorunlu	`object`	Serbest anahtarlar
`person.firstSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`person.lastSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`person.firstChannel`zorunlu	`string`	null olabilir
`person.firstTouch`zorunlu	`PersonTouch`	null olabilir
`person.lastNonDirectTouch`zorunlu	`PersonTouch`	null olabilir
`person.eventCount`zorunlu	`integer`
`person.sessionCount`zorunlu	`integer`
`person.isTest`zorunlu	`boolean`
`person.isInternal`zorunlu	`boolean`
`person.mergedFrom`zorunlu	`Id[]`
`identities`zorunlu	`object[]`
`identities[].kind`zorunlu	`string`	Değerler: anonymous_id, user_id
`identities[].value`zorunlu	`string`
`identities[].firstSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`groups`zorunlu	`object[]`
`groups[].groupId`zorunlu	`string`
`groups[].traits`zorunlu	`object`	Serbest anahtarlar
`groups[].memberCount`zorunlu	`integer`
`groups[].firstSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`groups[].lastSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`roles`zorunlu	`string[]`
`sessions`zorunlu	`SessionSummary[]`
`events`zorunlu	`PersonEvent[]`
`summary`	`object`
`summary.sessions`zorunlu	`integer`
`summary.events`zorunlu	`integer`
`summary.conversions`zorunlu	`integer`
`summary.revenue`zorunlu	`number`
`summary.refunds`zorunlu	`number`
`summary.netRevenue`zorunlu	`number`
`summary.currency`zorunlu	`string`
`summary.leads`zorunlu	`integer`	null olabilir
`conversions`	`PersonConversion[]`
`leads`	`PersonLead`	null olabilir
`merges`	`PersonMerge[]`
`withheldTraits`	`string[]`

`PersonSummaryobject`

PersonSummary
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`userId`zorunlu	`string`	null olabilir
`firstSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`lastSeenAt`zorunlu	`Timestamp`	Biçim: date-time
`firstChannel`zorunlu	`string`	null olabilir
`eventCount`zorunlu	`integer`
`sessionCount`zorunlu	`integer`
`isTest`zorunlu	`boolean`
`isInternal`zorunlu	`boolean`
`isBot`	`boolean`

`PropertyDefinitionobject`

PropertyDefinition
Alan	Tip	Açıklama
`key`zorunlu	`string`	Desen: `^[A-Za-z_][A-Za-z0-9_]{0,99}$`
`type`zorunlu	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`required`zorunlu	`boolean`
`description`	`string`	en çok 1000 karakter
`piiClass`zorunlu	`string`	Değerler: none, pseudonymous, personal, sensitive
`piiAction`zorunlu	`string`	Değerler: allow, hash, drop, reject
`enumValues`	`string[]`	en çok 500 öğe
`maxLength`	`integer`	0 üstü, en çok 10000
`minimum`	`number`
`maximum`	`number`
`example`	`any`

`PropertyDefinitionInputobject`

PropertyDefinitionInput
Alan	Tip	Açıklama
`key`zorunlu	`string`	Desen: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 karakter
`type`zorunlu	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	null olabilir
`required`	`boolean`	Varsayılan: false
`description`	`string`	null olabilir
`piiClass`	`string`	Değerler: none, pseudonymous, personal, sensitive · Varsayılan: none
`piiAction`	`string`	Değerler: allow, hash, drop, reject · Varsayılan: allow
`enumValues`	`string[]`	null olabilir
`maxLength`	`integer`	null olabilir
`minimum`	`number`	null olabilir
`maximum`	`number`	null olabilir
`example`	`any`
`displayNames`	`LocalizedNames`

`PropertyDefinitionRecordobject`

PropertyDefinitionRecord
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`scope`zorunlu	`string`	Değerler: event, trait, group_trait
`key`zorunlu	`string`
`type`zorunlu	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`zorunlu	`string`	null olabilir
`required`zorunlu	`boolean`
`description`zorunlu	`string`	null olabilir
`piiClass`zorunlu	`string`	Değerler: none, pseudonymous, personal, sensitive
`piiAction`zorunlu	`string`	Değerler: allow, hash, drop, reject
`enumValues`zorunlu	`string[]`	null olabilir
`maxLength`zorunlu	`integer`	null olabilir
`minimum`zorunlu	`number`	null olabilir
`maximum`zorunlu	`number`	null olabilir
`example`zorunlu	`any`
`sortOrder`zorunlu	`integer`
`displayNames`	`LocalizedNamesRecord`
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`PropertyFilterRecordobject`

PropertyFilterRecord
Alan	Tip	Açıklama
`property`zorunlu	`string`
`op`zorunlu	`string`	Değerler: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty, gt, gte, lt, lte
`value`zorunlu	`string \| number \| boolean \| string[]`	null olabilir

`QueryApiRequestobject`

QueryApiRequest
Alan	Tip	Açıklama
`appId`zorunlu	`string`	Biçim: uuid
`metrics`zorunlu	`string[]`	1–20 öğe
`dimensions`	`string[]`	en çok 3 öğe · Varsayılan: []
`filters`	`QueryFilterInput[]`	en çok 20 öğe · Varsayılan: []
`dateRange`zorunlu	`DateRange`
`compare`	`string`	Değerler: none, previous_period, previous_year, custom · Varsayılan: none
`compareRange`	`DateRange`
`include`	`TrafficInclude`
`granularity`	`string`	Değerler: day, week, month
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`orderBy`	`object`
`orderBy.metric`zorunlu	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`orderBy.direction`	`string`	Değerler: asc, desc · Varsayılan: desc
`limit`	`integer`	1–10000 · Varsayılan: 1000
`segmentId`	`string`	Biçim: uuid
`definitions`	`DraftMetricDefinition[]`	en çok 5 öğe

`QueryBucketobject`

QueryBucket
Alan	Tip	Açıklama
`start`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`end`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`days`zorunlu	`integer`
`complete`zorunlu	`boolean`
`beforeTracking`zorunlu	`boolean`

`QueryDeltaobject`

QueryDelta
Alan	Tip	Açıklama
`previous`zorunlu	`number`	null olabilir
`absolute`zorunlu	`number`	null olabilir
`relative`zorunlu	`number`	null olabilir
`mode`zorunlu	`string`	Değerler: relative, absolute, points
`direction`zorunlu	`string`	Değerler: up, down, flat
`tone`zorunlu	`string`	Değerler: positive, negative, neutral
`comparable`zorunlu	`boolean`
`reason`zorunlu	`string`	null olabilir

`QueryFilterobject`

QueryFilter
Alan	Tip	Açıklama
`dimension`zorunlu	`string`	Desen: `^(?:[a-z][a-z_]{1,30}\|property:[A-Za-z_][A-Za-z0-9_]{0,99})$` · 1–120 karakter
`op`zorunlu	`string`	Değerler: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty
`value`	`string \| string[]`

`QueryFilterInputobject`

QueryFilterInput
Alan	Tip	Açıklama
`dimension`zorunlu	`string`	Desen: `^(?:[a-z][a-z_]{1,30}\|property:[A-Za-z_][A-Za-z0-9_]{0,99})$` · 1–120 karakter
`op`zorunlu	`string`	Değerler: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty
`value`	`string \| string[]`

`QueryFilterRecordobject`

QueryFilterRecord
Alan	Tip	Açıklama
`dimension`zorunlu	`string`
`op`zorunlu	`string`	Değerler: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty
`value`zorunlu	`string \| string[]`	null olabilir

`QueryFreshnessobject`

QueryFreshness
Alan	Tip	Açıklama
`processedUntil`zorunlu	`Timestamp`	null olabilir
`lastEventReceivedAt`zorunlu	`Timestamp`	null olabilir
`upToDate`zorunlu	`boolean`
`updatedAt`zorunlu	`Timestamp`	null olabilir
`pendingRollupDays`zorunlu	`integer`

`QueryMetaobject`

QueryMeta
Alan	Tip	Açıklama
`appId`zorunlu	`Id`	Biçim: uuid
`timezone`zorunlu	`string`
`currency`zorunlu	`string`
`dateRange`zorunlu	`object`
`dateRange.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`compare`zorunlu	`string`	Değerler: none, previous_period, previous_year, custom
`comparisonRange`zorunlu	`object`	null olabilir
`include`zorunlu	`object`
`include.test`zorunlu	`boolean`
`include.internal`zorunlu	`boolean`
`include.bot`zorunlu	`boolean`
`trackingStartedOn`zorunlu	`LocalDate`	null olabilir
`freshness`zorunlu	`QueryFreshness`
`countingModes`zorunlu	`object`	Serbest anahtarlar
`sources`zorunlu	`object`	Serbest anahtarlar
`conversionRoles`zorunlu	`string[]`
`attribution`zorunlu	`object`	null olabilir
`warnings`zorunlu	`QueryWarning[]`
`truncated`zorunlu	`boolean`
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time
`segment`	`object`	null olabilir

`QueryMetricMetaobject`

QueryMetricMeta
Alan	Tip	Açıklama
`key`zorunlu	`string`
`unit`zorunlu	`string`	Değerler: count, duration_ms, percent, currency, ratio, number
`goodDirection`zorunlu	`string`	Değerler: higher, lower, neutral
`aggregation`zorunlu	`string`	Değerler: sum, distinct, ratio, last
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`source`zorunlu	`string`	Değerler: rollup, raw, none
`label`	`string`

`QueryRowobject`

QueryRow
Alan	Tip	Açıklama
`dimensions`zorunlu	`object`	Serbest anahtarlar
`values`zorunlu	`QueryValues`
`bucket`zorunlu	`QueryBucket`	null olabilir
`previous`zorunlu	`QueryValues`	null olabilir
`previousBucket`zorunlu	`object`	null olabilir
`deltas`zorunlu	`QueryDeltas`	null olabilir
`shares`	`QueryValues`

`QueryWarningobject`

QueryWarning
Alan	Tip	Açıklama
`code`zorunlu	`string`	Değerler: DIMENSION_NOT_AVAILABLE, FILTER_NOT_AVAILABLE, COMPARISON_BEFORE_TRACKING, RANGE_BEFORE_TRACKING, ROWS_TRUNCATED, ROLLUP_PENDING, ATTRIBUTION_PENDING, CURRENCY_PENDING, SOCIAL_METRIC_NOT_PROVIDED, SOCIAL_PERIOD_NOT_AVAILABLE, SOCIAL_HISTORY_LIMITED, SOCIAL_PERMISSION_MISSING, SOCIAL_NOT_CONNECTED, SOCIAL_NOT_ADDITIVE, GA4_NOT_CONNECTED, SEARCH_CONSOLE_NOT_CONNECTED
`message`zorunlu	`string`
`metric`zorunlu	`string`	null olabilir
`dimension`zorunlu	`string`	null olabilir

`Reportobject`

Report
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`appIds`zorunlu	`Id[]`
`apps`zorunlu	`object[]`
`apps[].id`zorunlu	`Id`	Biçim: uuid
`apps[].slug`zorunlu	`string`
`apps[].name`zorunlu	`string`
`apps[].timezone`zorunlu	`string`
`apps[].currency`zorunlu	`string`
`sections`zorunlu	`ReportSection[]`
`period`zorunlu	`ReportPeriod`
`compare`zorunlu	`string`	Değerler: none, previous_period, previous_year
`filters`zorunlu	`QueryFilterRecord[]`
`segmentId`	`Id`	null olabilir
`include`zorunlu	`object`
`include.test`zorunlu	`boolean`
`include.internal`zorunlu	`boolean`
`include.bot`zorunlu	`boolean`
`attributionModel`zorunlu	`string`	null olabilir
`locale`zorunlu	`string`	Değerler: tr, en
`timezone`zorunlu	`string`
`subtitle`zorunlu	`string`	null olabilir
`templateKey`zorunlu	`string`	null olabilir
`lastSnapshot`zorunlu	`object`	null olabilir
`schedules`zorunlu	`integer`
`shareLinks`zorunlu	`object`
`shareLinks.active`zorunlu	`integer`
`shareLinks.total`zorunlu	`integer`
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`ReportCalendarobject`

ReportCalendar
Alan	Tip	Açıklama
`items`zorunlu	`ReportCalendarItem[]`
`total`zorunlu	`integer`
`counts`zorunlu	`object`
`counts.published`zorunlu	`integer`
`counts.planned`zorunlu	`integer`
`counts.blog`zorunlu	`integer`

`ReportCalendarItemobject`

ReportCalendarItem
Alan	Tip	Açıklama
`kind`zorunlu	`string`	Değerler: social_planned, social_direct, blog
`postId`zorunlu	`Id`	null olabilir
`date`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`time`zorunlu	`string`
`at`zorunlu	`Timestamp`	Biçim: date-time
`platform`zorunlu	`string`	null olabilir
`status`zorunlu	`string`
`format`zorunlu	`string`	null olabilir
`excerpt`zorunlu	`string`
`permalink`zorunlu	`string`	null olabilir
`campaignKey`zorunlu	`string`	null olabilir

`ReportFreshnessobject`

ReportFreshness
Alan	Tip	Açıklama
`appId`zorunlu	`Id`	Biçim: uuid
`processedUntil`zorunlu	`Timestamp`	null olabilir
`lastEventReceivedAt`zorunlu	`Timestamp`	null olabilir
`upToDate`zorunlu	`boolean`
`pendingRollupDays`zorunlu	`integer`
`adsSyncedAt`zorunlu	`Timestamp`	null olabilir

`ReportMetricLabelobject`

ReportMetricLabel
Alan	Tip	Açıklama
`key`zorunlu	`string`
`label`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`unit`zorunlu	`string`	Değerler: count, duration_ms, percent, currency, ratio, number
`goodDirection`zorunlu	`string`	Değerler: higher, lower, neutral
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`source`	`string`	Değerler: metrics, ad_platform, ga4, search_console, social_platform, messaging, mixed
`sources`	`string[]`

`ReportSectionResultobject`

ReportSectionResult
Alan	Tip	Açıklama
`id`zorunlu	`string`
`type`zorunlu	`string`	Değerler: kpi, timeseries, table, funnel, attribution, ads_table, ad_funnel, summary, note, ad_conversions_list, content_calendar, forecast
`title`zorunlu	`string`
`subtitle`zorunlu	`string`	null olabilir
`size`zorunlu	`string`	Değerler: kpi, half, full
`definition`zorunlu	`ReportSection`
`metrics`zorunlu	`ReportMetricLabel[]`
`countingModes`zorunlu	`string[]`
`text`zorunlu	`string`	null olabilir
`blocks`	`ReportNoteBlock`	null olabilir
`dataDelayHint`	`SectionDataDelay`	null olabilir
`apps`zorunlu	`SectionAppResult[]`

`ReportSnapshotobject`

ReportSnapshot
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`reportId`zorunlu	`Id`	null olabilir
`name`zorunlu	`string`
`subtitle`zorunlu	`string`	null olabilir
`trigger`zorunlu	`string`	Değerler: manual, schedule, api, preview
`period`zorunlu	`object`
`period.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`period.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`period.preset`zorunlu	`string`	null olabilir
`comparison`zorunlu	`object`	null olabilir
`timezone`zorunlu	`string`
`locale`zorunlu	`string`	Değerler: tr, en
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time
`createdBy`zorunlu	`Id`	null olabilir
`scheduleId`zorunlu	`Id`	null olabilir
`apps`zorunlu	`object[]`
`apps[].id`zorunlu	`Id`	Biçim: uuid
`apps[].slug`zorunlu	`string`
`apps[].name`zorunlu	`string`
`apps[].timezone`zorunlu	`string`
`apps[].currency`zorunlu	`string`
`filters`zorunlu	`QueryFilterRecord[]`
`include`zorunlu	`object`
`include.test`zorunlu	`boolean`
`include.internal`zorunlu	`boolean`
`include.bot`zorunlu	`boolean`
`attributionModel`zorunlu	`string`	null olabilir
`freshness`zorunlu	`ReportFreshness[]`
`sections`zorunlu	`ReportSectionResult[]`
`aiSummary`zorunlu	`AiSummary`

`ReportSnapshotSummaryobject`

ReportSnapshotSummary
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`reportId`zorunlu	`Id`	null olabilir
`name`zorunlu	`string`
`subtitle`zorunlu	`string`	null olabilir
`trigger`zorunlu	`string`	Değerler: manual, schedule, api, preview
`period`zorunlu	`object`
`period.from`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`period.to`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`period.preset`zorunlu	`string`	null olabilir
`comparison`zorunlu	`object`	null olabilir
`timezone`zorunlu	`string`
`locale`zorunlu	`string`	Değerler: tr, en
`generatedAt`zorunlu	`Timestamp`	Biçim: date-time
`createdBy`zorunlu	`Id`	null olabilir
`scheduleId`zorunlu	`Id`	null olabilir
`aiSummaryStatus`zorunlu	`string`	Değerler: disabled, not_configured, pending, ready, failed

`Roleobject`

Role
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`key`zorunlu	`string`
`name`zorunlu	`string`
`description`zorunlu	`string`	null olabilir
`permissions`zorunlu	`string[]`
`builtIn`zorunlu	`boolean`
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`RoleSummaryobject`

RoleSummary
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`key`zorunlu	`string`
`name`zorunlu	`string`
`builtIn`zorunlu	`boolean`

`SchemaBundleobject`

SchemaBundle
Alan	Tip	Açıklama
`formatVersion`zorunlu	`number`	Sabit: 1
`app`zorunlu	`object`
`app.id`zorunlu	`string`
`app.slug`zorunlu	`string`
`app.name`zorunlu	`string`
`schemaMode`zorunlu	`string`	Değerler: strict, lenient, discover
`revision`zorunlu	`integer`	en az 0
`generatedAt`zorunlu	`string`	Biçim: date-time
`events`zorunlu	`EventDefinition[]`
`traits`zorunlu	`PropertyDefinition[]`
`groupTraits`zorunlu	`PropertyDefinition[]`

`SectionAppResultobject`

SectionAppResult
Alan	Tip	Açıklama
`appId`zorunlu	`Id`	Biçim: uuid
`status`zorunlu	`string`	Değerler: ok, not_available, not_connected, failed
`message`zorunlu	`string`	null olabilir
`results`zorunlu	`object`	Serbest anahtarlar
`funnel`zorunlu	`FunnelResult`	null olabilir
`labels`zorunlu	`object`	Serbest anahtarlar
`lines`zorunlu	`string[]`
`derived`zorunlu	`SectionDerived`
`conversions`	`object`
`conversions.items`zorunlu	`AdConversion[]`
`conversions.total`zorunlu	`integer`
`conversions.sold`zorunlu	`integer`
`calendar`	`ReportCalendar`
`forecast`	`ReportForecast`

`SectionDataDelayobject`

SectionDataDelay
Alan	Tip	Açıklama
`days`zorunlu	`integer`
`sources`zorunlu	`object[]`
`sources[].source`zorunlu	`string`	Değerler: metrics, ad_platform, ga4, search_console, social_platform, messaging
`sources[].days`zorunlu	`integer`
`affectsPeriod`zorunlu	`boolean`
`text`zorunlu	`string`

`SessionSummaryobject`

SessionSummary
Alan	Tip	Açıklama
`id`zorunlu	`string`
`personId`zorunlu	`Id`	null olabilir
`anonymousId`zorunlu	`string`	null olabilir
`userId`zorunlu	`string`	null olabilir
`startedAt`zorunlu	`Timestamp`	Biçim: date-time
`endedAt`zorunlu	`Timestamp`	Biçim: date-time
`durationMs`zorunlu	`integer`
`activeMs`zorunlu	`integer`
`pageviews`zorunlu	`integer`
`screenViews`zorunlu	`integer`
`events`zorunlu	`integer`
`interactions`zorunlu	`integer`
`rageClicks`zorunlu	`integer`
`deadClicks`zorunlu	`integer`
`errors`zorunlu	`integer`
`entryPath`zorunlu	`string`	null olabilir
`exitPath`zorunlu	`string`	null olabilir
`channel`zorunlu	`string`	null olabilir
`source`zorunlu	`string`	null olabilir
`medium`zorunlu	`string`	null olabilir
`campaign`zorunlu	`string`	null olabilir
`referrerHost`zorunlu	`string`	null olabilir
`deviceType`zorunlu	`string`	null olabilir
`os`zorunlu	`string`	null olabilir
`browser`zorunlu	`string`	null olabilir
`country`zorunlu	`string`	null olabilir
`region`zorunlu	`string`	null olabilir
`city`zorunlu	`string`	null olabilir
`isEngaged`zorunlu	`boolean`
`isBounce`zorunlu	`boolean`
`roles`zorunlu	`string[]`
`converted`zorunlu	`boolean`
`revenue`zorunlu	`number`
`isTest`zorunlu	`boolean`
`isInternal`zorunlu	`boolean`
`isBot`zorunlu	`boolean`
`quickBacks`	`integer`
`errorClicks`	`integer`
`excessiveScrolls`	`integer`

`SmsSegmentsobject`

SmsSegments
Alan	Tip	Açıklama
`encoding`zorunlu	`string`	Değerler: gsm7, gsm7_turkish, ucs2
`characters`zorunlu	`integer`
`units`zorunlu	`integer`
`parts`zorunlu	`integer`
`perPart`zorunlu	`integer`
`remaining`zorunlu	`integer`
`credits`zorunlu	`integer`
`unsupported`zorunlu	`string[]`

`SocialAccountobject`

SocialAccount
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`platform`zorunlu	`string`	Değerler: instagram, facebook, linkedin
`status`zorunlu	`string`	Değerler: active, needs_reauth, disconnected
`connectionId`zorunlu	`Id`	null olabilir
`externalId`zorunlu	`string`
`username`zorunlu	`string`	null olabilir
`name`zorunlu	`string`
`profile`zorunlu	`object`
`profile.bio`zorunlu	`string`	null olabilir
`profile.website`zorunlu	`string`	null olabilir
`profile.avatarUrl`zorunlu	`string`	null olabilir
`profile.pageUrl`zorunlu	`string`	null olabilir
`followers`zorunlu	`integer`	null olabilir
`mediaCount`zorunlu	`integer`	null olabilir
`autoPublish`zorunlu	`boolean`
`capabilities`zorunlu	`object`
`capabilities.insights`zorunlu	`boolean`
`capabilities.publish`zorunlu	`boolean`
`capabilities.formats`zorunlu	`string[]`
`capabilities.autoPublishFormats`zorunlu	`string[]`
`freshness`zorunlu	`object`
`freshness.lastSyncedAt`zorunlu	`Timestamp`	null olabilir
`freshness.nextSyncAt`zorunlu	`Timestamp`	null olabilir
`freshness.lastError`zorunlu	`object`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`SocialAccountRefobject`

SocialAccountRef
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`platform`zorunlu	`string`	Değerler: instagram, facebook, linkedin
`name`zorunlu	`string`
`username`zorunlu	`string`	null olabilir
`lastSyncedAt`zorunlu	`Timestamp`	null olabilir

`SocialKpiobject`

SocialKpi
Alan	Tip	Açıklama
`metric`zorunlu	`string`
`label`zorunlu	`string`
`description`zorunlu	`string`
`unit`zorunlu	`string`	Değerler: count, duration_ms, percent, currency, ratio, number
`goodDirection`zorunlu	`string`	Değerler: higher, lower, neutral
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`value`zorunlu	`number`	null olabilir
`previous`zorunlu	`number`	null olabilir
`delta`zorunlu	`QueryDelta`	null olabilir
`unavailable`zorunlu	`SocialUnavailable`	null olabilir
`notAdditive`zorunlu	`boolean`

`SocialOverviewobject`

SocialOverview
Alan	Tip	Açıklama
`scope`zorunlu	`object`
`scope.platform`zorunlu	`string`	Değerler: all, instagram, facebook, linkedin
`scope.accountIds`zorunlu	`Id[]`
`accounts`zorunlu	`SocialAccountRef[]`
`kpis`zorunlu	`SocialKpi[]`
`series`zorunlu	`AnalyticsQueryResult`
`warnings`zorunlu	`QueryWarning[]`
`posts`zorunlu	`integer`	null olabilir
`uniqueByAccount`zorunlu	`object[]`
`uniqueByAccount[].accountId`zorunlu	`Id`	Biçim: uuid
`uniqueByAccount[].kpis`zorunlu	`object[]`
`uniqueByAccount[].kpis[].metric`zorunlu	`string`
`uniqueByAccount[].kpis[].value`zorunlu	`number`	null olabilir
`uniqueByAccount[].kpis[].previous`zorunlu	`number`	null olabilir
`uniqueByAccount[].kpis[].delta`zorunlu	`QueryDelta`	null olabilir
`uniqueByAccount[].kpis[].unavailable`zorunlu	`SocialUnavailable`	null olabilir

`SocialPostMetricsobject`

SocialPostMetrics
Alan	Tip	Açıklama
`likes`zorunlu	`number`	null olabilir
`comments`zorunlu	`number`	null olabilir
`shares`zorunlu	`number`	null olabilir
`saves`zorunlu	`number`	null olabilir
`reach`zorunlu	`number`	null olabilir
`views`zorunlu	`number`	null olabilir
`clicks`zorunlu	`number`	null olabilir
`engagement`zorunlu	`number`	null olabilir
`engagementRate`zorunlu	`number`	null olabilir

`SocialPostSnapshotobject`

SocialPostSnapshot
Alan	Tip	Açıklama
`capturedAt`zorunlu	`Timestamp`	Biçim: date-time
`likes`zorunlu	`number`	null olabilir
`comments`zorunlu	`number`	null olabilir
`shares`zorunlu	`number`	null olabilir
`saves`zorunlu	`number`	null olabilir
`reach`zorunlu	`number`	null olabilir
`views`zorunlu	`number`	null olabilir
`clicks`zorunlu	`number`	null olabilir

`SocialPublishedPostobject`

SocialPublishedPost
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`accountId`zorunlu	`Id`	Biçim: uuid
`platform`zorunlu	`string`	Değerler: instagram, facebook, linkedin
`externalId`zorunlu	`string`
`type`zorunlu	`string`	Değerler: image, carousel, video, reel, story, text, link, other
`caption`zorunlu	`string`	null olabilir
`permalink`zorunlu	`string`	null olabilir
`publishedAt`zorunlu	`Timestamp`	Biçim: date-time
`publishedLocal`zorunlu	`object`
`publishedLocal.date`zorunlu	`LocalDate`	Desen: `^\d{4}-\d{2}-\d{2}$`
`publishedLocal.time`zorunlu	`string`
`thumbnailUrl`zorunlu	`string`	null olabilir
`metrics`zorunlu	`SocialPostMetrics`
`unavailable`zorunlu	`object`	Serbest anahtarlar
`plannedPostId`zorunlu	`Id`	null olabilir
`campaignKey`zorunlu	`string`	null olabilir
`metricsUpdatedAt`zorunlu	`Timestamp`	null olabilir
`nextRefreshAt`zorunlu	`Timestamp`	null olabilir

`SocialPublishedPostDetailobject`

SocialPublishedPostDetail
Alan	Tip	Açıklama
`post`zorunlu	`SocialPublishedPost`
`history`zorunlu	`SocialPostSnapshot[]`

`SocialPublishedPostPageobject`

SocialPublishedPostPage
Alan	Tip	Açıklama
`items`zorunlu	`SocialPublishedPost[]`
`nextCursor`zorunlu	`string`	null olabilir
`countingMode`zorunlu	`string`	Değerler: event_date, cohort
`total`zorunlu	`integer`

`Sourceobject`

Source
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`appId`zorunlu	`Id`	Biçim: uuid
`name`zorunlu	`string`
`kind`zorunlu	`string`	Değerler: web, ios, android, server, other
`environment`zorunlu	`string`	Değerler: production, staging, development
`status`zorunlu	`string`	Değerler: active, disabled
`requireSignature`zorunlu	`boolean`
`allowedOrigins`zorunlu	`string[]`
`consentMode`zorunlu	`string`	Değerler: required, implied, none
`excludedPaths`zorunlu	`string[]`
`maskSelectors`zorunlu	`string[]`
`ignoreSelectors`zorunlu	`string[]`
`stripQueryParams`zorunlu	`string[]`
`sessionTimeoutMinutes`zorunlu	`integer`
`interactionSampleRate`zorunlu	`number`
`autocapture`zorunlu	`Autocapture`
`dataLayerEvents`zorunlu	`string[]`
`createdAt`zorunlu	`Timestamp`	Biçim: date-time
`updatedAt`zorunlu	`Timestamp`	Biçim: date-time

`SourceHealthobject`

SourceHealth
Alan	Tip	Açıklama
`sourceId`zorunlu	`Id`	Biçim: uuid
`state`zorunlu	`string`	Değerler: no_data, receiving, quiet
`lastEventAt`zorunlu	`Timestamp`	null olabilir
`lastRejectionAt`zorunlu	`Timestamp`	null olabilir
`lastLibrary`zorunlu	`string`	null olabilir
`rejectionsLast24h`zorunlu	`integer`	en az 0
`eventsLast24h`	`integer`	en az 0
`warningsLast24h`	`integer`	en az 0
`rejectionRate`	`number`	null olabilir

`SourceKeyobject`

SourceKey
Alan	Tip	Açıklama
`id`zorunlu	`Id`	Biçim: uuid
`kind`zorunlu	`string`	Değerler: write, signing
`mode`zorunlu	`string`	Değerler: live, test
`maskedKey`zorunlu	`string`
`displayPrefix`zorunlu	`string`
`last4`zorunlu	`string`
`state`zorunlu	`string`	Değerler: active, expiring, revoked
`revokedAt`zorunlu	`Timestamp`	null olabilir
`createdBy`zorunlu	`Id`	null olabilir
`createdAt`zorunlu	`Timestamp`	Biçim: date-time

`SummarySectionobject`

SummarySection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: summary
`scope`zorunlu	`string`	Değerler: overall, ads · Varsayılan: overall

`TableSectionobject`

TableSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: table
`dimensions`zorunlu	`string[]`	1–2 öğe
`metrics`zorunlu	`string[]`	1–8 öğe
`limit`zorunlu	`integer`	1–50 · Varsayılan: 10
`orderBy`	`string`	Desen: `^(?:[a-z][a-z0-9_]{0,49}(?::[a-z][a-z0-9_]{0,49})?\|social\.[a-z][a-z0-9_]{0,19}\.[a-z][a-z0-9_]{0,49}\|(?:email\|sms)\.[a-z][a-z0-9_]{0,49})$` · 1–101 karakter
`direction`zorunlu	`string`	Değerler: asc, desc · Varsayılan: desc
`share`zorunlu	`boolean`	Varsayılan: false
`filters`zorunlu	`QueryFilter[]`	en çok 10 öğe · Varsayılan: []
`segmentId`	`string`	null olabilir

`TestSendResultobject`

TestSendResult
Alan	Tip	Açıklama
`results`zorunlu	`object[]`
`results[].to`zorunlu	`string`
`results[].status`zorunlu	`string`	Değerler: sent, failed
`results[].errorCode`zorunlu	`string`	null olabilir
`sms`zorunlu	`SmsSegments`	null olabilir
`campaign`zorunlu	`MessageCampaign`

`TimeToConvertobject`

TimeToConvert
Alan	Tip	Açıklama
`count`zorunlu	`integer`
`averageSeconds`zorunlu	`number`	null olabilir
`medianSeconds`zorunlu	`number`	null olabilir
`p75Seconds`zorunlu	`number`	null olabilir
`p90Seconds`zorunlu	`number`	null olabilir
`histogram`zorunlu	`object[]`
`histogram[].upToSeconds`zorunlu	`number`	null olabilir
`histogram[].count`zorunlu	`integer`

`TimeseriesSectionobject`

TimeseriesSection
Alan	Tip	Açıklama
`id`	`string`	Desen: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 karakter
`title`	`string`	null olabilir
`size`	`string`	Değerler: kpi, half, full
`type`zorunlu	`string`	Sabit: timeseries
`metrics`zorunlu	`string[]`	1–4 öğe
`granularity`zorunlu	`string`	Değerler: day, week, month · Varsayılan: day
`breakdown`	`string`	Desen: `^(?:[a-z][a-z_]{1,30}\|property:[A-Za-z_][A-Za-z0-9_]{0,99})$` · 1–120 karakter
`breakdownLimit`zorunlu	`integer`	2–8 · Varsayılan: 6
`chart`zorunlu	`string`	Değerler: line, bar, stacked_bar · Varsayılan: line
`filters`zorunlu	`QueryFilter[]`	en çok 10 öğe · Varsayılan: []
`segmentId`	`string`	null olabilir

`UpdateAppRequestobject`

UpdateAppRequest
Alan	Tip	Açıklama
`slug`	`string`	Desen: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 karakter
`name`	`string`	1–200 karakter
`description`	`string`	null olabilir
`websiteUrl`	`string`	null olabilir
`iconUrl`	`string`	null olabilir
`timezone`	`string`	en çok 64 karakter
`currency`	`string`	Desen: `^[A-Z]{3}$`
`schemaMode`	`string`	Değerler: strict, lenient, discover
`attributionModel`	`string`	Değerler: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`	`integer`	1–365
`conversionRoles`	`string[]`	1–16 öğe
`leadContactClicks`	`boolean`
`retention`	`object`
`retention.eventsMonths`zorunlu	`integer`	1–120
`retention.interactionsMonths`zorunlu	`integer`	1–60
`retention.sessionsMonths`zorunlu	`integer`	1–120
`internalIpRanges`	`string[]`	en çok 100 öğe
`internalCookie`	`string`	null olabilir
`revenueBasis`	`string`	Değerler: gross, net
`pricesIncludeTax`	`boolean`
`overviewTiles`	`OverviewTileRequest[]`	en çok 12 öğe
`adsKpis`	`string[]`	en çok 12 öğe
`modules`	`string[]`	en çok 6 öğe
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	en çok 50 öğe

`UpdateEventDefinitionRequestobject`

UpdateEventDefinitionRequest
Alan	Tip	Açıklama
`displayName`	`string`	1–200 karakter
`description`	`string`	null olabilir
`category`	`string`	null olabilir
`roles`	`string[]`	en çok 16 öğe
`aliases`	`string[]`	en çok 20 öğe
`properties`	`PropertyDefinitionInput[]`	en çok 200 öğe
`displayNames`	`LocalizedNames`

`UpdateMessageCampaignRequestobject`

UpdateMessageCampaignRequest
Alan	Tip	Açıklama
`name`	`string`	1–200 karakter
`subject`	`string`	null olabilir
`preheader`	`string`	null olabilir
`body`	`string`	en çok 20000 karakter
`senderId`	`string`	null olabilir
`audience`	`object`
`audience.listIds`	`string[]`	en çok 20 öğe · Varsayılan: []
`audience.segmentId`	`string`	null olabilir
`locale`	`string`	Değerler: tr, en
`throttlePerMinute`	`integer`	null olabilir
`utmSource`	`string`	1–100 karakter

`UpdateSourceRequestobject`

UpdateSourceRequest
Alan	Tip	Açıklama
`name`	`string`	1–200 karakter
`environment`	`string`	Değerler: production, staging, development
`status`	`string`	Değerler: active, disabled
`requireSignature`	`boolean`
`allowedOrigins`	`string[]`	en çok 100 öğe
`consentMode`	`string`	Değerler: required, implied, none
`excludedPaths`	`string[]`	en çok 200 öğe
`maskSelectors`	`string[]`	en çok 100 öğe
`ignoreSelectors`	`string[]`	en çok 100 öğe
`stripQueryParams`	`string[]`	en çok 100 öğe
`sessionTimeoutMinutes`	`integer`	5–240
`interactionSampleRate`	`number`	0–1
`autocapture`	`object`
`autocapture.pageviews`	`boolean`
`autocapture.pageleave`	`boolean`
`autocapture.clicks`	`boolean`
`autocapture.rageClicks`	`boolean`
`autocapture.deadClicks`	`boolean`
`autocapture.scroll`	`boolean`
`autocapture.errors`	`boolean`
`autocapture.forms`	`boolean`
`autocapture.layout`	`boolean`
`autocapture.outboundLinks`	`boolean`
`autocapture.downloads`	`boolean`
`autocapture.webVitals`	`boolean`
`dataLayerEvents`	`string[]`	en çok 100 öğe

`UpdateTraitRequestobject`

UpdateTraitRequest
Alan	Tip	Açıklama
`type`	`string`	Değerler: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	null olabilir
`required`	`boolean`
`description`	`string`	null olabilir
`piiClass`	`string`	Değerler: none, pseudonymous, personal, sensitive
`piiAction`	`string`	Değerler: allow, hash, drop, reject
`enumValues`	`string[]`	null olabilir
`maxLength`	`integer`	null olabilir
`minimum`	`number`	null olabilir
`maximum`	`number`	null olabilir
`example`	`any`
`displayNames`	`LocalizedNames`

`UpsertContactRequestobject`

UpsertContactRequest
Alan	Tip	Açıklama
`name`	`string`	null olabilir
`email`	`string`	null olabilir
`phone`	`string`	null olabilir
`mobile`	`string`	null olabilir
`landline`	`string`	null olabilir
`company`	`string`	null olabilir
`title`	`string`	null olabilir
`city`	`string`	null olabilir
`district`	`string`	null olabilir
`userId`	`string`	null olabilir
`locale`	`string`	null olabilir
`tags`	`string[]`	en çok 30 öğe
`consents`	`object`
`consents.email`	`ConsentChange`
`consents.sms`	`ConsentChange`
`listIds`	`string[]`	en çok 50 öğe

`UpsertContactResultobject`

UpsertContactResult
Alan	Tip	Açıklama
`contactId`zorunlu	`Id`	Biçim: uuid
`created`zorunlu	`boolean`
`consents`zorunlu	`object`
`consents.email`zorunlu	`string`	Değerler: none, merchant, opt_in, opt_out
`consents.sms`zorunlu	`string`	Değerler: none, merchant, opt_in, opt_out