Postlip Metrics Tracking API

Ürünlerin Postlip Metrics'e olay göndermesi için sözleşme — Segment Tracking API Spec uyumlu (aynı uçlar, mesaj alanları ve kimlik doğrulama; Segment/RudderStack istemcileri host ayarıyla kullanılabilir). Ayrıntı ve örnekler: docs/api/tracking-api.md. Kimlik: kaynağın yazma anahtarı (pk_live_… / pk_test_…) HTTP Basic kullanıcı adı olarak, Authorization: Bearer ile ya da tarayıcı beacon'ında gövdede writeKey. Sunucu kaynakları isteği Metrics-Signature başlığıyla imzalar (kaynakta zorunlu kılınabilir). İdempotentlik: messageId — aynı gerçek olay için aynı kimliği üretin; tekrar eden mesaj bir kez saklanır.

Version 1.0.0OpenAPI 3.1.0Download the OpenAPI document

This page is generated at build time from docs/api/openapi/tracking.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://collect.metrics.example`	Tracking API
`http://localhost:7110`	Yerel geliştirme

Authentication

Name	Method	Description
`writeKeyBasic`	HTTP Basic	Kullanıcı adı = yazma anahtarı, şifre boş (Segment uyumlu).
`writeKeyBearer`	Bearer token (pk_…)	Yazma anahtarı.
`signature`	Header: Metrics-Signature	İstek imzası (sunucu kaynakları).

Limits

Limit	Value
Message size	at most 32 KB
Batch size	at most 500 KB
Messages per batch	at most 500
Timestamp in the past	at most 31 days
Timestamp in the future	at most 3600 s
Signature time window	±300 s
userId, anonymousId, groupId length	at most 200 characters
messageId length	at most 100 characters
Event name length	at most 200 characters
Elements in a layout ($layout)	at most 300
Click coordinate scale	0–1000 (of the document’s width and height)
Rate limit per source	60,000 messages a minute; above it 429 with Retry-After
Short burst allowance	at most 10,000 messages at once

Olay gönderimi

7 endpoints

track, identify, page, screen, group, alias ve toplu gönderim.

POST/v1/track

Olay (track)

Kullanıcının yaptığı bir eylem. event uygulamanın olay kataloğuna göre doğrulanır (strict/lenient/discover). $ ile başlayan adlar SDK sistem olaylarıdır (bkz. x-system-events).

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonTrackMessage

Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: track
`event`required	`string`	1–200 characters
`properties`	`object`	Free-form keys

Example · JSON

{
  "messageId": "string",
  "anonymousId": "string",
  "userId": "string",
  "timestamp": "2026-11-06T14:46:00+03:00",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  },
  "integrations": {},
  "type": "track",
  "event": "string",
  "properties": {}
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

POST/v1/identify

Kişiyi tanıt (identify)

Anonim kimliği kullanıcı kimliğine bağlar; traits kişi özellikleridir.

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonIdentifyMessage

Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: identify
`traits`	`object`	Free-form keys

Example · JSON

{
  "messageId": "string",
  "anonymousId": "string",
  "userId": "string",
  "timestamp": "2026-11-06T14:46:00+03:00",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  },
  "integrations": {},
  "type": "identify",
  "traits": {}
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

POST/v1/page

Sayfa görüntüleme (page)

Web sayfası görüntüleme. properties.url ya da context.page.url gönderin.

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonPageMessage

Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: page
`name`	`string`	at most 500 characters
`category`	`string`	at most 200 characters
`properties`	`object`	Free-form keys

Example · JSON

{
  "messageId": "string",
  "anonymousId": "string",
  "userId": "string",
  "timestamp": "2026-11-06T14:46:00+03:00",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  },
  "integrations": {},
  "type": "page",
  "name": "string",
  "category": "string",
  "properties": {}
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

POST/v1/screen

Ekran görüntüleme (screen)

Mobil uygulama ekranı.

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonScreenMessage

Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: screen
`name`	`string`	at most 500 characters
`category`	`string`	at most 200 characters
`properties`	`object`	Free-form keys

Example · JSON

{
  "messageId": "string",
  "anonymousId": "string",
  "userId": "string",
  "timestamp": "2026-11-06T14:46:00+03:00",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  },
  "integrations": {},
  "type": "screen",
  "name": "string",
  "category": "string",
  "properties": {}
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

