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

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

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

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

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