POST /api/v1/client-api/metrics/retention/

Retention verilerini al

Copy as Markdown

Bir ürünün kullanıcıları zaman içinde elde tutma yeteneğini analiz etmek için retention verilerini alır.

Hız sınırı: Saniyede 2 istek.

Request body

filtersobjectrequired

datearray of stringrequired

Grafik verilerini almak istediğiniz tarih veya zaman dilimini girin

compare_datearray of string

Karşılaştırma tarihini veya zaman dilimini girin

storearray of string

Satın alma işleminin gerçekleştiği uygulama mağazasına göre filtreleyin

countryarray of string

Satın alma işleminin gerçekleştiği ülkenin 2 harfli ülke koduna göre filtreleyin

store_product_idarray of string

Mağaza ön ekiyle biçimlendirilmiş ürün kimliği; örneğin <store>:<product_id> formatında app_store:premium_monthly veya temel planı olan bir Google aboneliği için play_store:premium_sub:monthly-base-plan. Mağaza ön eki olmayan yalın bir ürün kimliği kabul edilmez.

durationarray of string

Abonelik süresini belirtin

attribution_sourcearray of string

Attribution için kaynak entegrasyon

attribution_statusarray of string

Attribution'ın organik mi yoksa organik olmayan mı olduğunu gösterir

attribution_channelarray of string

İşleme yol açan pazarlama kanalı

attribution_campaignarray of string

İşlemi getiren pazarlama kampanyası

attribution_adgrouparray of string

İşlemi getiren attribution reklam grubu

attribution_adsetarray of string

İşleme yol açan attribution reklam seti

attribution_creativearray of string

Etkinliği ölçmek amacıyla izlenen bir reklam veya kampanyadaki belirli görsel ya da metin ögeleri

offer_categoryarray of string

Veri almak istediğiniz teklif kategorilerini belirtin

offer_typearray of string

Veri almak istediğiniz teklif türlerini belirtin

offer_idarray of string

Veri almak istediğiniz belirli teklifleri belirtin

placement_idarray of string

Veri almak istediğiniz placement'ların Adapty içindeki dahili kimlikleri — SDK'ya ilettiğiniz placement kimliği değil, placement'ın kontrol paneli URL'sindeki UUID

audience_idarray of string

Veri almak istediğiniz placement kitlelerinin Adapty içindeki dahili kimlikleri

paywall_idarray of string

Veri almak istediğiniz paywall'ların Adapty içindeki dahili kimlikleri — paywall'ın kontrol paneli URL'sindeki UUID

flow_idarray of string

Veri almak istediğiniz flow'ların Adapty içindeki dahili kimlikleri — flow'un kontrol paneli URL'sindeki UUID

flow_screen_idarray of string

Veri almak istediğiniz flow ekranları; her biri <flow_id>:<screen_id> formatında biçimlendirilmiş — örneğin 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall

segment_idarray of string

Veri almak istediğiniz segment'lerin Adapty içindeki dahili kimlikleri

segmentationstring

Verileri bu boyutun her değeri için ayrı bir seriye böler. Örneğin, flow_id her flow için ayrı bir seri döndürür ve placement_id her placement için ayrı bir seri döndürür.

One of: "period", "renewal_status", "cancellation_reason", "store_product_id", "country", "store", "paywall_id", "audience_id", "placement_id", "flow_id", "flow_screen_id", "segment_id", "duration", "offer_category", "offer_type", "offer_id", "attribution_source", "attribution_status", "attribution_channel", "attribution_campaign", "attribution_adgroup", "attribution_adset", "attribution_creative", "day", "week", "month", "year"

use_trialboolean

Deneme sürümünün kullanılıp kullanılmadığını belirten boolean değer

formatstring

Dışa aktarma dosya formatını belirtin

One of: "json", "csv"

Responses

Retention verileri başarıyla alındı

Schema

Zaman içinde kullanıcı etkileşimini gösteren tutma verilerini içeren yanıt

dataarray of object

Tutma veri noktaları dizisi (bazı tutma türleri için boş olabilir)

titlestring

Tutma metriği için görüntü başlığı

metric_namestring

Tutma metriğinin dahili adı

descriptionstring

Tutmanın nasıl hesaplandığının açıklaması (mutlak ve göreli değerler)

value_typestring

Tutma değerinin türü (mutlak veya göreli)

Example

{
  "data": [],
  "title": "Subscription retention",
  "metric_name": "Subscription retention",
  "description": "Absolute value is the amount of users who entered the current step - subscribed for a trial or paid for a subscription. Relative is calculated as a percentage of these users among those who got a trial. So it starts with 100% for the trial step.",
  "value_type": null
}

Geçersiz İstek

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Yetkisiz

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Hız sınırı aşıldı. Uygulamanın tüm API anahtarları tarafından paylaşılan, uygulama başına saniyede en fazla 2 istek.

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/retention/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ]
    },
    "segmentation": "store_product_id",
    "format": "csv"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/retention/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ],
      "compare_date": [
        "2023-01-01",
        "2023-12-31"
      ]
    },
    "segmentation": "store_product_id",
    "format": "csv"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/retention/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ],
        "compare_date": [
          "2023-01-01",
          "2023-12-31"
        ]
      },
      "segmentation": "store_product_id",
      "format": "csv"
    })
data = response.json()