POST/v1/group

Hesaba bağla (group)

Kişiyi bir hesaba (şirket, büro, site…) bağlar; traits hesap özellikleridir.

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonGroupMessage

Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: group
`groupId`required	`string \| number`
`traits`	`object`	Free-form keys

Example · JSON

{
  "messageId": "string",
  "anonymousId": "string",
  "userId": "string",
  "timestamp": "2026-11-06T14:46:00+03:00",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  },
  "integrations": {},
  "type": "group",
  "groupId": "string",
  "traits": {}
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

POST/v1/alias

Kimlik birleştir (alias)

previousId ile userId aynı kişidir.

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonAliasMessage

Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`required	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: alias
`previousId`required	`string \| number`

Example · JSON

{
  "messageId": "string",
  "anonymousId": "string",
  "userId": "string",
  "timestamp": "2026-11-06T14:46:00+03:00",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  },
  "integrations": {},
  "type": "alias",
  "previousId": "string"
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

POST/v1/batch

Toplu gönderim (batch)

En fazla 500 mesaj, karışık tiplerde; her mesajda type zorunlu. Tarayıcıdan text/plain gövdeyle ve writeKey gövdede gönderilebilir (CORS ön isteği yok).

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request bodyBody required

application/jsonBatchRequest

Field	Type	Description
`batch`required	`(TrackMessage \| IdentifyMessage \| PageMessage \| ScreenMessage \| GroupMessage \| AliasMessage)[]`	1–500 items
`writeKey`	`string`	Yalnız tarayıcı beacon'ı için (başlık gönderilemediğinde).
`sentAt`	`string`	Format: date-time
`context`	`Context`	Kendi `context`'i olmayan mesajlara uygulanır.

Example · JSON

{
  "batch": [
    {
      "type": "track",
      "event": "string"
    }
  ],
  "writeKey": "string",
  "sentAt": "2026-11-06T14:46:00+03:00",
  "context": {
    "ip": "string",
    "userAgent": "string"
  }
}

text/plainstring

Aynı JSON, metin olarak (tarayıcı beacon).

Responses

200

İşlendi.

application/jsonTrackingResponse

Example · JSON

{
  "success": true,
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "errors": [
        {
          "code": "invalid_message",
          "path": "string",
          "message": "string"
        }
      ]
    }
  ],
  "warnings": [
    {
      "index": 0,
      "code": "invalid_message",
      "path": "string"
    }
  ]
}

400
Gövde okunamadı ya da bütün mesajlar reddedildi (all_rejected, rejected listesiyle). Tekrar etmeyin.
application/jsonRefusal
401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal
403
Origin kaynağın izinli alan adlarında değil (origin_not_allowed).
application/jsonRefusal
413
Mesaj > 32 KB ya da parti > 500 KB / 500 mesaj. Partiyi bölün.
application/jsonRefusal
429
Kaynağın hız sınırı aşıldı (rate_limited; mesaj sayısıyla, varsayılan dakikada 60.000, bir anda 10.000): hiçbir mesaj saklanmadı. Retry-After saniye bekleyip aynı partiyi yeniden gönderin.
Response headers
- Retry-Afterinteger
  Yeniden denemeden önce beklenecek saniye.
  at least 1
application/jsonRefusal
5XX
Geçici hata: üstel geri çekilmeyle tekrar deneyin (1 dk, 5 dk, 30 dk, 2 sa… en fazla 24 sa).

Kurulum

4 endpoints

Bağlantı testi, SDK uzak yapılandırması, web SDK paketi, sağlık.

POST/v1/ping

Bağlantı testi

Anahtarı ve (gönderildiyse ya da kaynak istiyorsa) imzayı doğrular; hiçbir şey kaydetmez. Gövde {}.

Authentication: writeKeyBasic or writeKeyBearer or writeKeyBasic + signature

Parameters

Name	In	Type	Description
`Metrics-Signature`	header	`string`	`t=<unix saniye>,v1=<hex>`; v1 = HMAC-SHA256(imza anahtarı `sk_…`, `t + "." + hamGövde`). ±300 sn. Anahtar yenilenirken birden çok `v1=` olabilir. Pattern: `^t=\d{1,12}(,v1=[0-9a-fA-F]{64})+$`

Request body

application/jsonobject

Example · JSON

{}

Responses

200

Anahtar (ve imza) geçerli.

application/jsonPingResponse

Example · JSON

{
  "success": true,
  "sourceId": "string",
  "appId": "string",
  "environment": "string",
  "test": true,
  "signature": "valid"
}

401
Anahtar yok/yanlış (missing_key, invalid_key) ya da imza (signature_required, signature_invalid, signature_expired). Anahtarı ve sunucu saatini denetleyin.
application/jsonRefusal

GET/v1/config/{writeKey}

SDK uzak yapılandırması

Panelde kaynak için yapılan yakalama ayarları (hariç yollar, rıza kipi, otomatik yakalama, örnekleme…). ttlSeconds kadar önbelleğe alınabilir; istek başarısızsa SDK varsayılanlarla çalışır.

Authentication: No authentication

Parameters

Name	In	Type	Description
`writeKey`required	path	`string`	Kaynağın yazma anahtarı (`pk_…`).
`schemaHints`	query	`string`	`1`: yanıtta ayrıca `schemaHints` — uygulamanın olay planının özeti (planlanmış olaylar ve zorunlu özellikleri, engellenen olaylar, şema kipi). Web SDK debug kipinde ister; parametresiz yanıt değişmez. Values: 1

Responses

200

Yapılandırma.

application/jsonRemoteConfig

Example · JSON

{
  "sourceId": "string",
  "appId": "string",
  "kind": "web",
  "environment": "production",
  "test": true,
  "ttlSeconds": 1,
  "consentMode": "required",
  "excludedPaths": [
    "string"
  ],
  "maskSelectors": [
    "string"
  ],
  "ignoreSelectors": [
    "string"
  ],
  "stripQueryParams": [
    "string"
  ],
  "sessionTimeoutMinutes": 5,
  "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"
  ],
  "schemaHints": {
    "mode": "strict",
    "events": [
      {
        "name": "string",
        "required": []
      }
    ],
    "blocked": [
      "string"
    ],
    "truncated": true
  }
}

404
Anahtar tanınmadı.
application/jsonRefusal

Schemas

Schemas that requests and responses refer to by name.

`TrackingResponseobject`

TrackingResponse
Field	Type	Description
`success`required	`boolean`	Constant: true
`accepted`required	`integer`	Mesajlardan kabul edilenlerin sayısı (tekrar edenler dahil; tekrar eden bir kez saklanır).
`rejected`required	`object[]`	Reddedilenler. Düzeltmeden tekrar göndermeyin.
`rejected[].index`required	`integer`
`rejected[].messageId`	`string`
`rejected[].errors`required	`object[]`
`rejected[].errors[].code`required	`string`	Values: invalid_message, unknown_type, event_name_missing, identity_missing, event_unplanned, event_blocked, property_required, property_type, property_unplanned, property_too_long, pii_detected, timestamp_invalid, timestamp_out_of_range, message_too_large, currency_unknown, property_out_of_range
`rejected[].errors[].path`required	`string`
`rejected[].errors[].message`required	`string`
`warnings`required	`object[]`	Kabul edildi ama dikkat: planlanmamış özellik, kişisel veri maskelendi…
`warnings[].index`required	`integer`
`warnings[].code`required	`string`	Values: invalid_message, unknown_type, event_name_missing, identity_missing, event_unplanned, event_blocked, property_required, property_type, property_unplanned, property_too_long, pii_detected, timestamp_invalid, timestamp_out_of_range, message_too_large, currency_unknown, property_out_of_range
`warnings[].path`required	`string`

`Refusalobject`

Refusal
Field	Type	Description
`success`required	`boolean`	Constant: false
`error`required	`object`
`error.code`required	`string`
`error.message`required	`string`
`rejected`	`object[]`
`rejected[].index`required	`integer`
`rejected[].messageId`	`string`
`rejected[].errors`required	`object[]`
`rejected[].errors[].code`required	`string`	Values: invalid_message, unknown_type, event_name_missing, identity_missing, event_unplanned, event_blocked, property_required, property_type, property_unplanned, property_too_long, pii_detected, timestamp_invalid, timestamp_out_of_range, message_too_large, currency_unknown, property_out_of_range
`rejected[].errors[].path`required	`string`
`rejected[].errors[].message`required	`string`

`PingResponseobject`

PingResponse
Field	Type	Description
`success`required	`boolean`	Constant: true
`sourceId`required	`string`
`appId`required	`string`
`environment`required	`string`
`test`required	`boolean`
`signature`required	`string`	Values: valid, absent

`RemoteConfigobject`

RemoteConfig
Field	Type	Description
`sourceId`required	`string`
`appId`required	`string`
`kind`required	`string`	Values: web, ios, android, server, other
`environment`required	`string`	Values: production, staging, development
`test`required	`boolean`
`ttlSeconds`required	`integer`	above 0
`consentMode`required	`string`	Values: required, implied, none
`excludedPaths`required	`string[]`
`maskSelectors`required	`string[]`
`ignoreSelectors`required	`string[]`
`stripQueryParams`required	`string[]`
`sessionTimeoutMinutes`required	`integer`	5–240
`interactionSampleRate`required	`number`	0–1
`autocapture`required	`object`
`autocapture.pageviews`required	`boolean`
`autocapture.pageleave`required	`boolean`
`autocapture.clicks`required	`boolean`
`autocapture.rageClicks`required	`boolean`
`autocapture.deadClicks`required	`boolean`
`autocapture.scroll`required	`boolean`
`autocapture.errors`required	`boolean`
`autocapture.forms`required	`boolean`
`autocapture.layout`required	`boolean`
`autocapture.outboundLinks`required	`boolean`
`autocapture.downloads`required	`boolean`
`autocapture.webVitals`required	`boolean`
`dataLayerEvents`required	`string[]`
`schemaHints`	`object`
`schemaHints.mode`required	`string`	Values: strict, lenient, discover
`schemaHints.events`required	`object[]`
`schemaHints.events[].name`required	`string`
`schemaHints.events[].required`required	`string[]`
`schemaHints.blocked`required	`string[]`
`schemaHints.truncated`required	`boolean`

`Contextobject`

Context
Field	Type	Description
`ip`	`string`	at most 64 characters
`userAgent`	`string`	at most 1000 characters
`locale`	`string`	at most 35 characters
`timezone`	`string`	at most 64 characters
`groupId`	`string \| number`
`traits`	`object`	Free-form keys
`page`	`object`
`page.url`	`string`	at most 4000 characters
`page.path`	`string`	at most 2000 characters
`page.title`	`string`	at most 1000 characters
`page.referrer`	`string`	at most 4000 characters
`page.search`	`string`	at most 2000 characters
`campaign`	`object`
`campaign.source`	`string`	at most 200 characters
`campaign.medium`	`string`	at most 200 characters
`campaign.name`	`string`	at most 300 characters
`campaign.content`	`string`	at most 300 characters
`campaign.term`	`string`	at most 300 characters
`campaign.id`	`string`	at most 200 characters
`app`	`object`
`app.name`	`string`	at most 200 characters
`app.version`	`string`	at most 100 characters
`app.build`	`string`	at most 100 characters
`app.namespace`	`string`	at most 300 characters
`device`	`object`
`device.type`	`string`	at most 50 characters
`device.manufacturer`	`string`	at most 100 characters
`device.model`	`string`	at most 100 characters
`device.id`	`string`	at most 200 characters
`device.advertisingId`	`string`	at most 200 characters
`os`	`object`
`os.name`	`string`	at most 100 characters
`os.version`	`string`	at most 100 characters
`screen`	`object`
`screen.width`	`number`	at least 0
`screen.height`	`number`	at least 0
`screen.density`	`number`	above 0
`library`	`object`
`library.name`	`string`	at most 100 characters
`library.version`	`string`	at most 50 characters
`viewport`	`object`
`viewport.width`	`number`	at least 0
`viewport.height`	`number`	at least 0
`clickIds`	`object`
`clickIds.gclid`	`string`	at most 500 characters
`clickIds.gbraid`	`string`	at most 500 characters
`clickIds.wbraid`	`string`	at most 500 characters
`clickIds.dclid`	`string`	at most 500 characters
`clickIds.fbclid`	`string`	at most 500 characters
`clickIds.fbc`	`string`	at most 500 characters
`clickIds.fbp`	`string`	at most 500 characters
`clickIds.li_fat_id`	`string`	at most 500 characters
`clickIds.msclkid`	`string`	at most 500 characters
`clickIds.ttclid`	`string`	at most 500 characters
`clickIds.yclid`	`string`	at most 500 characters
`clickIds.gclid_at`	`string \| number`
`attribution`	`object`
`attribution.first_touch`	`object`
`attribution.first_touch.source`	`string`	at most 200 characters
`attribution.first_touch.medium`	`string`	at most 200 characters
`attribution.first_touch.campaign`	`string`	at most 300 characters
`attribution.first_touch.content`	`string`	at most 300 characters
`attribution.first_touch.term`	`string`	at most 300 characters
`attribution.first_touch.campaign_id`	`string`	at most 200 characters
`attribution.first_touch.landing_path`	`string`	at most 2000 characters
`attribution.first_touch.referrer_host`	`string`	at most 300 characters
`attribution.first_touch.at`	`string`	Format: date-time
`attribution.last_non_direct_touch`	`object`
`attribution.last_non_direct_touch.source`	`string`	at most 200 characters
`attribution.last_non_direct_touch.medium`	`string`	at most 200 characters
`attribution.last_non_direct_touch.campaign`	`string`	at most 300 characters
`attribution.last_non_direct_touch.content`	`string`	at most 300 characters
`attribution.last_non_direct_touch.term`	`string`	at most 300 characters
`attribution.last_non_direct_touch.campaign_id`	`string`	at most 200 characters
`attribution.last_non_direct_touch.landing_path`	`string`	at most 2000 characters
`attribution.last_non_direct_touch.referrer_host`	`string`	at most 300 characters
`attribution.last_non_direct_touch.at`	`string`	Format: date-time
`attribution.session_touch`	`object`
`attribution.session_touch.source`	`string`	at most 200 characters
`attribution.session_touch.medium`	`string`	at most 200 characters
`attribution.session_touch.campaign`	`string`	at most 300 characters
`attribution.session_touch.content`	`string`	at most 300 characters
`attribution.session_touch.term`	`string`	at most 300 characters
`attribution.session_touch.campaign_id`	`string`	at most 200 characters
`attribution.session_touch.landing_path`	`string`	at most 2000 characters
`attribution.session_touch.referrer_host`	`string`	at most 300 characters
`attribution.session_touch.at`	`string`	Format: date-time
`attribution.method`	`string`	Values: consent, same_visit
`consent`	`object`
`consent.analytics`required	`boolean`
`consent.marketing`required	`boolean`
`session`	`object`
`session.id`required	`string`	1–100 characters
`session.start`	`boolean`
`tab`	`object`
`tab.id`required	`string`	1–100 characters
`test`	`boolean`
`internal`	`boolean`
`ga`	`object`
`ga.clientId`	`string`	Pattern: `^\d{1,20}\.\d{1,20}$`
`ga.sessionId`	`string`	Pattern: `^\d{1,20}$`

`TrackMessageobject`

TrackMessage
Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: track
`event`required	`string`	1–200 characters
`properties`	`object`	Free-form keys

`IdentifyMessageobject`

IdentifyMessage
Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: identify
`traits`	`object`	Free-form keys

`PageMessageobject`

PageMessage
Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: page
`name`	`string`	at most 500 characters
`category`	`string`	at most 200 characters
`properties`	`object`	Free-form keys

`ScreenMessageobject`

ScreenMessage
Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: screen
`name`	`string`	at most 500 characters
`category`	`string`	at most 200 characters
`properties`	`object`	Free-form keys

`GroupMessageobject`

GroupMessage
Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: group
`groupId`required	`string \| number`
`traits`	`object`	Free-form keys

`AliasMessageobject`

AliasMessage
Field	Type	Description
`messageId`	`string`	Pattern: `^[\x21-\x7e]{1,100}$`
`anonymousId`	`string \| number`
`userId`required	`string \| number`
`timestamp`	`string`	Format: date-time
`sentAt`	`string`	Format: date-time
`context`	`Context`
`integrations`	`object`	Free-form keys
`type`	`string`	Constant: alias
`previousId`required	`string \| number`

`BatchRequestobject`

BatchRequest
Field	Type	Description
`batch`required	`(TrackMessage \| IdentifyMessage \| PageMessage \| ScreenMessage \| GroupMessage \| AliasMessage)[]`	1–500 items
`writeKey`	`string`	Yalnız tarayıcı beacon'ı için (başlık gönderilemediğinde).
`sentAt`	`string`	Format: date-time
`context`	`Context`	Kendi `context`'i olmayan mesajlara uygulanır.