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 }.

Version 1.0.0OpenAPI 3.1.1Download the OpenAPI document

This page is generated at build time from docs/api/openapi/management.json in the repository.

The descriptions in this reference come from the OpenAPI document generated from the code and are written in Turkish for now; endpoints, fields and types are language-neutral.

Servers

URL	Description
`https://api.metrics.example`	Management API

Authentication

Name	Method	Description
`apiKey`	Bearer token (mk_…)	Organizasyonun Management API anahtarı (`mk_` + 40 karakter).

Sağlık

1 endpoint

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

GET/v1/health

Sağlık

Herkese açık: kimlik gerekmez.

Authentication: No authentication

Responses

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

Organizasyon

4 endpoints

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	Values: pending, accepted, revoked, expired

Responses

200

Başarılı.

application/jsonInvitationPage

Example · 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.

Authentication: apiKey
Required scope: management:write

Request bodyBody required

application/jsonCreateInvitationRequest

Field	Type	Description
`email`required	`string`	1–320 characters
`roleId`required	`string`	Format: uuid
`appScope`	`string`	Values: all, selected · Default: all
`appIds`	`string[]`	at most 200 items · Default: []

Example · JSON

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

Responses

201

Oluşturuldu.

application/jsonInvitation

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	Values: active, disabled

Responses

200

Başarılı.

application/jsonMemberPage

Example · 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.

Authentication: apiKey
Required scope: management:read

Responses

200

Başarılı.

application/jsonRoleList

Example · 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 endpoints

Ö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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	Values: active, archived

Responses

200

Başarılı.

application/jsonAppPage

Example · 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.

Authentication: apiKey
Required scope: management:write

Request bodyBody required

application/jsonCreateAppRequest

Field	Type	Description
`slug`required	`string`	Pattern: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 characters
`name`required	`string`	1–200 characters
`description`	`string`	may be null
`websiteUrl`	`string`	may be null
`iconUrl`	`string`	may be null
`timezone`	`string`	at most 64 characters
`currency`	`string`	Pattern: `^[A-Z]{3}$`
`schemaMode`	`string`	Values: strict, lenient, discover · Default: lenient
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid · Default: last_non_direct
`attributionWindowDays`	`integer`	1–365 · Default: 90
`conversionRoles`	`string[]`	1–16 items · Default: ["signup","trial_start","lead","demo_request","purchase"]
`leadContactClicks`	`boolean`	Default: false
`retention`	`object`
`retention.eventsMonths`required	`integer`	1–120
`retention.interactionsMonths`required	`integer`	1–60
`retention.sessionsMonths`required	`integer`	1–120
`internalIpRanges`	`string[]`	at most 100 items · Default: []
`internalCookie`	`string`	may be null
`revenueBasis`	`string`	Values: gross, net · Default: gross
`pricesIncludeTax`	`boolean`	Default: true
`overviewTiles`	`OverviewTileRequest[]`	at most 12 items · Default: []
`adsKpis`	`string[]`	at most 12 items · Default: []
`modules`	`string[]`	at most 6 items · Default: ["ads","social","messaging","content","leads","behavior"]
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	at most 50 items · Default: []

Example · 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": []
}

Responses

201

Oluşturuldu.

application/jsonApp

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonApp

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonUpdateAppRequest

Field	Type	Description
`slug`	`string`	Pattern: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 characters
`name`	`string`	1–200 characters
`description`	`string`	may be null
`websiteUrl`	`string`	may be null
`iconUrl`	`string`	may be null
`timezone`	`string`	at most 64 characters
`currency`	`string`	Pattern: `^[A-Z]{3}$`
`schemaMode`	`string`	Values: strict, lenient, discover
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`	`integer`	1–365
`conversionRoles`	`string[]`	1–16 items
`leadContactClicks`	`boolean`
`retention`	`object`
`retention.eventsMonths`required	`integer`	1–120
`retention.interactionsMonths`required	`integer`	1–60
`retention.sessionsMonths`required	`integer`	1–120
`internalIpRanges`	`string[]`	at most 100 items
`internalCookie`	`string`	may be null
`revenueBasis`	`string`	Values: gross, net
`pricesIncludeTax`	`boolean`
`overviewTiles`	`OverviewTileRequest[]`	at most 12 items
`adsKpis`	`string[]`	at most 12 items
`modules`	`string[]`	at most 6 items
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	at most 50 items

Example · 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"
  ]
}

Responses

200

Başarılı.

application/jsonApp

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	Values: active, disabled
`kind`	query	`string`	Values: web, ios, android, server, other

Responses

200

Başarılı.

application/jsonSourcePage

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonCreateSourceRequest

Field	Type	Description
`name`required	`string`	1–200 characters
`kind`required	`string`	Values: web, ios, android, server, other
`environment`	`string`	Values: production, staging, development · Default: production
`requireSignature`	`boolean`	Default: false
`allowedOrigins`	`string[]`	at most 100 items · Default: []
`consentMode`	`string`	Values: required, implied, none · Default: required
`excludedPaths`	`string[]`	at most 200 items · Default: []
`maskSelectors`	`string[]`	at most 100 items · Default: []
`ignoreSelectors`	`string[]`	at most 100 items · Default: []
`stripQueryParams`	`string[]`	at most 100 items · Default: []
`sessionTimeoutMinutes`	`integer`	5–240 · Default: 30
`interactionSampleRate`	`number`	0–1 · Default: 1
`autocapture`	`object`	Default: {}
`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[]`	at most 100 items · Default: []

Example · JSON

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

Responses

201

Oluşturuldu.

application/jsonSource

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`sourceId`required	path	`string`	Kaynağın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonSource

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`sourceId`required	path	`string`	Kaynağın kimliği. Format: uuid

Request bodyBody required

application/jsonUpdateSourceRequest

Field	Type	Description
`name`	`string`	1–200 characters
`environment`	`string`	Values: production, staging, development
`status`	`string`	Values: active, disabled
`requireSignature`	`boolean`
`allowedOrigins`	`string[]`	at most 100 items
`consentMode`	`string`	Values: required, implied, none
`excludedPaths`	`string[]`	at most 200 items
`maskSelectors`	`string[]`	at most 100 items
`ignoreSelectors`	`string[]`	at most 100 items
`stripQueryParams`	`string[]`	at most 100 items
`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[]`	at most 100 items

Example · 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"
  ]
}

Responses

200

Başarılı.

application/jsonSource

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`sourceId`required	path	`string`	Kaynağın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonSourceHealth

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`sourceId`required	path	`string`	Kaynağın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonSourceKeyList

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`sourceId`required	path	`string`	Kaynağın kimliği. Format: uuid

Request bodyBody required

application/jsonCreateSourceKeyRequest

Field	Type	Description
`kind`required	`string`	Values: write, signing
`mode`	`string`	Values: live, test · Default: live

Example · JSON

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

Responses

201

Oluşturuldu.

application/jsonCreatedSourceKey

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`sourceId`required	path	`string`	Kaynağın kimliği. Format: uuid
`keyId`required	path	`string`	Format: uuid

Request body

application/jsonRevokeSourceKeyRequest

Field	Type	Description
`graceMinutes`	`integer`	0–10080 · Default: 0

Example · JSON

{
  "graceMinutes": 0
}

Responses

200

Başarılı.

application/jsonSourceKey

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	Values: draft, active, deprecated, blocked
`role`	query	`string`	Values: 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`	query	`string`	at most 100 characters

Responses

200

Başarılı.

application/jsonEventDefinitionPage

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonCreateEventDefinitionRequest

Field	Type	Description
`name`required	`string`	1–200 characters
`displayName`required	`string`	1–200 characters
`description`	`string`	may be null
`category`	`string`	may be null
`roles`	`string[]`	at most 16 items · Default: []
`status`	`string`	Values: draft, active, deprecated, blocked · Default: active
`aliases`	`string[]`	at most 20 items · Default: []
`properties`	`PropertyDefinitionInput[]`	at most 200 items
`displayNames`	`LocalizedNames`

Example · JSON

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

Responses

201

Oluşturuldu.

application/jsonEventDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`eventId`required	path	`string`	Olay tanımının kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonEventDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`eventId`required	path	`string`	Olay tanımının kimliği. Format: uuid

Request bodyBody required

application/jsonUpdateEventDefinitionRequest

Field	Type	Description
`displayName`	`string`	1–200 characters
`description`	`string`	may be null
`category`	`string`	may be null
`roles`	`string[]`	at most 16 items
`aliases`	`string[]`	at most 20 items
`properties`	`PropertyDefinitionInput[]`	at most 200 items
`displayNames`	`LocalizedNames`

Example · JSON

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

Responses

200

Başarılı.

application/jsonEventDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`eventId`required	path	`string`	Olay tanımının kimliği. Format: uuid

Responses

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`eventId`required	path	`string`	Olay tanımının kimliği. Format: uuid

Responses

200
Başarılı.
application/jsonJsonSchemaDocument
Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`eventId`required	path	`string`	Olay tanımının kimliği. Format: uuid

Request bodyBody required

application/jsonChangeEventStatusRequest

Field	Type	Description
`status`required	`string`	Values: draft, active, deprecated, blocked

Example · JSON

{
  "status": "draft"
}

Responses

200

Başarılı.

application/jsonEventDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonTraitList

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonPropertyDefinitionInput

Field	Type	Description
`key`required	`string`	Pattern: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 characters
`type`required	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	may be null
`required`	`boolean`	Default: false
`description`	`string`	may be null
`piiClass`	`string`	Values: none, pseudonymous, personal, sensitive · Default: none
`piiAction`	`string`	Values: allow, hash, drop, reject · Default: allow
`enumValues`	`string[]`	may be null
`maxLength`	`integer`	may be null
`minimum`	`number`	may be null
`maximum`	`number`	may be null
`example`	`any`
`displayNames`	`LocalizedNames`

Example · 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"
  }
}

Responses

201

Oluşturuldu.

application/jsonPropertyDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`propertyId`required	path	`string`	Format: uuid

Request bodyBody required

application/jsonUpdateTraitRequest

Field	Type	Description
`type`	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	may be null
`required`	`boolean`
`description`	`string`	may be null
`piiClass`	`string`	Values: none, pseudonymous, personal, sensitive
`piiAction`	`string`	Values: allow, hash, drop, reject
`enumValues`	`string[]`	may be null
`maxLength`	`integer`	may be null
`minimum`	`number`	may be null
`maximum`	`number`	may be null
`example`	`any`
`displayNames`	`LocalizedNames`

Example · 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"
  }
}

Responses

200

Başarılı.

application/jsonPropertyDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`propertyId`required	path	`string`	Format: uuid

Responses

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonSchemaBundle

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonTraitList

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonPropertyDefinitionInput

Field	Type	Description
`key`required	`string`	Pattern: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 characters
`type`required	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	may be null
`required`	`boolean`	Default: false
`description`	`string`	may be null
`piiClass`	`string`	Values: none, pseudonymous, personal, sensitive · Default: none
`piiAction`	`string`	Values: allow, hash, drop, reject · Default: allow
`enumValues`	`string[]`	may be null
`maxLength`	`integer`	may be null
`minimum`	`number`	may be null
`maximum`	`number`	may be null
`example`	`any`
`displayNames`	`LocalizedNames`

Example · 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"
  }
}

Responses

201

Oluşturuldu.

application/jsonPropertyDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`propertyId`required	path	`string`	Format: uuid

Request bodyBody required

application/jsonUpdateTraitRequest

Field	Type	Description
`type`	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	may be null
`required`	`boolean`
`description`	`string`	may be null
`piiClass`	`string`	Values: none, pseudonymous, personal, sensitive
`piiAction`	`string`	Values: allow, hash, drop, reject
`enumValues`	`string[]`	may be null
`maxLength`	`integer`	may be null
`minimum`	`number`	may be null
`maximum`	`number`	may be null
`example`	`any`
`displayNames`	`LocalizedNames`

Example · 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"
  }
}

Responses

200

Başarılı.

application/jsonPropertyDefinitionRecord

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`propertyId`required	path	`string`	Format: uuid

Responses

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 endpoints

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.

Authentication: apiKey
Required scope: query:read

Request bodyBody required

application/jsonQueryApiRequest

Field	Type	Description
`appId`required	`string`	Format: uuid
`metrics`required	`string[]`	1–20 items
`dimensions`	`string[]`	at most 3 items · Default: []
`filters`	`QueryFilterInput[]`	at most 20 items · Default: []
`dateRange`required	`DateRange`
`compare`	`string`	Values: none, previous_period, previous_year, custom · Default: none
`compareRange`	`DateRange`
`include`	`TrafficInclude`
`granularity`	`string`	Values: day, week, month
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`orderBy`	`object`
`orderBy.metric`required	`string`	Pattern: `^(?:[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 characters
`orderBy.direction`	`string`	Values: asc, desc · Default: desc
`limit`	`integer`	1–10000 · Default: 1000
`segmentId`	`string`	Format: uuid
`definitions`	`DraftMetricDefinition[]`	at most 5 items

Example · 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"
    }
  ]
}

Responses

200

Başarılı.

application/jsonAnalyticsQueryResult

Example · 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.

Authentication: apiKey
Required scope: query:read

Parameters

Name	In	Type	Description
`appId`required	query	`string`	Format: uuid

Responses

200

Başarılı.

application/jsonAnalyticsCatalogue

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`search`	query	`string`	1–200 characters
`sort`	query	`string`	Values: last_seen, first_seen, members · Default: last_seen

Responses

200

Başarılı.

application/jsonAccountPage

Example · 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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`groupId`required	path	`string`	Sayfa grubunun kimliği (sayfa grubu uçları) ya da hesabın kimliği (`groupId`, hesap uçları). Format: uuid

Responses

200

Başarılı.

application/jsonAccountProfile

Example · 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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`groupId`required	path	`string`	Sayfa grubunun kimliği (sayfa grubu uçları) ya da hesabın kimliği (`groupId`, hesap uçları). Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`type`	query	`string`	Values: track, identify, page, screen, group, alias
`conversions`	query	`string`	Values: true, false

Responses

200

Başarılı.

application/jsonAccountEventPage

Example · 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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`groupId`required	path	`string`	Sayfa grubunun kimliği (sayfa grubu uçları) ya da hesabın kimliği (`groupId`, hesap uçları). Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50

Responses

200

Başarılı.

application/jsonAccountMemberPage

Example · 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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`search`	query	`string`	1–200 characters
`searchMatch`	query	`string`	Values: exact, prefix · Default: exact
`sort`	query	`string`	Values: last_seen, first_seen · Default: last_seen
`includeTest`	query	`string`	Values: true, false
`includeInternal`	query	`string`	Values: true, false
`includeBot`	query	`string`	Values: true, false

Responses

200

Başarılı.

application/jsonPersonPage

Example · 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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`personId`required	path	`string`	Kişinin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonPersonProfile

Example · 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.

Authentication: apiKey
Required scope: persons:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`personId`required	path	`string`	Kişinin kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`type`	query	`string`	Values: track, identify, page, screen, group, alias
`conversions`	query	`string`	Values: true, false

Responses

200

Başarılı.

application/jsonPersonEventPage

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	Yalnız bu durumdaki talepler. Values: pending, running, completed, failed, cancelled

Responses

200

Başarılı.

application/jsonDeletionRequestPage

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonCreateDeletionRequest

Field	Type	Description
`subjectKind`required	`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`). Values: user_id, anonymous_id, person_id
`subjectValue`required	`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 characters
`note`	`string`	Neden (talep numarası, başvurunun kanalı); kişisel veri yazmayın. En çok 500 karakter. may be null

