POST /api/v1/client-api/metrics/conversion/

Dönüşüm verilerini getir

Kullanıcı eylemlerini analiz etmek ve zaman içinde pazarlama çalışmalarının etkinliğini ölçmek için dönüşüm verilerini getirir.

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

from_periodstring | nullrequired

Kullanıcının dönüşümdeki başlangıç abonelik durumu

to_periodstringrequired

Dönüşümün ardından kullanıcının yeni abonelik durumu

period_unitstring

Analiz verilerini toplamak için zaman aralığını belirtin

One of: "day", "week", "month", "quarter", "year"

date_typestring

Kullanıcının katılım tarihi olarak hangi tarihin kullanılacağını belirtin

One of: "purchase_date", "profile_install_date"

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"

formatstring

Dışa aktarma dosya biçimini belirtin

One of: "json", "csv"

Responses

Dönüşüm verileri başarıyla getirildi

Schema

Kullanıcıların abonelik durumları arasındaki geçişini gösteren dönüşüm verilerini içeren yanıt

dataarray of object

Dönüşüm veri noktalarından oluşan dizi (toplu metrikler için boş olabilir)

valuenumber

Dönüşüm oranı değeri

value_frominteger

Dönüşüm için başlangıç abonelik durumu

value_tointeger

Dönüşüm için hedef abonelik durumu

compare_value_fromnumber

Karşılaştırma dönemi için başlangıç değeri

compare_value_tonumber

Karşılaştırma dönemi için bitiş değeri

titlestring

Dönüşüm türünü açıklayan görüntüleme başlığı

typestring

Dönüşüm metriğinin türü

default_aggregationstring

Bu metrik için varsayılan toplama yöntemi

descriptionstring

Dönüşüm oranının nasıl hesaplandığına ilişkin ayrıntılı açıklama

metric_namestring

Dönüşüm metriğinin dahili adı

is_jsonboolean

Verinin JSON formatında olup olmadığı

unitstring

Ölçüm birimi (dönüşüm oranları için genellikle 'percent')

recommended_periodobject

Bu dönüşüm metriği için önerilen tarih aralığı

date_fromstring

Önerilen dönemin başlangıç tarihi

date_tostring

Önerilen dönemin bitiş tarihi

period_unitstring

Önerilen dönem birimi

Example

{
  "data": [],
  "value": 0,
  "value_from": 0,
  "value_to": 0,
  "compare_value_from": null,
  "compare_value_to": null,
  "title": "Conversion rate from Paid to more than 6 months",
  "type": "multi",
  "default_aggregation": "sum",
  "description": "If Х - the number of the 1st payments taken during the selected date, and Y - the amount of the renewals that happened after the 6 months since the selected date from those 1st payments, then Conversion = (Y / X) * 100%. For example, we had 100 1st subscriptions of various products on the 1st of January and among them 20 renewed on the 1st week of July (the 25th payment). On the 8th of July, we open the chart and see the conversion of the 1st of January = (20 / 100) * 100% = 20%. Then 30 more subscribers of the 1st of January renewed by the start of August (the 8th payment). We open the chart on the 1st of August and see that the conversion of the 1st of January = ((20+30) / 100) * 100% = 50%. This number shows which part of those who had their 1st payment on the 1st of January converted to the period > 6 months with any number of payments by the current moment.",
  "metric_name": "from_paid_to_6_months_conversion",
  "is_json": true,
  "unit": "percent",
  "recommended_period": {
    "date_from": "2018-04-29",
    "date_to": "2024-12-31",
    "period_unit": "month"
  }
}

Bad Request

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

Unauthorized

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

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

Try it

Authorization

Body

curl --request POST \
  --url 'https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "filters": {
      "date": [
        "2024-01-01",
        "2024-12-31"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }'

const response = await fetch('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', {
  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"
      ]
    },
    "from_period": 1,
    "to_period": "6+",
    "period_unit": "month",
    "date_type": "purchase_date",
    "segmentation": "country",
    "format": "json"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api-admin.adapty.io/api/v1/client-api/metrics/conversion/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "filters": {
        "date": [
          "2024-01-01",
          "2024-12-31"
        ]
      },
      "from_period": 1,
      "to_period": "6+",
      "period_unit": "month",
      "date_type": "purchase_date",
      "segmentation": "country",
      "format": "json"
    })
data = response.json()