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

分析データの取得

Copy as Markdown

チャートで使用するユーザー行動とパフォーマンス指標に関するインサイトのための分析データを取得します。

このエンドポイントの収益はイベントベースです。各値は取引日（購入、更新、または返金が発生した日）に帰属します。代わりに各ユーザーのインストール日に収益を帰属させる場合（例：Ads Managerとの照合）は、コホートエンドポイント（POST /api/v1/client-api/metrics/cohort/）を使用してください。

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

Request body

chart_idstringrequired

必要なチャートを指定します。1回のリクエストに指定できるチャートタイプは1つだけです。

One of: "revenue", "mrr", "arr", "arppu", "subscriptions_active", "subscriptions_new", "subscriptions_renewal_cancelled", "subscriptions_expired", "trials_active", "trials_new", "trials_renewal_cancelled", "trials_expired", "grace_period", "billing_issue", "refund_events", "refund_money", "non_subscriptions", "arpu", "installs"

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

period_unitstring

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

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

date_typestring

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

One of: "purchase_date", "profile_install_date"

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"

formatstring

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

One of: "json", "csv"

Responses

分析データが正常に取得されました

Schema

リクエストされたチャートタイプの分析データを含むレスポンス

dataobject

異なる指標タイプ（revenue、proceeds、net_revenue など）を含むオブジェクト

Example 
{
  "data": {
    "revenue": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    },
    "proceeds": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": null
    },
    "net_revenue": {
      "data": [],
      "value": 0,
      "value_from": null,
      "value_to": null,
      "compare_value_from": null,
      "compare_value_to": null,
      "title": "revenue",
      "type": "multi",
      "default_aggregation": "sum",
      "description": "<div>Total money received from both subscriptions and one-time purchases. Does not include\nrevenue from subscriptions and purchases that were refunded afterward. Calculated before the store's fee.<br />\nFor example, there were 5 monthly $10 subs, 1 yearly $100 sub and 10 one-time $50 purchases today,<br />\nrevenue = 5*$10 + 1*$100 + 10*$50 = $650</div>",
      "metric_name": "Revenue",
      "is_json": true,
      "unit": "USD",
      "recommended_period": 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リクエストです。