Example · JSON

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

Responses

201

Oluşturuldu.

application/jsonDeletionRequest

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`requestId`required	path	`string`	Silme talebinin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonDeletionRequest

Example · 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.

Authentication: apiKey
Required scope: management:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`requestId`required	path	`string`	Silme talebinin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonDeletionRequest

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonFunnelList

Example · 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.

Authentication: apiKey
Required scope: management:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`funnelId`required	path	`string`	Huninin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonFunnel

Example · 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.

Authentication: apiKey
Required scope: query:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`funnelId`required	path	`string`	Huninin kimliği. Format: uuid
`from`required	query	`string`
`to`required	query	`string`
`countingMode`	query	`string`	Values: event_date, cohort
`breakdown`	query	`string`
`attributionModel`	query	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`includeTest`	query	`string`	Values: true, false
`includeInternal`	query	`string`	Values: true, false
`includeBot`	query	`string`	Values: true, false
`compare`	query	`string`	Values: none, previous_period, previous_year · Default: none
`alignment`	query	`string`	Values: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year
`series`	query	`string`	Values: day, week, month
`seriesBasis`	query	`string`	Values: step_date, entry_date · Default: step_date

Responses

200

Başarılı.

application/jsonFunnelScreenResult

Example · 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.

Authentication: apiKey
Required scope: query:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`funnelId`required	path	`string`	Huninin kimliği. Format: uuid
`from`required	query	`string`
`to`required	query	`string`
`step`	query	`integer`	2–10
`weeks`	query	`integer`	1–26 · Default: 8
`includeTest`	query	`string`	Values: true, false
`includeInternal`	query	`string`	Values: true, false
`includeBot`	query	`string`	Values: true, false

Responses

200

Başarılı.

application/jsonFunnelCohorts

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: leads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`status`	query	`string`	at most 500 characters
`stage`	query	`string \| string[]`
`kind`	query	`string`	at most 500 characters
`assignee`	query	`string`
`channel`	query	`string \| string[]`
`campaign`	query	`string \| string[]`
`overdue`	query	`string`	Values: true, false
`cta`	query	`string \| string[]`
`source`	query	`string \| string[]`
`medium`	query	`string \| string[]`
`deviceType`	query	`string`	1–50 characters
`country`	query	`string`	2–2 characters
`from`	query	`string`
`to`	query	`string`
`includeTest`	query	`string`	Values: true, false
`includeInternal`	query	`string`	Values: true, false

Responses

200

Başarılı.

application/jsonLeadPage

Example · 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.

Authentication: apiKey
Required scope: leads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`leadId`required	path	`string`	Talebin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonLeadDetail

Example · 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 endpoint

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.

Authentication: apiKey
Required scope: ads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonConnectionList

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: ads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonAdAccountList

Example · 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.

Authentication: apiKey
Required scope: ads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`month`	query	`string`	Pattern: `^\d{4}-(0[1-9]\|1[0-2])$` · 7–7 characters

Responses

200

Başarılı.

application/jsonAdsBudget

Example · 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.

Authentication: apiKey
Required scope: ads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`from`required	query	`string`
`to`required	query	`string`
`compare`	query	`string`	Values: none, previous_period, previous_year · Default: previous_period
`alignment`	query	`string`	Values: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year
`includeTest`	query	`string`	Values: true, false
`includeInternal`	query	`string`	Values: true, false
`includeBot`	query	`string`	Values: true, false
`platforms`	query	`string`	at most 4000 characters
`accountIds`	query	`string`	at most 4000 characters
`attributionModel`	query	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`status`	query	`string`	Values: active, paused, ended, all · Default: all
`orderBy`	query	`string`	1–100 characters · Default: spend
`direction`	query	`string`	Values: asc, desc · Default: desc
`minClicks`	query	`integer`	0–10000000 · Default: 20
`search`	query	`string`	1–100 characters
`naming`	query	`string`	Values: all, off_template, follows_template · Default: all

Responses

200

Başarılı.

application/jsonAdsCampaigns

Example · 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.

