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

コンバージョンデータの取得

Copy as Markdown

ユーザーアクションを分析し、マーケティング施策の効果を経時的に測定するためのコンバージョンデータを取得します。

レート制限: 1秒あたり2リクエスト。

Request body

filtersobjectrequired

datearray of stringrequired

チャートデータを取得する日付または期間を入力してください

compare_datearray of string

比較する日付または期間を入力してください

storearray of string

購入が行われたアプリストアでフィルタリングします

countryarray of string

購入が行われた国の2文字の国コードでフィルタリングします

store_product_idarray of string

ストア修飾子付きのプロダクトID。<store>:<product_id> の形式で指定します。例えば app_store:premium_monthly や、ベースプランを持つ Google サブスクリプションの場合は play_store:premium_sub:monthly-base-plan のように指定します。ストアプレフィックスのないプロダクトIDは拒否されます。

durationarray of string

サブスクリプションの期間を指定してください

attribution_sourcearray of string

アトリビューションのソースインテグレーション

attribution_statusarray of string

アトリビューションがオーガニックか非オーガニックかを示します

attribution_channelarray of string

トランザクションにつながったマーケティングチャネル

attribution_campaignarray of string

トランザクションをもたらしたマーケティングキャンペーン

attribution_adgrouparray of string

トランザクションをもたらしたアトリビューションの広告グループ

attribution_adsetarray of string

トランザクションにつながったアトリビューションの広告セット

attribution_creativearray of string

効果測定のために追跡される広告またはキャンペーン内の特定のビジュアルまたはテキスト要素

offer_categoryarray of string

データを取得するオファーカテゴリを指定してください

offer_typearray of string

データを取得するオファータイプを指定してください

offer_idarray of string

データを取得する特定のオファーを指定してください

from_periodstring | nullrequired

コンバージョンにおけるユーザーの開始サブスクリプション状態

to_periodstringrequired

コンバージョン後のユーザーの新しいサブスクリプション状態

period_unitstring

アナリティクスデータを集計する時間間隔を指定します

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

date_typestring

ユーザーの参加日として扱う日付を指定します

One of: "purchase_date", "profile_install_date"

segmentationstring

セグメンテーションの基準を設定します

formatstring

エクスポートファイルの形式を指定します

One of: "json", "csv"

Responses

コンバージョンデータが正常に取得されました

Schema

サブスクリプション状態間のユーザー進行を示すコンバージョンデータを含むレスポンス

dataarray of object

コンバージョンデータポイントの配列（集計指標の場合は空になることがあります）

valuenumber

コンバージョン率の値

value_frominteger

コンバージョンの開始サブスクリプション状態

value_tointeger

コンバージョンの目標サブスクリプション状態

compare_value_fromnumber

比較期間の開始値

compare_value_tonumber

比較期間の終了値

titlestring

コンバージョンタイプを説明する表示タイトル

typestring

コンバージョン指標のタイプ

default_aggregationstring

この指標のデフォルト集計方法

descriptionstring

コンバージョン率の計算方法に関する詳細な説明

metric_namestring

コンバージョン指標の内部名

is_jsonboolean

データがJSON形式かどうか

unitstring

測定単位（コンバージョン率の場合は通常「percent」）

recommended_periodobject

このコンバージョン指標に推奨される日付範囲

date_fromstring

推奨期間の開始日

date_tostring

推奨期間の終了日

period_unitstring

推奨される期間単位

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

リクエストが不正です

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

認証されていません

Schema

errorsarray of object

sourcestring

errorsarray of string

error_codestring

status_codeinteger

レート制限を超えました。APIキーごとに1秒あたり最大2リクエストです。

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()