English 中文TürkçeРусскийFrançaisTiếng ViệtEspañol日本語
POST /api/v1/client-api/metrics/retention/

リテンションデータの取得

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

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

placement_idarray of string

データを取得するプレースメントの Adapty 内部ID。SDKに渡すプレースメントIDではなく、ダッシュボードURLに含まれるUUIDを指定してください。

audience_idarray of string

データを取得するプレースメントオーディエンスの Adapty 内部ID

paywall_idarray of string

データを取得するペイウォールの Adapty 内部ID。ダッシュボードURLに含まれるUUIDを指定してください。

flow_idarray of string

データを取得するフローの Adapty 内部ID。ダッシュボードURLに含まれるUUIDを指定してください。

flow_screen_idarray of string

データを取得するフロー画面。各項目は <flow_id>:<screen_id> の形式で指定します。例えば 3f8a1c2e-0b7d-4e5a-9c61-2d4f8e7b1a90:paywall。

segment_idarray of string

データを取得するセグメントの Adapty 内部ID

segmentationstring

データをこのディメンションの値ごとに系列に分割します。例えば、flow_id はフローごとに個別の系列を返し、placement_id はプレースメントごとに個別の系列を返します。

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

トライアルが使用されたかどうかを示すブール値

formatstring

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

One of: "json", "csv"

Responses

リテンションデータが正常に取得されました

Schema

ユーザーエンゲージメントの経時変化を示すリテンションデータを含むレスポンス

dataarray of object

リテンションデータポイントの配列（リテンションの種類によっては空になる場合があります）

titlestring

リテンション指標の表示タイトル

metric_namestring

リテンション指標の内部名

descriptionstring

リテンションの計算方法の説明（絶対値または相対値）

value_typestring

リテンション値の種類（絶対値または相対値）

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
}

リクエストが不正です

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リクエストです。