Authentication: apiKey
Required scope: ads:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`from`required	query	`string`
`to`required	query	`string`
`includeTest`	query	`string`	Values: true, false
`includeInternal`	query	`string`	Values: true, false
`includeBot`	query	`string`	Values: true, false
`platforms`	query	`string`	at most 4000 characters
`accountIds`	query	`string`	at most 4000 characters
`campaignIds`	query	`string`	at most 4000 characters
`role`	query	`string`	Values: 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`	query	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`scope`	query	`string`	Values: ads, all · Default: ads
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50

Responses

200

Başarılı.

application/jsonAdConversionPage

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonForecastScenarioList

Example · 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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`scenarioId`required	path	`string`	Tahmin senaryosunun kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonForecastScenario

Example · 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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`appId`	query	`string`	Format: uuid
`search`	query	`string`	1–200 characters

Responses

200

Başarılı.

application/jsonReportPage

Example · 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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`reportId`required	path	`string`	Raporun kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonReport

Example · 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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`reportId`required	path	`string`	Raporun kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50

Responses

200

Başarılı.

application/jsonReportSnapshotPage

Example · 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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`reportId`required	path	`string`	Raporun kimliği. Format: uuid
`snapshotId`required	path	`string`	Rapor çıktısının kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonReportSnapshot

Example · 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.

Authentication: apiKey
Required scope: reports:read

Parameters

Name	In	Type	Description
`reportId`required	path	`string`	Raporun kimliği. Format: uuid
`snapshotId`required	path	`string`	Rapor çıktısının kimliği. Format: uuid

Responses

200
Rapor çıktısının PDF’i (sunucuda çizilir: kapak, içindekiler, vektör grafikler, sayfa numaraları).
Response headers
- 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 endpoints

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.

Authentication: apiKey
Required scope: social:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonSocialAccountList

Example · 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.

Authentication: apiKey
Required scope: social:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`platform`	query	`string`	Values: all, instagram, facebook, linkedin · Default: all
`accountIds`	query	`string`	at most 4000 characters
`from`required	query	`string`
`to`required	query	`string`
`compare`	query	`string`	Values: none, previous_period, previous_year · Default: previous_period
`alignment`	query	`string`	Values: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year
`granularity`	query	`string`	Values: day, week, month · Default: day

Responses

200

Başarılı.

application/jsonSocialOverview

Example · 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.

Authentication: apiKey
Required scope: social:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`platform`	query	`string`	Values: all, instagram, facebook, linkedin · Default: all
`accountIds`	query	`string`	at most 4000 characters
`from`	query	`string`
`to`	query	`string`
`type`	query	`string`	Values: image, carousel, video, reel, story, text, link, other
`search`	query	`string`	at most 200 characters
`campaign`	query	`string`	at most 120 characters
`sort`	query	`string`	Values: newest, engagement, reach · Default: newest

Responses

200

Başarılı.

application/jsonSocialPublishedPostPage

Example · 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.

Authentication: apiKey
Required scope: social:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`postId`required	path	`string`	Gönderinin ya da yazının kimliği (planlanan / eşitlenen sosyal gönderi ya da blog yazısı, uca göre). Format: uuid

Responses

200

Başarılı.

application/jsonSocialPublishedPostDetail

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: query:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`subject`	query	`string`	Values: person, account

Responses

200

Başarılı.

application/jsonAnalyticsSegmentList

Example · 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.

Authentication: apiKey
Required scope: query:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`segmentId`required	path	`string`	Segmentin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonAnalyticsSegment

Example · 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.

Authentication: apiKey
Required scope: query:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`segmentId`required	path	`string`	Segmentin kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonAnalyticsSegmentCount

Example · 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 endpoints

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.

Authentication: apiKey
Required scope: messaging:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`cursor`	query	`string`	Pattern: `^[A-Za-z0-9_-]{1,512}$`
`limit`	query	`integer`	1–200 · Default: 50
`channel`	query	`string`	Values: email, sms
`status`	query	`string`	Values: draft, awaiting_approval, scheduled, sending, paused, sent, cancelled, failed

Responses

200

Başarılı.

application/jsonMessageCampaignPage

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonCreateMessageCampaignRequest

Field	Type	Description
`channel`required	`string`	Values: email, sms
`name`required	`string`	1–200 characters
`templateId`	`string`	Format: uuid
`templateKey`	`string`	at most 80 characters
`subject`	`string`	may be null
`preheader`	`string`	may be null
`body`	`string`	at most 20000 characters
`senderId`	`string`	may be null
`audience`	`object`
`audience.listIds`	`string[]`	at most 20 items · Default: []
`audience.segmentId`	`string`	may be null
`locale`	`string`	Values: tr, en
`throttlePerMinute`	`integer`	may be null
`utmSource`	`string`	1–100 characters

Example · 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"
}

Responses

201

Oluşturuldu.

application/jsonMessageCampaign

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`campaignId`required	path	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Format: uuid

Request bodyBody required

application/jsonUpdateMessageCampaignRequest

Field	Type	Description
`name`	`string`	1–200 characters
`subject`	`string`	may be null
`preheader`	`string`	may be null
`body`	`string`	at most 20000 characters
`senderId`	`string`	may be null
`audience`	`object`
`audience.listIds`	`string[]`	at most 20 items · Default: []
`audience.segmentId`	`string`	may be null
`locale`	`string`	Values: tr, en
`throttlePerMinute`	`integer`	may be null
`utmSource`	`string`	1–100 characters

Example · 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"
}

Responses

200

Başarılı.

application/jsonMessageCampaign

Example · 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.

Authentication: apiKey
Required scope: messaging:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`campaignId`required	path	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Format: uuid
`segmentId`	query	`string`	Format: uuid

Responses

200

Başarılı.

application/jsonCampaignResults

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`campaignId`required	path	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Format: uuid

Request bodyBody required

application/jsonSendCampaignRequest

Field	Type	Description
`contentReviewed`required	`boolean`	Constant: true
`confirm`required	`boolean`	Constant: true
`schedule`	`MessagingLocalTime`	may be null
`note`	`string`	may be null

Example · JSON

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

Responses

200

Başarılı.

application/jsonMessageCampaign

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`campaignId`required	path	`string`	Kampanyanın Postlip Metrics’teki kimliği (reklam kampanyası ya da e-posta / SMS kampanyası, uca göre). Format: uuid

Request bodyBody required

application/jsonTestSendRequest

Field	Type	Description
`recipients`required	`string[]`	1–5 items
`contactId`	`string`	Format: uuid

Example · JSON

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

Responses

200

Başarılı.

application/jsonTestSendResult

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonManagementConsentRequest

Field	Type	Description
`contactId`	`string`	Format: uuid
`email`	`string`	at most 320 characters
`phone`	`string`	at most 40 characters
`userId`	`string`	1–200 characters
`channel`required	`string`	Values: email, sms
`kind`required	`string`	Values: none, merchant, opt_in, opt_out
`reason`	`string`	may be null
`evidence`	`string`	may be null
`form`	`string`	may be null
`occurredAt`	`string`	Format: date-time

Example · 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"
}

Responses

200

Başarılı.

application/jsonConsentResult

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonUpsertContactRequest

Field	Type	Description
`name`	`string`	may be null
`email`	`string`	may be null
`phone`	`string`	may be null
`mobile`	`string`	may be null
`landline`	`string`	may be null
`company`	`string`	may be null
`title`	`string`	may be null
`city`	`string`	may be null
`district`	`string`	may be null
`userId`	`string`	may be null
`locale`	`string`	may be null
`tags`	`string[]`	at most 30 items
`consents`	`object`
`consents.email`	`ConsentChange`
`consents.sms`	`ConsentChange`
`listIds`	`string[]`	at most 50 items

Example · 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"
  ]
}

Responses

200

Başarılı.

application/jsonUpsertContactResult

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonContactReference

Field	Type	Description
`contactId`	`string`	Format: uuid
`email`	`string`	at most 320 characters
`phone`	`string`	at most 40 characters
`userId`	`string`	1–200 characters

Example · JSON

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

Responses

200
Başarılı.
application/jsonEraseContactResult
Example · 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.

Authentication: apiKey
Required scope: messaging:read

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Responses

200

Başarılı.

application/jsonContactListList

Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid
`listId`required	path	`string`	Kişi listesinin kimliği. Format: uuid

Request bodyBody required

application/jsonManagementListMembersRequest

Field	Type	Description
`add`	`ContactReference[]`	at most 1000 items · Default: []
`remove`	`ContactReference[]`	at most 1000 items · Default: []

Example · JSON

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

Responses

200
Başarılı.
application/jsonListMembersResult
Example · 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.

Authentication: apiKey
Required scope: messaging:write

Parameters

Name	In	Type	Description
`appId`required	path	`string`	Uygulamanın kimliği. Format: uuid

Request bodyBody required

application/jsonManagementSuppressionRequest

Field	Type	Description
`channel`required	`string`	Values: email, sms
`email`	`string`	at most 320 characters
`phone`	`string`	at most 40 characters
`action`	`string`	Values: add, remove · Default: add
`reason`	`string`	Values: hard_bounce, complaint, unsubscribe, manual, invalid_address · Default: manual

Example · JSON

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

Responses

200
Başarılı.
application/jsonSuppressionResult
Example · 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

Schemas

Schemas that requests and responses refer to by name.

`AccountEventobject`

AccountEvent
Field	Type	Description
`id`required	`Id`	Format: uuid
`at`required	`Timestamp`	Format: date-time
`type`required	`string`	Values: track, page, screen, identify, group, alias
`eventName`required	`string`
`roles`required	`string[]`
`conversion`required	`boolean`
`revenue`required	`number`	may be null
`path`required	`string`	may be null
`sessionId`required	`string`	may be null
`properties`required	`object`	Free-form keys
`personId`required	`Id`	may be null

`AccountMemberobject`

AccountMember
Field	Type	Description
`id`required	`Id`	Format: uuid
`userId`required	`string`	may be null
`firstSeenAt`required	`Timestamp`	Format: date-time
`lastSeenAt`required	`Timestamp`	Format: date-time
`firstChannel`required	`string`	may be null
`eventCount`required	`integer`
`sessionCount`required	`integer`
`isTest`required	`boolean`
`isInternal`required	`boolean`
`isBot`	`boolean`
`joinedAt`required	`Timestamp`	Format: date-time

`AccountProfileobject`

AccountProfile
Field	Type	Description
`account`required	`AccountSummary`
`summary`required	`object`
`summary.members`required	`integer`
`summary.sessions`required	`integer`
`summary.events`required	`integer`
`summary.conversions`required	`integer`
`summary.revenue`required	`number`
`summary.refunds`required	`number`
`summary.netRevenue`required	`number`
`summary.currency`required	`string`
`summary.leads`required	`integer`	may be null
`roles`required	`string[]`
`members`required	`AccountMember[]`
`sessions`required	`SessionSummary[]`
`events`required	`AccountEvent[]`
`conversions`required	`PersonConversion[]`
`leads`required	`PersonLead`	may be null
`withheldTraits`required	`string[]`

`AccountSummaryobject`

AccountSummary
Field	Type	Description
`groupId`required	`string`
`name`required	`string`	may be null
`traits`required	`object`	Free-form keys
`memberCount`required	`integer`
`firstSeenAt`required	`Timestamp`	Format: date-time
`lastSeenAt`required	`Timestamp`	Format: date-time

`AdAccountobject`

AdAccount
Field	Type	Description
`id`required	`Id`	Format: uuid
`platform`required	`string`
`externalId`required	`string`
`name`required	`string`
`currency`required	`string`
`timezone`required	`string`	may be null
`status`required	`string`	Values: active, disconnected
`connectionId`required	`Id`	may be null
`lastSyncedAt`required	`Timestamp`	may be null
`link`required	`string`	may be null

`AdCampaignobject`

AdCampaign
Field	Type	Description
`id`required	`Id`	Format: uuid
`platform`required	`string`
`accountId`required	`Id`	Format: uuid
`accountName`required	`string`
`externalId`required	`string`
`name`required	`string`
`status`required	`string`	Values: active, paused, ended, removed, pending, unknown
`platformStatus`required	`string`	may be null
`objective`required	`string`	Values: awareness, traffic, engagement, leads, sales, app_promotion, video_views, search, other
`platformObjective`required	`string`	may be null
`channelType`required	`string`	may be null
`budget`required	`AdBudget`	may be null
`startDate`required	`LocalDate`	may be null
`endDate`required	`LocalDate`	may be null
`campaignGroup`required	`object`	may be null
`hasVideo`required	`boolean`
`adGroups`required	`integer`
`ads`required	`integer`
`link`required	`string`	may be null
`namingIssues`	`NamingIssue[]`

`AdConversionobject`

AdConversion
Field	Type	Description
`eventId`required	`Id`	Format: uuid
`occurredAt`required	`Timestamp`	Format: date-time
`role`required	`string`	may be null
`furthestRole`required	`string`	may be null
`sold`required	`boolean`
`accountId`required	`string`	may be null
`personId`required	`Id`	may be null
`channel`required	`string`	may be null
`source`required	`string`	may be null
`medium`required	`string`	may be null
`platform`required	`string`	may be null
`adAccountId`required	`Id`	may be null
`campaignId`required	`Id`	may be null
`campaignName`required	`string`	may be null
`utmCampaign`required	`string`	may be null
`adId`required	`Id`	may be null
`adName`required	`string`	may be null
`landingPage`required	`string`	may be null
`resolution`required	`string`	Values: click_id, campaign_id, utm_name, unknown
`model`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`weight`required	`number`
`isTest`required	`boolean`
`lastClick`	`LeadLastClick`	may be null
`placement`	`string`	may be null

`AdConversionPageobject`

AdConversionPage
Field	Type	Description
`items`required	`AdConversion[]`
`nextCursor`required	`string`	may be null
`total`required	`integer`
`conversions`required	`integer`
`sold`required	`integer`
`model`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`conversionRoles`required	`string[]`
`countingMode`required	`string`	Constant: event_date

`AdConversionsListOptionsobject`

AdConversionsListOptions
Field	Type	Description
`groupBy`required	`string`	Values: account, conversion · Default: account
`scope`required	`string`	Values: ads, all · Default: ads
`roles`	`string[]`	at most 8 items

`AdConversionsListSectionobject`

AdConversionsListSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: ad_conversions_list
`groupBy`required	`string`	Values: account, conversion · Default: account
`scope`required	`string`	Values: ads, all · Default: ads
`roles`	`string[]`	at most 8 items
`platforms`required	`string[]`	at most 10 items · Default: []
`limit`required	`integer`	1–50 · Default: 25

`AdFunnelSectionobject`

AdFunnelSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: ad_funnel
`roles`	`string[]`	at most 4 items
`platforms`required	`string[]`	at most 10 items · Default: []

`AdsBudgetobject`

AdsBudget
Field	Type	Description
`month`required	`string`
`currency`required	`string`
`daysInMonth`required	`integer`
`daysElapsed`required	`integer`
`tolerance`required	`number`
`total`required	`BudgetPacing`
`lines`required	`BudgetPacing[]`
`plans`required	`BudgetPlan[]`
`cumulative`required	`object[]`
`cumulative[].day`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`cumulative[].spend`required	`number`	may be null
`cumulative[].cumulative`required	`number`	may be null
`cumulative[].plan`required	`number`	may be null
`campaigns`required	`object[]`
`campaigns[].campaign`required	`AdCampaign`
`campaigns[].last7DaysSpend`required	`number`
`campaigns[].dailyAverage`required	`number`
`campaigns[].budgetUse`required	`number`	may be null
`campaigns[].lastDataDay`required	`LocalDate`	may be null

`AdsCampaignsobject`

AdsCampaigns
Field	Type	Description
`metrics`required	`AnalyticsQueryResult`
`campaigns`required	`AdCampaign[]`
`unmatched`required	`AnalyticsQueryResult`
`counts`required	`object`
`counts.active`required	`integer`
`counts.paused`required	`integer`
`counts.ended`required	`integer`
`counts.all`required	`integer`
`naming`	`object`
`naming.hasTemplate`required	`boolean`
`naming.offTemplate`required	`integer`
`naming.followsTemplate`required	`integer`
`conversionRoles`required	`string[]`
`originalSpend`	`object`	Free-form keys
`conversionRates`	`object`
`conversionRates.minClicks`required	`integer`
`conversionRates.items`required	`object[]`
`conversionRates.items[].campaignId`required	`Id`	Format: uuid
`conversionRates.items[].adClicks`required	`number`
`conversionRates.items[].adConversions`required	`number`
`conversionRates.items[].rate`required	`number`	may be null

`AdsTableSectionobject`

AdsTableSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: ads_table
`level`required	`string`	Values: platform, account, campaign, ad_group, ad · Default: campaign
`metrics`	`string[]`	1–8 items
`platforms`required	`string[]`	at most 10 items · Default: []
`limit`required	`integer`	1–50 · Default: 15
`conversions`	`AdConversionsListOptions`

`AiSummaryobject`

AiSummary
Field	Type	Description
`status`required	`string`	Values: disabled, not_configured, pending, ready, failed
`locale`required	`string`	may be null
`text`required	`string`	may be null
`model`required	`string`	may be null
`generatedAt`required	`Timestamp`	may be null
`error`required	`string`	may be null

`AlertRecipientsobject`

AlertRecipients
Field	Type	Description
`inApp`	`boolean`	Default: true
`userIds`	`string[]`	at most 50 items · Default: []
`emails`	`string[]`	at most 20 items · Default: []
`channelIds`	`string[]`	at most 10 items · Default: []
`webPushUserIds`	`string[]`	at most 50 items · Default: []

`AnalyticsCatalogueobject`

AnalyticsCatalogue
Field	Type	Description
`metrics`required	`CatalogueMetric[]`
`dimensions`required	`CatalogueDimension[]`
`roles`required	`LabelledValue[]`
`conversionRoles`required	`string[]`
`compareModes`required	`string[]`
`filterOperators`required	`string[]`
`attributionModels`required	`object[]`
`attributionModels[].key`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionModels[].label`required	`string`
`attributionModels[].description`required	`string`
`defaultAttributionModel`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`required	`integer`
`revenueBasis`	`string`	Values: gross, net
`pricesIncludeTax`	`boolean`

`AnalyticsQueryResultobject`

AnalyticsQueryResult
Field	Type	Description
`metrics`required	`QueryMetricMeta[]`
`dimensions`required	`string[]`
`rows`required	`QueryRow[]`
`totals`required	`object`
`totals.values`required	`QueryValues`
`totals.deltas`required	`QueryDeltas`	may be null
`comparison`required	`object`	may be null
`meta`required	`QueryMeta`

`AnalyticsSegmentobject`

AnalyticsSegment
Field	Type	Description
`id`required	`Id`	Format: uuid
`name`required	`string`
`description`required	`string`	may be null
`subject`required	`string`	Values: person, account
`rules`required	`object`
`rules.match`required	`string`	Values: all, any
`rules.conditions`required	`object[]`
`lastCount`required	`integer`	may be null
`lastCountedAt`required	`Timestamp`	may be null
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`Appobject`

App
Field	Type	Description
`id`required	`Id`	Format: uuid
`slug`required	`string`
`name`required	`string`
`description`required	`string`	may be null
`websiteUrl`required	`string`	may be null
`iconUrl`required	`string`	may be null
`timezone`required	`string`
`currency`required	`string`
`schemaMode`required	`string`	Values: strict, lenient, discover
`schemaRevision`required	`integer`	at least 0
`attributionModel`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`required	`integer`
`conversionRoles`required	`string[]`
`leadContactClicks`required	`boolean`
`retention`required	`AppRetention`
`internalIpRanges`required	`string[]`
`internalCookie`required	`string`	may be null
`revenueBasis`	`string`	Values: gross, net
`pricesIncludeTax`	`boolean`
`overviewTiles`	`OverviewTile[]`
`adsKpis`	`string[]`
`modules`	`string[]`
`defaultAlertRecipients`	`AppAlertRecipients`
`searchBrandTerms`	`string[]`
`defaultOverviewTiles`	`OverviewTile[]`
`defaultAdsKpis`	`string[]`
`status`required	`string`	Values: active, archived
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`AttributedTouchobject`

AttributedTouch
Field	Type	Description
`sessionId`required	`string`	may be null
`at`required	`string`	may be null
`channel`required	`string`	may be null
`source`required	`string`	may be null
`medium`required	`string`	may be null
`campaign`required	`string`	may be null
`resolution`required	`string`	Values: click_id, campaign_id, utm_name, unknown
`weight`required	`number`

`AttributionSectionobject`

AttributionSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: attribution
`metric`required	`string`	Pattern: `^(?:[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 characters · Default: conversions
`dimension`required	`string`	Values: attributed_channel, attributed_source, attributed_medium, attributed_campaign · Default: attributed_channel
`models`required	`string[]`	2–7 items · Default: ["first_touch","last_touch","last_non_direct","linear","position_based","time_decay","last_paid"]
`limit`required	`integer`	1–20 · Default: 8

`Autocaptureobject`

Autocapture
Field	Type	Description
`pageviews`required	`boolean`
`pageleave`required	`boolean`
`clicks`required	`boolean`
`rageClicks`required	`boolean`
`deadClicks`required	`boolean`
`scroll`required	`boolean`
`errors`required	`boolean`
`forms`required	`boolean`
`layout`required	`boolean`
`outboundLinks`required	`boolean`
`downloads`required	`boolean`
`webVitals`required	`boolean`

`BudgetPacingobject`

BudgetPacing
Field	Type	Description
`platform`required	`string`	may be null
`adAccountId`required	`Id`	may be null
`budget`required	`number`	may be null
`spent`required	`number`
`remaining`required	`number`	may be null
`used`required	`number`	may be null
`expectedToDate`required	`number`	may be null
`dailyAverage`required	`number`
`requiredDaily`required	`number`	may be null
`forecast`required	`number`
`forecastRatio`required	`number`	may be null
`activeDailyBudgets`required	`number`
`state`required	`string`	Values: on_track, over, behind, no_budget

`BudgetPlanobject`

BudgetPlan
Field	Type	Description
`id`required	`Id`	Format: uuid
`month`required	`string`
`platform`required	`string`	may be null
`adAccountId`required	`Id`	may be null
`amount`required	`number`
`currency`required	`string`
`note`required	`string`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`createdBy`required	`Id`	may be null
`supersededAt`required	`Timestamp`	may be null

`CampaignCountsobject`

CampaignCounts
Field	Type	Description
`recipients`required	`integer`
`queued`required	`integer`
`sending`required	`integer`
`sent`required	`integer`
`delivered`required	`integer`
`failed`required	`integer`
`bounced`required	`integer`
`unknown`required	`integer`
`skipped`required	`integer`
`opened`required	`integer`
`clicked`required	`integer`
`complained`required	`integer`
`unsubscribed`required	`integer`

`CampaignResultsobject`

CampaignResults
Field	Type	Description
`campaignId`required	`Id`	Format: uuid
`channel`required	`string`	Values: email, sms
`status`required	`string`	Values: draft, awaiting_approval, scheduled, sending, paused, sent, cancelled, failed
`counts`required	`CampaignCounts`
`metrics`required	`object`	Free-form keys
`progress`required	`number`	may be null
`utm`required	`object`
`utm.source`required	`string`
`utm.medium`required	`string`
`utm.campaign`required	`string`
`traffic`required	`object`
`traffic.from`required	`LocalDate`	may be null
`traffic.to`required	`LocalDate`	may be null
`traffic.sessions`required	`number`	may be null
`traffic.conversions`required	`number`	may be null
`traffic.conversionsByRole`required	`object`	Free-form keys
`traffic.revenue`required	`number`	may be null
`traffic.countingMode`required	`string`	Constant: event_date
`countingMode`required	`string`	Constant: cohort
`unavailable`required	`object`	Free-form keys
`segment`	`object`	may be null

`CatalogueDimensionobject`

CatalogueDimension
Field	Type	Description
`key`required	`string`
`label`required	`string`
`description`required	`string`
`kind`required	`string`	Values: time, category
`values`required	`LabelledValue`	may be null

`CatalogueMetricobject`

CatalogueMetric
Field	Type	Description
`key`required	`string`
`label`required	`string`
`description`required	`string`
`unit`required	`string`	Values: count, duration_ms, percent, currency, ratio, number
`goodDirection`required	`string`	Values: higher, lower, neutral
`aggregation`required	`string`	Values: sum, distinct, ratio, last
`countingMode`required	`string`	Values: event_date, cohort
`formula`required	`object`
`formula.numerator`required	`string`
`formula.denominator`required	`string`	may be null
`formula.scale`required	`number`
`tables`required	`string[]`
`dimensions`required	`string[]`
`parameter`required	`object`	may be null
`custom`required	`boolean`
`definitionId`required	`Id`	may be null

`Connectionobject`

Connection
Field	Type	Description
`id`required	`Id`	Format: uuid
`provider`required	`string`	Values: google_ads, meta_ads, linkedin_ads, tiktok_ads, yandex_direct, chatgpt_ads, ga4, search_console, manual_import, instagram, facebook_pages, linkedin_pages
`kind`required	`string`	Values: ads, analytics, search_console, social
`authType`required	`string`	Values: oauth2, api_key, none
`mode`required	`string`	Values: live, fake
`label`required	`string`	may be null
`scopes`required	`string[]`
`syncIntervalMinutes`required	`integer`
`lookbackDays`required	`integer`
`backfillDays`required	`integer`
`health`required	`ConnectionHealth`
`accounts`required	`ConnectionAccount[]`
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`ConnectionAccountobject`

ConnectionAccount
Field	Type	Description
`id`required	`Id`	Format: uuid
`kind`required	`string`	Values: ad_account, ga4_property, search_console_site, social_account
`externalId`required	`string`
`name`required	`string`
`currency`required	`string`	may be null
`timezone`required	`string`	may be null
`platformStatus`required	`string`	may be null
`selected`required	`boolean`

`ConnectionHealthobject`

ConnectionHealth
Field	Type	Description
`status`required	`string`	Values: active, needs_reauth, error, rate_limited, paused
`lastSuccessAt`required	`Timestamp`	may be null
`lastRunAt`required	`Timestamp`	may be null
`lastRunStatus`required	`string`	may be null
`lastError`required	`ConnectorError`	may be null
`consecutiveFailures`required	`integer`
`nextRunAt`required	`Timestamp`	may be null
`syncedUntil`required	`string`	may be null
`tokenExpiresAt`required	`Timestamp`	may be null

`ConnectorErrorobject`

ConnectorError
Field	Type	Description
`code`required	`string`	Values: auth_failed, permission_missing, rate_limited, provider_error, network_error, timeout, invalid_response, not_configured, secret_unavailable
`message`required	`string`

`ConsentChangeobject`

ConsentChange
Field	Type	Description
`kind`required	`string`	Values: none, merchant, opt_in, opt_out
`reason`	`string`	may be null
`evidence`	`string`	may be null
`form`	`string`	may be null
`occurredAt`	`string`	Format: date-time

`ContactListobject`

ContactList
Field	Type	Description
`id`required	`Id`	Format: uuid
`name`required	`string`
`description`required	`string`	may be null
`contacts`required	`integer`
`emailSendable`required	`integer`
`smsSendable`required	`integer`
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`ContentCalendarSectionobject`

ContentCalendarSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: content_calendar
`sources`required	`string[]`	1–2 items · Default: ["social","blog"]
`platforms`required	`string[]`	at most 3 items · Default: []
`limit`required	`integer`	1–100 · Default: 50

`CreateAppRequestobject`

CreateAppRequest
Field	Type	Description
`slug`required	`string`	Pattern: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 characters
`name`required	`string`	1–200 characters
`description`	`string`	may be null
`websiteUrl`	`string`	may be null
`iconUrl`	`string`	may be null
`timezone`	`string`	at most 64 characters
`currency`	`string`	Pattern: `^[A-Z]{3}$`
`schemaMode`	`string`	Values: strict, lenient, discover · Default: lenient
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid · Default: last_non_direct
`attributionWindowDays`	`integer`	1–365 · Default: 90
`conversionRoles`	`string[]`	1–16 items · Default: ["signup","trial_start","lead","demo_request","purchase"]
`leadContactClicks`	`boolean`	Default: false
`retention`	`object`
`retention.eventsMonths`required	`integer`	1–120
`retention.interactionsMonths`required	`integer`	1–60
`retention.sessionsMonths`required	`integer`	1–120
`internalIpRanges`	`string[]`	at most 100 items · Default: []
`internalCookie`	`string`	may be null
`revenueBasis`	`string`	Values: gross, net · Default: gross
`pricesIncludeTax`	`boolean`	Default: true
`overviewTiles`	`OverviewTileRequest[]`	at most 12 items · Default: []
`adsKpis`	`string[]`	at most 12 items · Default: []
`modules`	`string[]`	at most 6 items · Default: ["ads","social","messaging","content","leads","behavior"]
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	at most 50 items · Default: []

`CreateDeletionRequestobject`

CreateDeletionRequest
Field	Type	Description
`subjectKind`required	`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`). Values: user_id, anonymous_id, person_id
`subjectValue`required	`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 characters
`note`	`string`	Neden (talep numarası, başvurunun kanalı); kişisel veri yazmayın. En çok 500 karakter. may be null

`CreateEventDefinitionRequestobject`

CreateEventDefinitionRequest
Field	Type	Description
`name`required	`string`	1–200 characters
`displayName`required	`string`	1–200 characters
`description`	`string`	may be null
`category`	`string`	may be null
`roles`	`string[]`	at most 16 items · Default: []
`status`	`string`	Values: draft, active, deprecated, blocked · Default: active
`aliases`	`string[]`	at most 20 items · Default: []
`properties`	`PropertyDefinitionInput[]`	at most 200 items
`displayNames`	`LocalizedNames`

`CreateInvitationRequestobject`

CreateInvitationRequest
Field	Type	Description
`email`required	`string`	1–320 characters
`roleId`required	`string`	Format: uuid
`appScope`	`string`	Values: all, selected · Default: all
`appIds`	`string[]`	at most 200 items · Default: []

`CreateMessageCampaignRequestobject`

CreateMessageCampaignRequest
Field	Type	Description
`channel`required	`string`	Values: email, sms
`name`required	`string`	1–200 characters
`templateId`	`string`	Format: uuid
`templateKey`	`string`	at most 80 characters
`subject`	`string`	may be null
`preheader`	`string`	may be null
`body`	`string`	at most 20000 characters
`senderId`	`string`	may be null
`audience`	`object`
`audience.listIds`	`string[]`	at most 20 items · Default: []
`audience.segmentId`	`string`	may be null
`locale`	`string`	Values: tr, en
`throttlePerMinute`	`integer`	may be null
`utmSource`	`string`	1–100 characters

`CreateSourceRequestobject`

CreateSourceRequest
Field	Type	Description
`name`required	`string`	1–200 characters
`kind`required	`string`	Values: web, ios, android, server, other
`environment`	`string`	Values: production, staging, development · Default: production
`requireSignature`	`boolean`	Default: false
`allowedOrigins`	`string[]`	at most 100 items · Default: []
`consentMode`	`string`	Values: required, implied, none · Default: required
`excludedPaths`	`string[]`	at most 200 items · Default: []
`maskSelectors`	`string[]`	at most 100 items · Default: []
`ignoreSelectors`	`string[]`	at most 100 items · Default: []
`stripQueryParams`	`string[]`	at most 100 items · Default: []
`sessionTimeoutMinutes`	`integer`	5–240 · Default: 30
`interactionSampleRate`	`number`	0–1 · Default: 1
`autocapture`	`object`	Default: {}
`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[]`	at most 100 items · Default: []

`CreatedSourceKeyobject`

CreatedSourceKey
Field	Type	Description
`id`required	`Id`	Format: uuid
`kind`required	`string`	Values: write, signing
`mode`required	`string`	Values: live, test
`maskedKey`required	`string`
`displayPrefix`required	`string`
`last4`required	`string`
`state`required	`string`	Values: active, expiring, revoked
`revokedAt`required	`Timestamp`	may be null
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`key`required	`string`

`DateRangeobject`

DateRange
Field	Type	Description
`from`required	`string`
`to`required	`string`
`alignment`	`string`	Values: week_to_date, month_to_date, calendar_month, quarter_to_date, calendar_quarter, year_to_date, calendar_year

`DeletionRequestobject`

DeletionRequest
Field	Type	Description
`id`required	`Id`	Format: uuid
`appId`required	`Id`	Format: uuid
`subjectKind`required	`string`	Kimliğin türü (`user_id`, `anonymous_id`, `person_id`). Values: user_id, anonymous_id, person_id
`subjectHint`required	`string`	Kimliğin son karakterleri («…7c1e»); değerin kendisi hiçbir zaman dönmez.
`status`required	`string`	`pending` sırada, `running` yürütülüyor, `completed` bitti, `failed` üç denemeden sonra başarısız (`errorCode`), `cancelled` iptal edildi. Values: pending, running, completed, failed, cancelled
`note`required	`string`	Talebi açanın notu. may be null
`requestedVia`required	`string`	Talebin geldiği yer: panel ya da Management API. Values: panel, api
`requestedBy`required	`object`	Talebi açan üye (adı üye dizininden); API anahtarıyla açıldıysa `null`. may be null
`result`required	`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. Free-form keys
`errorCode`required	`string`	Başarısız talebin hata kodu. may be null
`createdAt`required	`Timestamp`	Format: date-time
`startedAt`required	`Timestamp`	Worker'ın talebi ilk aldığı an; bu andan sonra alınan veri talebe girmez. may be null
`completedAt`required	`Timestamp`	Talebin bittiği ya da iptal edildiği an. may be null
`nothingFound`required	`boolean`	Talep tamamlandı ama kimliğe ait veri yoktu.

`DraftMetricDefinitionobject`

DraftMetricDefinition
Field	Type	Description
`key`required	`string`	Pattern: `^[a-z][a-z0-9_]{1,49}$` · 1–50 characters
`name`	`string`	1–200 characters
`kind`required	`string`	Values: event_count, unique_persons, property_sum, property_average, ratio, unique_accounts
`eventName`	`string`	1–200 characters
`role`	`string`	Values: 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`	Pattern: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 characters
`filters`	`QueryFilterInput[]`	at most 10 items · Default: []
`numerator`	`string`	Pattern: `^(?:[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 characters
`denominator`	`string`	Pattern: `^(?:[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 characters
`unit`	`string`	Values: count, duration_ms, percent, currency, ratio, number
`goodDirection`	`string`	Values: higher, lower, neutral · Default: higher

`ErrorResponseobject`

ErrorResponse
Field	Type	Description
`error`required	`object`
`error.code`required	`string`
`error.message`required	`string`
`error.fields`	`object`	Free-form keys
`error.details`	`object`	Free-form keys
`error.retryAfterSeconds`	`integer`
`error.traceId`required	`string`

`EventDefinitionobject`

EventDefinition
Field	Type	Description
`name`required	`string`	Pattern: `^(?!\$)[^\s\x00-\x1f][^\x00-\x1f]{0,199}$`
`displayName`required	`string`	at most 200 characters
`description`	`string`	at most 2000 characters
`category`	`string`	at most 100 characters
`roles`required	`string[]`
`status`required	`string`	Values: draft, active, deprecated, blocked
`aliases`	`string[]`
`version`required	`integer`	above 0
`properties`required	`PropertyDefinition[]`

`EventDefinitionRecordobject`

EventDefinitionRecord
Field	Type	Description
`id`required	`Id`	Format: uuid
`appId`required	`Id`	Format: uuid
`name`required	`string`
`displayName`required	`string`
`displayNames`	`LocalizedNamesRecord`
`description`required	`string`	may be null
`category`required	`string`	may be null
`roles`required	`string[]`
`status`required	`string`	Values: draft, active, deprecated, blocked
`aliases`required	`string[]`
`version`required	`integer`	above 0
`propertyCount`required	`integer`	at least 0
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time
`properties`required	`PropertyDefinitionRecord[]`

`EventDefinitionSummaryobject`

EventDefinitionSummary
Field	Type	Description
`id`required	`Id`	Format: uuid
`appId`required	`Id`	Format: uuid
`name`required	`string`
`displayName`required	`string`
`displayNames`	`LocalizedNamesRecord`
`description`required	`string`	may be null
`category`required	`string`	may be null
`roles`required	`string[]`
`status`required	`string`	Values: draft, active, deprecated, blocked
`aliases`required	`string[]`
`version`required	`integer`	above 0
`propertyCount`required	`integer`	at least 0
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`ForecastAllocationobject`

ForecastAllocation
Field	Type	Description
`monthlyBudget`required	`number`
`channels`required	`object[]`
`channels[].platform`required	`string`
`channels[].label`required	`string`
`channels[].current`required	`number`
`channels[].suggested`required	`number`
`channels[].change`required	`number`
`channels[].marginalCpaCurrent`required	`number`	may be null
`channels[].marginalCpaSuggested`required	`number`	may be null
`channels[].bound`required	`string`	may be null
`paidCurrent`required	`number`
`paidSuggested`required	`number`
`gain`required	`number`

`ForecastChannelBasisobject`

ForecastChannelBasis
Field	Type	Description
`platform`required	`string`
`label`required	`string`
`status`required	`string`	Values: ok, insufficient_history, no_spend
`reason`required	`string`	may be null
`spend`required	`number`
`conversions`required	`number`
`spendPerDay`required	`number`
`conversionsPerDay`required	`number`
`cpa`required	`number`	may be null
`elasticity`required	`number`	may be null
`elasticitySource`required	`string`	may be null
`rSquared`required	`number`	may be null
`weeks`required	`integer`
`weeksWithSpend`required	`integer`
`maxSpendPerDay`required	`number`
`plannedMonthlyBudget`required	`number`	may be null
`marginalCpa`required	`number`	may be null

`ForecastInputsobject`

ForecastInputs
Field	Type	Description
`horizonMonths`required	`integer`	1–12 · Default: 6
`basisDays`required	`integer`	28–365 · Default: 90
`funnelId`required	`string`	Default: null · may be null
`role`	`string`	Values: 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`required	`ForecastBudget[]`	at most 20 items · Default: []
`totalMonthlyBudget`	`number`	0–10000000000
`elasticityMode`required	`string`	Values: estimate, fixed · Default: estimate
`elasticity`required	`number`	0.05–1 · Default: 0.75
`scenarios`required	`ForecastScenarioParams[]`	1–5 items · Default: [{"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`required	`boolean`	Default: true
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`seasonality`	`boolean`

`ForecastLagobject`

ForecastLag
Field	Type	Description
`p50Days`required	`number`	may be null
`p75Days`required	`number`	may be null
`p90Days`required	`number`	may be null
`distribution`required	`object[]`
`distribution[].upToDays`required	`number`	may be null
`distribution[].share`required	`number`

`ForecastMonthobject`

ForecastMonth
Field	Type	Description
`month`required	`string`
`days`required	`integer`
`budget`required	`number`
`budgetByPlatform`required	`object`	Free-form keys
`paid`required	`ForecastBand`
`organic`required	`ForecastBand`
`total`required	`ForecastBand`
`steps`required	`object[]`
`steps[].role`required	`string`	Values: 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`required	`ForecastBand`
`revenue`required	`ForecastBand`	may be null
`cpa`required	`number`	may be null
`cac`required	`number`	may be null

`ForecastResultobject`

ForecastResult
Field	Type	Description
`appId`required	`Id`	Format: uuid
`currency`required	`string`
`timezone`required	`string`
`generatedAt`required	`Timestamp`	Format: date-time
`method`required	`object`
`method.key`required	`string`	Constant: log_log_bootstrap
`method.description`required	`string`
`method.assumptions`required	`string[]`
`basis`required	`object`
`basis.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`basis.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`basis.days`required	`integer`
`basis.role`required	`string`	Values: 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`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`basis.countingModes`required	`object`
`basis.countingModes.channels`required	`string`	Values: event_date, cohort
`basis.countingModes.steps`required	`string`	Values: event_date, cohort
`basis.channels`required	`ForecastChannelBasis[]`
`basis.organic`required	`object`
`basis.organic.conversions`required	`number`
`basis.organic.perDay`required	`number`
`basis.organic.trendPerMonth`required	`number`	may be null
`basis.steps`required	`object[]`
`basis.steps[].role`required	`string`	Values: 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`required	`number`	may be null
`basis.steps[].lagDays`required	`number`	may be null
`basis.steps[].lag`	`ForecastLag`	may be null
`basis.revenuePerConversion`required	`number`	may be null
`basis.elasticityPrior`required	`number`
`basis.seasonality`	`ForecastSeasonality`	may be null
`basis.unforecastable`	`object`
`basis.unforecastable.spend`required	`number`
`basis.unforecastable.share`required	`number`	may be null
`basis.unforecastable.platforms`required	`string[]`
`scenarios`required	`ForecastScenarioResult[]`
`goal`required	`object`	may be null
`allocation`	`ForecastAllocation`	may be null
`warnings`required	`object[]`
`warnings[].code`required	`string`	Values: EXTRAPOLATION, ELASTICITY_ASSUMED, NO_TREND, STEP_RATES_UNKNOWN, NEW_CHANNEL, GOAL_UNREACHABLE, DATA_DELAYED, SEASONALITY_OFF, UNFORECASTABLE_SPEND
`warnings[].message`required	`string`
`warnings[].platform`required	`string`	may be null

`ForecastScenarioobject`

ForecastScenario
Field	Type	Description
`id`required	`Id`	Format: uuid
`appId`required	`Id`	Format: uuid
`name`required	`string`
`description`required	`string`	may be null
`inputs`required	`ForecastInputs`
`result`required	`ForecastResult`	may be null
`computedAt`required	`Timestamp`	may be null
`actuals`required	`object[]`	may be null
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`ForecastScenarioListobject`

ForecastScenarioList
Field	Type	Description
`items`required	`object[]`
`items[].id`required	`Id`	Format: uuid
`items[].appId`required	`Id`	Format: uuid
`items[].name`required	`string`
`items[].description`required	`string`	may be null
`items[].inputs`required	`ForecastInputs`
`items[].computedAt`required	`Timestamp`	may be null
`items[].createdBy`required	`Id`	may be null
`items[].createdAt`required	`Timestamp`	Format: date-time
`items[].updatedAt`required	`Timestamp`	Format: date-time

`ForecastScenarioParamsobject`

ForecastScenarioParams
Field	Type	Description
`key`required	`string`	Pattern: `^[a-z][a-z0-9_]{0,29}$` · 1–30 characters
`label`	`string`	may be null
`costMultiplier`required	`number`	0.1–5
`conversionMultiplier`required	`number`	0.1–5
`organicMultiplier`required	`number`	0–5

`ForecastScenarioResultobject`

ForecastScenarioResult
Field	Type	Description
`key`required	`string`
`label`required	`string`
`costMultiplier`required	`number`
`conversionMultiplier`required	`number`
`organicMultiplier`required	`number`
`months`required	`ForecastMonth[]`
`totals`required	`object`
`totals.budget`required	`number`
`totals.paid`required	`ForecastBand`
`totals.organic`required	`ForecastBand`
`totals.total`required	`ForecastBand`
`totals.steps`required	`object[]`
`totals.steps[].role`required	`string`	Values: 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`required	`ForecastBand`
`totals.revenue`required	`ForecastBand`	may be null
`totals.cpa`	`number`	may be null
`totals.cac`	`number`	may be null
`totals.cacRole`	`string`	may be null

`ForecastSeasonalityobject`

ForecastSeasonality
Field	Type	Description
`weekday`required	`number[]`	may be null
`month`required	`number[]`	may be null
`historyDays`required	`integer`
`conversions`required	`number`
`minimum`required	`object`
`minimum.weekdayDays`required	`integer`
`minimum.months`required	`integer`
`minimum.conversions`required	`integer`

`ForecastSectionobject`

ForecastSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: forecast
`scenarioId`required	`string`	Default: null · may be null
`horizonMonths`required	`integer`	1–12 · Default: 3
`scenario`required	`string`	Pattern: `^[a-z][a-z0-9_]{0,29}$` · 1–30 characters · Default: realistic

`Funnelobject`

Funnel
Field	Type	Description
`id`required	`Id`	Format: uuid
`name`required	`string`
`description`required	`string`	may be null
`steps`required	`FunnelStepRecord[]`
`order`required	`string`	Values: ordered, any_order
`countBy`required	`string`	Values: person, session, group
`conversionWindow`required	`object`	may be null
`countingMode`required	`string`	Values: event_date, cohort
`isDefault`required	`boolean`
`sideMetrics`	`FunnelSideMetricRecord[]`
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`FunnelBreakdownRowobject`

FunnelBreakdownRow
Field	Type	Description
`value`required	`string`	may be null
`steps`required	`object[]`
`steps[].count`required	`integer`
`steps[].ofFirst`required	`number`	may be null
`steps[].ofPrevious`required	`number`	may be null

`FunnelCohortsobject`

FunnelCohorts
Field	Type	Description
`funnel`required	`object`
`funnel.id`required	`Id`	Format: uuid
`funnel.name`required	`string`
`funnel.countBy`required	`string`	Values: person, session, group
`basis`required	`string`	Constant: entry_week
`countingMode`required	`string`	Constant: cohort
`dateRange`required	`object`
`dateRange.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`timezone`required	`string`
`followedUntil`required	`Timestamp`	Format: date-time
`step`required	`integer`
`weeks`required	`integer`
`minSubjects`required	`integer`
`include`required	`object`
`include.test`required	`boolean`
`include.internal`required	`boolean`
`include.bot`required	`boolean`
`cohorts`required	`object[]`
`cohorts[].week`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`cohorts[].start`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`cohorts[].end`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`cohorts[].entered`required	`integer`
`cohorts[].lowSample`required	`boolean`
`cohorts[].cells`required	`object[]`
`cohorts[].cells[].week`required	`integer`
`cohorts[].cells[].reached`required	`integer`
`cohorts[].cells[].rate`required	`number`	may be null
`cohorts[].cells[].complete`required	`boolean`
`total`required	`object[]`
`total[].week`required	`integer`
`total[].entered`required	`integer`
`total[].reached`required	`integer`
`total[].rate`required	`number`	may be null
`freshness`	`QueryFreshness`
`generatedAt`required	`Timestamp`	Format: date-time

`FunnelResultobject`

FunnelResult
Field	Type	Description
`funnel`required	`object`
`funnel.id`required	`Id`	may be null
`funnel.name`required	`string`	may be null
`funnel.order`required	`string`	Values: ordered, any_order
`funnel.countBy`required	`string`	Values: person, session, group
`funnel.conversionWindow`required	`object`	may be null
`countingMode`required	`string`	Values: event_date, cohort
`dateRange`required	`object`
`dateRange.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`timezone`required	`string`
`followedUntil`required	`Timestamp`	Format: date-time
`include`required	`object`
`include.test`required	`boolean`
`include.internal`required	`boolean`
`include.bot`required	`boolean`
`steps`required	`FunnelStepResult[]`
`breakdown`required	`object`	may be null
`extraBreakdown`	`object`	may be null
`warnings`required	`object[]`
`warnings[].code`required	`string`	Values: ATTRIBUTION_NOT_CONVERSION, BREAKDOWN_TRUNCATED
`warnings[].message`required	`string`
`series`	`FunnelSeries`	may be null
`sideMetrics`	`FunnelSideMetricResult[]`
`generatedAt`required	`Timestamp`	Format: date-time

`FunnelScreenResultobject`

FunnelScreenResult
Field	Type	Description
`funnel`required	`object`
`funnel.id`required	`Id`	may be null
`funnel.name`required	`string`	may be null
`funnel.order`required	`string`	Values: ordered, any_order
`funnel.countBy`required	`string`	Values: person, session, group
`funnel.conversionWindow`required	`object`	may be null
`countingMode`required	`string`	Values: event_date, cohort
`dateRange`required	`object`
`dateRange.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`timezone`required	`string`
`followedUntil`required	`Timestamp`	Format: date-time
`include`required	`object`
`include.test`required	`boolean`
`include.internal`required	`boolean`
`include.bot`required	`boolean`
`steps`required	`FunnelStepResult[]`
`breakdown`required	`object`	may be null
`extraBreakdown`	`object`	may be null
`warnings`required	`object[]`
`warnings[].code`required	`string`	Values: ATTRIBUTION_NOT_CONVERSION, BREAKDOWN_TRUNCATED
`warnings[].message`required	`string`
`series`	`FunnelSeries`	may be null
`sideMetrics`	`FunnelSideMetricResult[]`
`generatedAt`required	`Timestamp`	Format: date-time
`freshness`required	`QueryFreshness`
`comparison`required	`object`	may be null

`FunnelSectionobject`

FunnelSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: funnel
`funnelId`required	`string`	Default: null · may be null
`countingMode`	`string`	Values: event_date, cohort
`breakdown`	`string`	Values: channel, source, medium, campaign, device_type, country, attributed_channel, attributed_source, attributed_campaign, os, browser, region, app_version, language, channel_group

`FunnelSeriesobject`

FunnelSeries
Field	Type	Description
`granularity`required	`string`	Values: day, week, month
`basis`required	`string`	Values: step_date, entry_date
`points`required	`object[]`
`points[].date`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`points[].start`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`points[].end`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`points[].steps`required	`integer[]`
`points[].complete`	`boolean`
`points[].beforeTracking`	`boolean`
`afterRange`required	`integer[]`

`FunnelSideMetricRecordobject`

FunnelSideMetricRecord
Field	Type	Description
`event`required	`string`	may be null
`role`required	`string`	may be null
`filters`required	`PropertyFilterRecord[]`
`label`required	`string`	may be null
`without`required	`object`	may be null

`FunnelSideMetricResultobject`

FunnelSideMetricResult
Field	Type	Description
`index`required	`integer`
`label`required	`string`	may be null
`event`required	`string`	may be null
`role`required	`string`	may be null
`count`required	`integer`
`ofEntered`required	`number`	may be null
`pending`required	`integer`	may be null
`withinDays`required	`integer`	may be null

`FunnelStepResultobject`

FunnelStepResult
Field	Type	Description
`index`required	`integer`
`label`required	`string`	may be null
`event`required	`string`	may be null
`role`required	`string`	may be null
`count`required	`integer`
`ofFirst`required	`number`	may be null
`ofPrevious`required	`number`	may be null
`dropOff`required	`integer`	may be null
`timeFromPrevious`required	`TimeToConvert`	may be null
`timeFromFirst`required	`TimeToConvert`	may be null

`Invitationobject`

Invitation
Field	Type	Description
`id`required	`Id`	Format: uuid
`email`required	`string`
`role`required	`RoleSummary`
`appScope`required	`string`	Values: all, selected
`appIds`required	`Id[]`
`status`required	`string`	Values: pending, accepted, revoked, expired
`invitedBy`required	`Id`	may be null
`expiresAt`required	`Timestamp`	Format: date-time
`acceptedAt`required	`Timestamp`	may be null
`revokedAt`required	`Timestamp`	may be null
`createdAt`required	`Timestamp`	Format: date-time

`KpiSectionobject`

KpiSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: kpi
`metric`required	`string`	Pattern: `^(?:[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 characters
`spark`required	`boolean`	Default: true
`filters`required	`QueryFilter[]`	at most 10 items · Default: []
`segmentId`	`string`	may be null

`Leadobject`

Lead
Field	Type	Description
`id`required	`Id`	Format: uuid
`kind`required	`string`	Values: demo_request, lead, contact_click
`status`required	`string`	Values: new, contacted, qualified, won, lost, spam
`stage`	`string`
`dueAt`	`Timestamp`	may be null
`overdue`	`boolean`
`statusReason`required	`string`	may be null
`assignee`required	`LeadAssignee`	may be null
`eventId`required	`Id`	Format: uuid
`eventName`required	`string`
`occurredAt`required	`Timestamp`	Format: date-time
`personId`required	`Id`	may be null
`userId`required	`string`	may be null
`groupId`required	`string`	may be null
`source`required	`LeadSource`
`attribution`required	`LeadAttribution`	may be null
`lastClick`	`LeadLastClick`	may be null
`properties`required	`object`	Free-form keys
`isTest`required	`boolean`
`isInternal`required	`boolean`
`noteCount`required	`integer`
`statusChangedAt`required	`Timestamp`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`LeadAttributionobject`

LeadAttribution
Field	Type	Description
`model`required	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`windowDays`required	`integer`
`firstTouch`required	`AttributedTouch`	may be null
`lastTouch`required	`AttributedTouch`	may be null
`lastNonDirect`required	`AttributedTouch`	may be null
`method`	`string`	may be null

`LeadDetailobject`

LeadDetail
Field	Type	Description
`id`required	`Id`	Format: uuid
`kind`required	`string`	Values: demo_request, lead, contact_click
`status`required	`string`	Values: new, contacted, qualified, won, lost, spam
`stage`	`string`
`dueAt`	`Timestamp`	may be null
`overdue`	`boolean`
`statusReason`required	`string`	may be null
`assignee`required	`LeadAssignee`	may be null
`eventId`required	`Id`	Format: uuid
`eventName`required	`string`
`occurredAt`required	`Timestamp`	Format: date-time
`personId`required	`Id`	may be null
`userId`required	`string`	may be null
`groupId`required	`string`	may be null
`source`required	`LeadSource`
`attribution`required	`LeadAttribution`	may be null
`lastClick`	`LeadLastClick`	may be null
`properties`required	`object`	Free-form keys
`isTest`required	`boolean`
`isInternal`required	`boolean`
`noteCount`required	`integer`
`statusChangedAt`required	`Timestamp`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time
`notes`required	`LeadNote[]`
`statusHistory`required	`LeadStatusChange[]`

`LeadLastClickobject`

LeadLastClick
Field	Type	Description
`at`required	`Timestamp`	Format: date-time
`path`required	`string`	may be null
`selector`required	`string`	may be null
`label`required	`string`	may be null
`kind`required	`string`	may be null
`section`required	`string`	may be null
`contact`required	`string`	may be null
`tag`	`string`	may be null
`href`	`string`	may be null

`LeadNoteobject`

LeadNote
Field	Type	Description
`id`required	`Id`	Format: uuid
`body`required	`string`
`author`required	`LeadAssignee`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`editedAt`required	`Timestamp`	may be null

`LeadSourceobject`

LeadSource
Field	Type	Description
`sessionId`required	`string`	may be null
`channel`required	`string`	may be null
`source`required	`string`	may be null
`medium`required	`string`	may be null
`campaign`required	`string`	may be null
`referrerHost`required	`string`	may be null
`entryPath`required	`string`	may be null
`pagePath`required	`string`	may be null
`deviceType`required	`string`	may be null
`country`required	`string`	may be null

`LeadStatusChangeobject`

LeadStatusChange
Field	Type	Description
`id`required	`Id`	Format: uuid
`from`required	`string`	may be null
`to`required	`string`	Values: new, contacted, qualified, won, lost, spam
`fromStage`	`string`	may be null
`toStage`	`string`	may be null
`reason`required	`string`	may be null
`changedBy`required	`LeadAssignee`	may be null
`changedAt`required	`Timestamp`	Format: date-time

`ManagementConsentRequestobject`

ManagementConsentRequest
Field	Type	Description
`contactId`	`string`	Format: uuid
`email`	`string`	at most 320 characters
`phone`	`string`	at most 40 characters
`userId`	`string`	1–200 characters
`channel`required	`string`	Values: email, sms
`kind`required	`string`	Values: none, merchant, opt_in, opt_out
`reason`	`string`	may be null
`evidence`	`string`	may be null
`form`	`string`	may be null
`occurredAt`	`string`	Format: date-time

`ManagementSuppressionRequestobject`

ManagementSuppressionRequest
Field	Type	Description
`channel`required	`string`	Values: email, sms
`email`	`string`	at most 320 characters
`phone`	`string`	at most 40 characters
`action`	`string`	Values: add, remove · Default: add
`reason`	`string`	Values: hard_bounce, complaint, unsubscribe, manual, invalid_address · Default: manual

`Memberobject`

Member
Field	Type	Description
`id`required	`Id`	Format: uuid
`user`required	`object`
`user.id`required	`Id`	Format: uuid
`user.email`required	`string`
`user.name`required	`string`
`role`required	`RoleSummary`
`appScope`required	`string`	Values: all, selected
`appIds`required	`Id[]`
`status`required	`string`	Values: active, disabled
`invitedBy`required	`Id`	may be null
`lastSignInAt`	`Timestamp`	may be null
`twoFactorEnabled`	`boolean`
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`MessageCampaignobject`

MessageCampaign
Field	Type	Description
`id`required	`Id`	Format: uuid
`channel`required	`string`	Values: email, sms
`name`required	`string`
`slug`required	`string`
`utm`required	`object`
`utm.source`required	`string`
`utm.medium`required	`string`
`utm.campaign`required	`string`
`templateId`required	`Id`	may be null
`subject`required	`string`	may be null
`preheader`required	`string`	may be null
`body`required	`string`
`senderId`required	`Id`	may be null
`audience`required	`object`
`audience.listIds`required	`Id[]`
`audience.segmentId`required	`Id`	may be null
`locale`required	`string`	Values: tr, en
`status`required	`string`	Values: draft, awaiting_approval, scheduled, sending, paused, sent, cancelled, failed
`schedule`required	`object`	may be null
`start`required	`object`	may be null
`throttlePerMinute`required	`integer`	may be null
`confirmation`required	`object`
`confirmation.testSentAt`required	`Timestamp`	may be null
`confirmation.testSentBy`required	`Id`	may be null
`confirmation.testCurrent`required	`boolean`
`confirmation.confirmedAt`required	`Timestamp`	may be null
`confirmation.confirmedBy`required	`Id`	may be null
`approval`required	`object`	may be null
`counts`required	`CampaignCounts`
`skippedByReason`required	`object`	Free-form keys
`progress`required	`number`	may be null
`errorCode`required	`string`	may be null
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time
`startedAt`required	`Timestamp`	may be null
`finishedAt`required	`Timestamp`	may be null

`MessageCampaignPageobject`

MessageCampaignPage
Field	Type	Description
`items`required	`MessageCampaign[]`
`nextCursor`required	`string`	may be null
`total`required	`integer`

`NamingIssueobject`

NamingIssue
Field	Type	Description
`code`required	`string`	Values: missing_prefix, too_few_parts, too_many_parts, empty_part, value_not_allowed, invalid_date, too_long, invalid_characters, test_in_live_name
`severity`required	`string`	Values: error, warning
`token`required	`string`	may be null
`position`required	`integer`	may be null
`value`required	`string`	may be null
`expected`required	`string[]`	may be null

`NoteSectionobject`

NoteSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: note
`text`required	`string`	1–4000 characters
`format`	`string`	Values: plain, markdown

`OverviewTileRequestobject`

OverviewTileRequest
Field	Type	Description
`metric`required	`string`	Pattern: `^(?:[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 characters
`breakdown`	`string`	Default: null · may be null

`PersonConversionobject`

PersonConversion
Field	Type	Description
`eventId`required	`Id`	Format: uuid
`at`required	`Timestamp`	Format: date-time
`eventName`required	`string`
`roles`required	`string[]`
`revenue`required	`number`	may be null
`sessionId`required	`string`	may be null
`channel`required	`string`	may be null
`lastClick`	`string`	may be null

`PersonEventobject`

PersonEvent
Field	Type	Description
`id`required	`Id`	Format: uuid
`at`required	`Timestamp`	Format: date-time
`type`required	`string`	Values: track, page, screen, identify, group, alias
`eventName`required	`string`
`roles`required	`string[]`
`conversion`required	`boolean`
`revenue`required	`number`	may be null
`path`required	`string`	may be null
`sessionId`required	`string`	may be null
`properties`required	`object`	Free-form keys

`PersonLeadobject`

PersonLead
Field	Type	Description
`id`required	`Id`	Format: uuid
`kind`required	`string`	Values: demo_request, lead, contact_click
`status`required	`string`	Values: new, contacted, qualified, won, lost, spam
`eventName`required	`string`
`eventAt`required	`Timestamp`	Format: date-time

`PersonProfileobject`

PersonProfile
Field	Type	Description
`requestedId`required	`Id`	Format: uuid
`person`required	`object`
`person.id`required	`Id`	Format: uuid
`person.userId`required	`string`	may be null
`person.traits`required	`object`	Free-form keys
`person.firstSeenAt`required	`Timestamp`	Format: date-time
`person.lastSeenAt`required	`Timestamp`	Format: date-time
`person.firstChannel`required	`string`	may be null
`person.firstTouch`required	`PersonTouch`	may be null
`person.lastNonDirectTouch`required	`PersonTouch`	may be null
`person.eventCount`required	`integer`
`person.sessionCount`required	`integer`
`person.isTest`required	`boolean`
`person.isInternal`required	`boolean`
`person.mergedFrom`required	`Id[]`
`identities`required	`object[]`
`identities[].kind`required	`string`	Values: anonymous_id, user_id
`identities[].value`required	`string`
`identities[].firstSeenAt`required	`Timestamp`	Format: date-time
`groups`required	`object[]`
`groups[].groupId`required	`string`
`groups[].traits`required	`object`	Free-form keys
`groups[].memberCount`required	`integer`
`groups[].firstSeenAt`required	`Timestamp`	Format: date-time
`groups[].lastSeenAt`required	`Timestamp`	Format: date-time
`roles`required	`string[]`
`sessions`required	`SessionSummary[]`
`events`required	`PersonEvent[]`
`summary`	`object`
`summary.sessions`required	`integer`
`summary.events`required	`integer`
`summary.conversions`required	`integer`
`summary.revenue`required	`number`
`summary.refunds`required	`number`
`summary.netRevenue`required	`number`
`summary.currency`required	`string`
`summary.leads`required	`integer`	may be null
`conversions`	`PersonConversion[]`
`leads`	`PersonLead`	may be null
`merges`	`PersonMerge[]`
`withheldTraits`	`string[]`

`PersonSummaryobject`

PersonSummary
Field	Type	Description
`id`required	`Id`	Format: uuid
`userId`required	`string`	may be null
`firstSeenAt`required	`Timestamp`	Format: date-time
`lastSeenAt`required	`Timestamp`	Format: date-time
`firstChannel`required	`string`	may be null
`eventCount`required	`integer`
`sessionCount`required	`integer`
`isTest`required	`boolean`
`isInternal`required	`boolean`
`isBot`	`boolean`

`PropertyDefinitionobject`

PropertyDefinition
Field	Type	Description
`key`required	`string`	Pattern: `^[A-Za-z_][A-Za-z0-9_]{0,99}$`
`type`required	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`required`required	`boolean`
`description`	`string`	at most 1000 characters
`piiClass`required	`string`	Values: none, pseudonymous, personal, sensitive
`piiAction`required	`string`	Values: allow, hash, drop, reject
`enumValues`	`string[]`	at most 500 items
`maxLength`	`integer`	above 0, at most 10000
`minimum`	`number`
`maximum`	`number`
`example`	`any`

`PropertyDefinitionInputobject`

PropertyDefinitionInput
Field	Type	Description
`key`required	`string`	Pattern: `^[A-Za-z_][A-Za-z0-9_]{0,99}$` · 1–100 characters
`type`required	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	may be null
`required`	`boolean`	Default: false
`description`	`string`	may be null
`piiClass`	`string`	Values: none, pseudonymous, personal, sensitive · Default: none
`piiAction`	`string`	Values: allow, hash, drop, reject · Default: allow
`enumValues`	`string[]`	may be null
`maxLength`	`integer`	may be null
`minimum`	`number`	may be null
`maximum`	`number`	may be null
`example`	`any`
`displayNames`	`LocalizedNames`

`PropertyDefinitionRecordobject`

PropertyDefinitionRecord
Field	Type	Description
`id`required	`Id`	Format: uuid
`scope`required	`string`	Values: event, trait, group_trait
`key`required	`string`
`type`required	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`required	`string`	may be null
`required`required	`boolean`
`description`required	`string`	may be null
`piiClass`required	`string`	Values: none, pseudonymous, personal, sensitive
`piiAction`required	`string`	Values: allow, hash, drop, reject
`enumValues`required	`string[]`	may be null
`maxLength`required	`integer`	may be null
`minimum`required	`number`	may be null
`maximum`required	`number`	may be null
`example`required	`any`
`sortOrder`required	`integer`
`displayNames`	`LocalizedNamesRecord`
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`PropertyFilterRecordobject`

PropertyFilterRecord
Field	Type	Description
`property`required	`string`
`op`required	`string`	Values: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty, gt, gte, lt, lte
`value`required	`string \| number \| boolean \| string[]`	may be null

`QueryApiRequestobject`

QueryApiRequest
Field	Type	Description
`appId`required	`string`	Format: uuid
`metrics`required	`string[]`	1–20 items
`dimensions`	`string[]`	at most 3 items · Default: []
`filters`	`QueryFilterInput[]`	at most 20 items · Default: []
`dateRange`required	`DateRange`
`compare`	`string`	Values: none, previous_period, previous_year, custom · Default: none
`compareRange`	`DateRange`
`include`	`TrafficInclude`
`granularity`	`string`	Values: day, week, month
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`orderBy`	`object`
`orderBy.metric`required	`string`	Pattern: `^(?:[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 characters
`orderBy.direction`	`string`	Values: asc, desc · Default: desc
`limit`	`integer`	1–10000 · Default: 1000
`segmentId`	`string`	Format: uuid
`definitions`	`DraftMetricDefinition[]`	at most 5 items

`QueryBucketobject`

QueryBucket
Field	Type	Description
`start`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`end`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`days`required	`integer`
`complete`required	`boolean`
`beforeTracking`required	`boolean`

`QueryDeltaobject`

QueryDelta
Field	Type	Description
`previous`required	`number`	may be null
`absolute`required	`number`	may be null
`relative`required	`number`	may be null
`mode`required	`string`	Values: relative, absolute, points
`direction`required	`string`	Values: up, down, flat
`tone`required	`string`	Values: positive, negative, neutral
`comparable`required	`boolean`
`reason`required	`string`	may be null

`QueryFilterobject`

QueryFilter
Field	Type	Description
`dimension`required	`string`	Pattern: `^(?:[a-z][a-z_]{1,30}\|property:[A-Za-z_][A-Za-z0-9_]{0,99})$` · 1–120 characters
`op`required	`string`	Values: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty
`value`	`string \| string[]`

`QueryFilterInputobject`

QueryFilterInput
Field	Type	Description
`dimension`required	`string`	Pattern: `^(?:[a-z][a-z_]{1,30}\|property:[A-Za-z_][A-Za-z0-9_]{0,99})$` · 1–120 characters
`op`required	`string`	Values: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty
`value`	`string \| string[]`

`QueryFilterRecordobject`

QueryFilterRecord
Field	Type	Description
`dimension`required	`string`
`op`required	`string`	Values: eq, neq, in, not_in, contains, not_contains, starts_with, is_empty, is_not_empty
`value`required	`string \| string[]`	may be null

`QueryFreshnessobject`

QueryFreshness
Field	Type	Description
`processedUntil`required	`Timestamp`	may be null
`lastEventReceivedAt`required	`Timestamp`	may be null
`upToDate`required	`boolean`
`updatedAt`required	`Timestamp`	may be null
`pendingRollupDays`required	`integer`

`QueryMetaobject`

QueryMeta
Field	Type	Description
`appId`required	`Id`	Format: uuid
`timezone`required	`string`
`currency`required	`string`
`dateRange`required	`object`
`dateRange.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`dateRange.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`compare`required	`string`	Values: none, previous_period, previous_year, custom
`comparisonRange`required	`object`	may be null
`include`required	`object`
`include.test`required	`boolean`
`include.internal`required	`boolean`
`include.bot`required	`boolean`
`trackingStartedOn`required	`LocalDate`	may be null
`freshness`required	`QueryFreshness`
`countingModes`required	`object`	Free-form keys
`sources`required	`object`	Free-form keys
`conversionRoles`required	`string[]`
`attribution`required	`object`	may be null
`warnings`required	`QueryWarning[]`
`truncated`required	`boolean`
`generatedAt`required	`Timestamp`	Format: date-time
`segment`	`object`	may be null

`QueryMetricMetaobject`

QueryMetricMeta
Field	Type	Description
`key`required	`string`
`unit`required	`string`	Values: count, duration_ms, percent, currency, ratio, number
`goodDirection`required	`string`	Values: higher, lower, neutral
`aggregation`required	`string`	Values: sum, distinct, ratio, last
`countingMode`required	`string`	Values: event_date, cohort
`source`required	`string`	Values: rollup, raw, none
`label`	`string`

`QueryRowobject`

QueryRow
Field	Type	Description
`dimensions`required	`object`	Free-form keys
`values`required	`QueryValues`
`bucket`required	`QueryBucket`	may be null
`previous`required	`QueryValues`	may be null
`previousBucket`required	`object`	may be null
`deltas`required	`QueryDeltas`	may be null
`shares`	`QueryValues`

`QueryWarningobject`

QueryWarning
Field	Type	Description
`code`required	`string`	Values: 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`required	`string`
`metric`required	`string`	may be null
`dimension`required	`string`	may be null

`Reportobject`

Report
Field	Type	Description
`id`required	`Id`	Format: uuid
`name`required	`string`
`description`required	`string`	may be null
`appIds`required	`Id[]`
`apps`required	`object[]`
`apps[].id`required	`Id`	Format: uuid
`apps[].slug`required	`string`
`apps[].name`required	`string`
`apps[].timezone`required	`string`
`apps[].currency`required	`string`
`sections`required	`ReportSection[]`
`period`required	`ReportPeriod`
`compare`required	`string`	Values: none, previous_period, previous_year
`filters`required	`QueryFilterRecord[]`
`segmentId`	`Id`	may be null
`include`required	`object`
`include.test`required	`boolean`
`include.internal`required	`boolean`
`include.bot`required	`boolean`
`attributionModel`required	`string`	may be null
`locale`required	`string`	Values: tr, en
`timezone`required	`string`
`subtitle`required	`string`	may be null
`templateKey`required	`string`	may be null
`lastSnapshot`required	`object`	may be null
`schedules`required	`integer`
`shareLinks`required	`object`
`shareLinks.active`required	`integer`
`shareLinks.total`required	`integer`
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`ReportCalendarobject`

ReportCalendar
Field	Type	Description
`items`required	`ReportCalendarItem[]`
`total`required	`integer`
`counts`required	`object`
`counts.published`required	`integer`
`counts.planned`required	`integer`
`counts.blog`required	`integer`

`ReportCalendarItemobject`

ReportCalendarItem
Field	Type	Description
`kind`required	`string`	Values: social_planned, social_direct, blog
`postId`required	`Id`	may be null
`date`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`time`required	`string`
`at`required	`Timestamp`	Format: date-time
`platform`required	`string`	may be null
`status`required	`string`
`format`required	`string`	may be null
`excerpt`required	`string`
`permalink`required	`string`	may be null
`campaignKey`required	`string`	may be null

`ReportFreshnessobject`

ReportFreshness
Field	Type	Description
`appId`required	`Id`	Format: uuid
`processedUntil`required	`Timestamp`	may be null
`lastEventReceivedAt`required	`Timestamp`	may be null
`upToDate`required	`boolean`
`pendingRollupDays`required	`integer`
`adsSyncedAt`required	`Timestamp`	may be null

`ReportMetricLabelobject`

ReportMetricLabel
Field	Type	Description
`key`required	`string`
`label`required	`string`
`description`required	`string`	may be null
`unit`required	`string`	Values: count, duration_ms, percent, currency, ratio, number
`goodDirection`required	`string`	Values: higher, lower, neutral
`countingMode`required	`string`	Values: event_date, cohort
`source`	`string`	Values: metrics, ad_platform, ga4, search_console, social_platform, messaging, mixed
`sources`	`string[]`

`ReportSectionResultobject`

ReportSectionResult
Field	Type	Description
`id`required	`string`
`type`required	`string`	Values: kpi, timeseries, table, funnel, attribution, ads_table, ad_funnel, summary, note, ad_conversions_list, content_calendar, forecast
`title`required	`string`
`subtitle`required	`string`	may be null
`size`required	`string`	Values: kpi, half, full
`definition`required	`ReportSection`
`metrics`required	`ReportMetricLabel[]`
`countingModes`required	`string[]`
`text`required	`string`	may be null
`blocks`	`ReportNoteBlock`	may be null
`dataDelayHint`	`SectionDataDelay`	may be null
`apps`required	`SectionAppResult[]`

`ReportSnapshotobject`

ReportSnapshot
Field	Type	Description
`id`required	`Id`	Format: uuid
`reportId`required	`Id`	may be null
`name`required	`string`
`subtitle`required	`string`	may be null
`trigger`required	`string`	Values: manual, schedule, api, preview
`period`required	`object`
`period.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`period.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`period.preset`required	`string`	may be null
`comparison`required	`object`	may be null
`timezone`required	`string`
`locale`required	`string`	Values: tr, en
`generatedAt`required	`Timestamp`	Format: date-time
`createdBy`required	`Id`	may be null
`scheduleId`required	`Id`	may be null
`apps`required	`object[]`
`apps[].id`required	`Id`	Format: uuid
`apps[].slug`required	`string`
`apps[].name`required	`string`
`apps[].timezone`required	`string`
`apps[].currency`required	`string`
`filters`required	`QueryFilterRecord[]`
`include`required	`object`
`include.test`required	`boolean`
`include.internal`required	`boolean`
`include.bot`required	`boolean`
`attributionModel`required	`string`	may be null
`freshness`required	`ReportFreshness[]`
`sections`required	`ReportSectionResult[]`
`aiSummary`required	`AiSummary`

`ReportSnapshotSummaryobject`

ReportSnapshotSummary
Field	Type	Description
`id`required	`Id`	Format: uuid
`reportId`required	`Id`	may be null
`name`required	`string`
`subtitle`required	`string`	may be null
`trigger`required	`string`	Values: manual, schedule, api, preview
`period`required	`object`
`period.from`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`period.to`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`period.preset`required	`string`	may be null
`comparison`required	`object`	may be null
`timezone`required	`string`
`locale`required	`string`	Values: tr, en
`generatedAt`required	`Timestamp`	Format: date-time
`createdBy`required	`Id`	may be null
`scheduleId`required	`Id`	may be null
`aiSummaryStatus`required	`string`	Values: disabled, not_configured, pending, ready, failed

`Roleobject`

Role
Field	Type	Description
`id`required	`Id`	Format: uuid
`key`required	`string`
`name`required	`string`
`description`required	`string`	may be null
`permissions`required	`string[]`
`builtIn`required	`boolean`
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`RoleSummaryobject`

RoleSummary
Field	Type	Description
`id`required	`Id`	Format: uuid
`key`required	`string`
`name`required	`string`
`builtIn`required	`boolean`

`SchemaBundleobject`

SchemaBundle
Field	Type	Description
`formatVersion`required	`number`	Constant: 1
`app`required	`object`
`app.id`required	`string`
`app.slug`required	`string`
`app.name`required	`string`
`schemaMode`required	`string`	Values: strict, lenient, discover
`revision`required	`integer`	at least 0
`generatedAt`required	`string`	Format: date-time
`events`required	`EventDefinition[]`
`traits`required	`PropertyDefinition[]`
`groupTraits`required	`PropertyDefinition[]`

`SectionAppResultobject`

SectionAppResult
Field	Type	Description
`appId`required	`Id`	Format: uuid
`status`required	`string`	Values: ok, not_available, not_connected, failed
`message`required	`string`	may be null
`results`required	`object`	Free-form keys
`funnel`required	`FunnelResult`	may be null
`labels`required	`object`	Free-form keys
`lines`required	`string[]`
`derived`required	`SectionDerived`
`conversions`	`object`
`conversions.items`required	`AdConversion[]`
`conversions.total`required	`integer`
`conversions.sold`required	`integer`
`calendar`	`ReportCalendar`
`forecast`	`ReportForecast`

`SectionDataDelayobject`

SectionDataDelay
Field	Type	Description
`days`required	`integer`
`sources`required	`object[]`
`sources[].source`required	`string`	Values: metrics, ad_platform, ga4, search_console, social_platform, messaging
`sources[].days`required	`integer`
`affectsPeriod`required	`boolean`
`text`required	`string`

`SendCampaignRequestobject`

SendCampaignRequest
Field	Type	Description
`contentReviewed`required	`boolean`	Constant: true
`confirm`required	`boolean`	Constant: true
`schedule`	`MessagingLocalTime`	may be null
`note`	`string`	may be null

`SessionSummaryobject`

SessionSummary
Field	Type	Description
`id`required	`string`
`personId`required	`Id`	may be null
`anonymousId`required	`string`	may be null
`userId`required	`string`	may be null
`startedAt`required	`Timestamp`	Format: date-time
`endedAt`required	`Timestamp`	Format: date-time
`durationMs`required	`integer`
`activeMs`required	`integer`
`pageviews`required	`integer`
`screenViews`required	`integer`
`events`required	`integer`
`interactions`required	`integer`
`rageClicks`required	`integer`
`deadClicks`required	`integer`
`errors`required	`integer`
`entryPath`required	`string`	may be null
`exitPath`required	`string`	may be null
`channel`required	`string`	may be null
`source`required	`string`	may be null
`medium`required	`string`	may be null
`campaign`required	`string`	may be null
`referrerHost`required	`string`	may be null
`deviceType`required	`string`	may be null
`os`required	`string`	may be null
`browser`required	`string`	may be null
`country`required	`string`	may be null
`region`required	`string`	may be null
`city`required	`string`	may be null
`isEngaged`required	`boolean`
`isBounce`required	`boolean`
`roles`required	`string[]`
`converted`required	`boolean`
`revenue`required	`number`
`isTest`required	`boolean`
`isInternal`required	`boolean`
`isBot`required	`boolean`
`quickBacks`	`integer`
`errorClicks`	`integer`
`excessiveScrolls`	`integer`

`SmsSegmentsobject`

SmsSegments
Field	Type	Description
`encoding`required	`string`	Values: gsm7, gsm7_turkish, ucs2
`characters`required	`integer`
`units`required	`integer`
`parts`required	`integer`
`perPart`required	`integer`
`remaining`required	`integer`
`credits`required	`integer`
`unsupported`required	`string[]`

`SocialAccountobject`

SocialAccount
Field	Type	Description
`id`required	`Id`	Format: uuid
`platform`required	`string`	Values: instagram, facebook, linkedin
`status`required	`string`	Values: active, needs_reauth, disconnected
`connectionId`required	`Id`	may be null
`externalId`required	`string`
`username`required	`string`	may be null
`name`required	`string`
`profile`required	`object`
`profile.bio`required	`string`	may be null
`profile.website`required	`string`	may be null
`profile.avatarUrl`required	`string`	may be null
`profile.pageUrl`required	`string`	may be null
`followers`required	`integer`	may be null
`mediaCount`required	`integer`	may be null
`autoPublish`required	`boolean`
`capabilities`required	`object`
`capabilities.insights`required	`boolean`
`capabilities.publish`required	`boolean`
`capabilities.formats`required	`string[]`
`capabilities.autoPublishFormats`required	`string[]`
`freshness`required	`object`
`freshness.lastSyncedAt`required	`Timestamp`	may be null
`freshness.nextSyncAt`required	`Timestamp`	may be null
`freshness.lastError`required	`object`	may be null
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`SocialAccountRefobject`

SocialAccountRef
Field	Type	Description
`id`required	`Id`	Format: uuid
`platform`required	`string`	Values: instagram, facebook, linkedin
`name`required	`string`
`username`required	`string`	may be null
`lastSyncedAt`required	`Timestamp`	may be null

`SocialKpiobject`

SocialKpi
Field	Type	Description
`metric`required	`string`
`label`required	`string`
`description`required	`string`
`unit`required	`string`	Values: count, duration_ms, percent, currency, ratio, number
`goodDirection`required	`string`	Values: higher, lower, neutral
`countingMode`required	`string`	Values: event_date, cohort
`value`required	`number`	may be null
`previous`required	`number`	may be null
`delta`required	`QueryDelta`	may be null
`unavailable`required	`SocialUnavailable`	may be null
`notAdditive`required	`boolean`

`SocialOverviewobject`

SocialOverview
Field	Type	Description
`scope`required	`object`
`scope.platform`required	`string`	Values: all, instagram, facebook, linkedin
`scope.accountIds`required	`Id[]`
`accounts`required	`SocialAccountRef[]`
`kpis`required	`SocialKpi[]`
`series`required	`AnalyticsQueryResult`
`warnings`required	`QueryWarning[]`
`posts`required	`integer`	may be null
`uniqueByAccount`required	`object[]`
`uniqueByAccount[].accountId`required	`Id`	Format: uuid
`uniqueByAccount[].kpis`required	`object[]`
`uniqueByAccount[].kpis[].metric`required	`string`
`uniqueByAccount[].kpis[].value`required	`number`	may be null
`uniqueByAccount[].kpis[].previous`required	`number`	may be null
`uniqueByAccount[].kpis[].delta`required	`QueryDelta`	may be null
`uniqueByAccount[].kpis[].unavailable`required	`SocialUnavailable`	may be null

`SocialPostMetricsobject`

SocialPostMetrics
Field	Type	Description
`likes`required	`number`	may be null
`comments`required	`number`	may be null
`shares`required	`number`	may be null
`saves`required	`number`	may be null
`reach`required	`number`	may be null
`views`required	`number`	may be null
`clicks`required	`number`	may be null
`engagement`required	`number`	may be null
`engagementRate`required	`number`	may be null

`SocialPostSnapshotobject`

SocialPostSnapshot
Field	Type	Description
`capturedAt`required	`Timestamp`	Format: date-time
`likes`required	`number`	may be null
`comments`required	`number`	may be null
`shares`required	`number`	may be null
`saves`required	`number`	may be null
`reach`required	`number`	may be null
`views`required	`number`	may be null
`clicks`required	`number`	may be null

`SocialPublishedPostobject`

SocialPublishedPost
Field	Type	Description
`id`required	`Id`	Format: uuid
`accountId`required	`Id`	Format: uuid
`platform`required	`string`	Values: instagram, facebook, linkedin
`externalId`required	`string`
`type`required	`string`	Values: image, carousel, video, reel, story, text, link, other
`caption`required	`string`	may be null
`permalink`required	`string`	may be null
`publishedAt`required	`Timestamp`	Format: date-time
`publishedLocal`required	`object`
`publishedLocal.date`required	`LocalDate`	Pattern: `^\d{4}-\d{2}-\d{2}$`
`publishedLocal.time`required	`string`
`thumbnailUrl`required	`string`	may be null
`metrics`required	`SocialPostMetrics`
`unavailable`required	`object`	Free-form keys
`plannedPostId`required	`Id`	may be null
`campaignKey`required	`string`	may be null
`metricsUpdatedAt`required	`Timestamp`	may be null
`nextRefreshAt`required	`Timestamp`	may be null

`SocialPublishedPostDetailobject`

SocialPublishedPostDetail
Field	Type	Description
`post`required	`SocialPublishedPost`
`history`required	`SocialPostSnapshot[]`

`SocialPublishedPostPageobject`

SocialPublishedPostPage
Field	Type	Description
`items`required	`SocialPublishedPost[]`
`nextCursor`required	`string`	may be null
`countingMode`required	`string`	Values: event_date, cohort
`total`required	`integer`

`Sourceobject`

Source
Field	Type	Description
`id`required	`Id`	Format: uuid
`appId`required	`Id`	Format: uuid
`name`required	`string`
`kind`required	`string`	Values: web, ios, android, server, other
`environment`required	`string`	Values: production, staging, development
`status`required	`string`	Values: active, disabled
`requireSignature`required	`boolean`
`allowedOrigins`required	`string[]`
`consentMode`required	`string`	Values: required, implied, none
`excludedPaths`required	`string[]`
`maskSelectors`required	`string[]`
`ignoreSelectors`required	`string[]`
`stripQueryParams`required	`string[]`
`sessionTimeoutMinutes`required	`integer`
`interactionSampleRate`required	`number`
`autocapture`required	`Autocapture`
`dataLayerEvents`required	`string[]`
`createdAt`required	`Timestamp`	Format: date-time
`updatedAt`required	`Timestamp`	Format: date-time

`SourceHealthobject`

SourceHealth
Field	Type	Description
`sourceId`required	`Id`	Format: uuid
`state`required	`string`	Values: no_data, receiving, quiet
`lastEventAt`required	`Timestamp`	may be null
`lastRejectionAt`required	`Timestamp`	may be null
`lastLibrary`required	`string`	may be null
`rejectionsLast24h`required	`integer`	at least 0
`eventsLast24h`	`integer`	at least 0
`warningsLast24h`	`integer`	at least 0
`rejectionRate`	`number`	may be null

`SourceKeyobject`

SourceKey
Field	Type	Description
`id`required	`Id`	Format: uuid
`kind`required	`string`	Values: write, signing
`mode`required	`string`	Values: live, test
`maskedKey`required	`string`
`displayPrefix`required	`string`
`last4`required	`string`
`state`required	`string`	Values: active, expiring, revoked
`revokedAt`required	`Timestamp`	may be null
`createdBy`required	`Id`	may be null
`createdAt`required	`Timestamp`	Format: date-time

`SummarySectionobject`

SummarySection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: summary
`scope`required	`string`	Values: overall, ads · Default: overall

`TableSectionobject`

TableSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: table
`dimensions`required	`string[]`	1–2 items
`metrics`required	`string[]`	1–8 items
`limit`required	`integer`	1–50 · Default: 10
`orderBy`	`string`	Pattern: `^(?:[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 characters
`direction`required	`string`	Values: asc, desc · Default: desc
`share`required	`boolean`	Default: false
`filters`required	`QueryFilter[]`	at most 10 items · Default: []
`segmentId`	`string`	may be null

`TestSendResultobject`

TestSendResult
Field	Type	Description
`results`required	`object[]`
`results[].to`required	`string`
`results[].status`required	`string`	Values: sent, failed
`results[].errorCode`required	`string`	may be null
`sms`required	`SmsSegments`	may be null
`campaign`required	`MessageCampaign`

`TimeToConvertobject`

TimeToConvert
Field	Type	Description
`count`required	`integer`
`averageSeconds`required	`number`	may be null
`medianSeconds`required	`number`	may be null
`p75Seconds`required	`number`	may be null
`p90Seconds`required	`number`	may be null
`histogram`required	`object[]`
`histogram[].upToSeconds`required	`number`	may be null
`histogram[].count`required	`integer`

`TimeseriesSectionobject`

TimeseriesSection
Field	Type	Description
`id`	`string`	Pattern: `^[a-z0-9][a-z0-9_-]{0,39}$` · 1–40 characters
`title`	`string`	may be null
`size`	`string`	Values: kpi, half, full
`type`required	`string`	Constant: timeseries
`metrics`required	`string[]`	1–4 items
`granularity`required	`string`	Values: day, week, month · Default: day
`breakdown`	`string`	Pattern: `^(?:[a-z][a-z_]{1,30}\|property:[A-Za-z_][A-Za-z0-9_]{0,99})$` · 1–120 characters
`breakdownLimit`required	`integer`	2–8 · Default: 6
`chart`required	`string`	Values: line, bar, stacked_bar · Default: line
`filters`required	`QueryFilter[]`	at most 10 items · Default: []
`segmentId`	`string`	may be null

`UpdateAppRequestobject`

UpdateAppRequest
Field	Type	Description
`slug`	`string`	Pattern: `^[a-z0-9](?:[a-z0-9-]{0,48}[a-z0-9])?$` · 1–50 characters
`name`	`string`	1–200 characters
`description`	`string`	may be null
`websiteUrl`	`string`	may be null
`iconUrl`	`string`	may be null
`timezone`	`string`	at most 64 characters
`currency`	`string`	Pattern: `^[A-Z]{3}$`
`schemaMode`	`string`	Values: strict, lenient, discover
`attributionModel`	`string`	Values: first_touch, last_touch, last_non_direct, linear, position_based, time_decay, last_paid
`attributionWindowDays`	`integer`	1–365
`conversionRoles`	`string[]`	1–16 items
`leadContactClicks`	`boolean`
`retention`	`object`
`retention.eventsMonths`required	`integer`	1–120
`retention.interactionsMonths`required	`integer`	1–60
`retention.sessionsMonths`required	`integer`	1–120
`internalIpRanges`	`string[]`	at most 100 items
`internalCookie`	`string`	may be null
`revenueBasis`	`string`	Values: gross, net
`pricesIncludeTax`	`boolean`
`overviewTiles`	`OverviewTileRequest[]`	at most 12 items
`adsKpis`	`string[]`	at most 12 items
`modules`	`string[]`	at most 6 items
`defaultAlertRecipients`	`AlertRecipients`
`searchBrandTerms`	`string[]`	at most 50 items

`UpdateEventDefinitionRequestobject`

UpdateEventDefinitionRequest
Field	Type	Description
`displayName`	`string`	1–200 characters
`description`	`string`	may be null
`category`	`string`	may be null
`roles`	`string[]`	at most 16 items
`aliases`	`string[]`	at most 20 items
`properties`	`PropertyDefinitionInput[]`	at most 200 items
`displayNames`	`LocalizedNames`

`UpdateMessageCampaignRequestobject`

UpdateMessageCampaignRequest
Field	Type	Description
`name`	`string`	1–200 characters
`subject`	`string`	may be null
`preheader`	`string`	may be null
`body`	`string`	at most 20000 characters
`senderId`	`string`	may be null
`audience`	`object`
`audience.listIds`	`string[]`	at most 20 items · Default: []
`audience.segmentId`	`string`	may be null
`locale`	`string`	Values: tr, en
`throttlePerMinute`	`integer`	may be null
`utmSource`	`string`	1–100 characters

`UpdateSourceRequestobject`

UpdateSourceRequest
Field	Type	Description
`name`	`string`	1–200 characters
`environment`	`string`	Values: production, staging, development
`status`	`string`	Values: active, disabled
`requireSignature`	`boolean`
`allowedOrigins`	`string[]`	at most 100 items
`consentMode`	`string`	Values: required, implied, none
`excludedPaths`	`string[]`	at most 200 items
`maskSelectors`	`string[]`	at most 100 items
`ignoreSelectors`	`string[]`	at most 100 items
`stripQueryParams`	`string[]`	at most 100 items
`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[]`	at most 100 items

`UpdateTraitRequestobject`

UpdateTraitRequest
Field	Type	Description
`type`	`string`	Values: string, number, integer, boolean, datetime, money, currency, enum, object, array
`itemType`	`string`	may be null
`required`	`boolean`
`description`	`string`	may be null
`piiClass`	`string`	Values: none, pseudonymous, personal, sensitive
`piiAction`	`string`	Values: allow, hash, drop, reject
`enumValues`	`string[]`	may be null
`maxLength`	`integer`	may be null
`minimum`	`number`	may be null
`maximum`	`number`	may be null
`example`	`any`
`displayNames`	`LocalizedNames`

`UpsertContactRequestobject`

UpsertContactRequest
Field	Type	Description
`name`	`string`	may be null
`email`	`string`	may be null
`phone`	`string`	may be null
`mobile`	`string`	may be null
`landline`	`string`	may be null
`company`	`string`	may be null
`title`	`string`	may be null
`city`	`string`	may be null
`district`	`string`	may be null
`userId`	`string`	may be null
`locale`	`string`	may be null
`tags`	`string[]`	at most 30 items
`consents`	`object`
`consents.email`	`ConsentChange`
`consents.sms`	`ConsentChange`
`listIds`	`string[]`	at most 50 items

`UpsertContactResultobject`

UpsertContactResult
Field	Type	Description
`contactId`required	`Id`	Format: uuid
`created`required	`boolean`
`consents`required	`object`
`consents.email`required	`string`	Values: none, merchant, opt_in, opt_out
`consents.sms`required	`string`	Values: none, merchant, opt_in, opt_out