概要
用語
- 認可済みアカウント: あなたのX developer appに、そのアカウントへのアクセスを許可したXアカウント(どのapp permission levelでもPostのmetricsへアクセス可能)。
- 所有アカウント: あなたのX developer appにリンクされたXアカウント。
- 公開metrics: X上で誰でも参照できる合計値(例: like数、リツイート数)。
- 非公開metrics: X上で一般には公開されない合計値(例: インプレッション数、動画視聴四分位)。利用にはOAuth 2.0またはOAuth 1.0aのユーザーコンテキスト認証が必要。
- オーガニックmetrics: オーガニックなcontext(通常の投稿・閲覧)に紐づく公開・非公開metricsのグループ。利用にはOAuth 2.0またはOAuth 1.0aのユーザーコンテキスト認証が必要。
- プロモーションmetrics: プロモーションのcontext(広告キャンペーンの一環として投稿・閲覧)に紐づく公開・非公開metricsのグループ。利用にはOAuth 2.0またはOAuth 1.0aのユーザーコンテキスト認証に加え、そのPostが広告でプロモーションされている必要がある。
利用可能なメトリクス
指標 | API 表現 | 説明 |
---|---|---|
Impressions | data.non_public_metrics.impression_count , data.organic_metrics.impression_count , data.promoted_metrics.impression_count | Post が閲覧された回数(ユーザー単位のユニークではありません)。Post の一部でも画面に表示されれば 1 回としてカウントされます。OAuth 1.0a ユーザーコンテキスト認証が必要です。 |
リツイート | data.public_metrics.retweet_count , data.organic_metrics.retweet_count , data.promoted_metrics.retweet_count | Post がリツイートされた回数。Quote Tweets(「コメント付きリツイート」)は含まれません。X クライアントに表示される「リツイートとコメント」の合計を取得するには、retweet_count と quote_count を合算してください。 |
Quote Tweets | data.public_metrics.quote_count | Post が新しいコメント(メッセージ)付きでリツイートされた回数。広告配信(有料)コンテキストでの Quote Tweets は存在しないため、すべてオーガニックです。 |
いいね | data.public_metrics.like_count , data.organic_metrics.like_count , data.promoted_metrics.like_count | Post が「like」された回数。public_metrics フィールドは、X 上で公開される表示と整合するよう、オーガニックおよび有料コンテキストの「like」の合計値を返します。 |
返信 | data.public_metrics.reply_count , data.organic_metrics.reply_count , data.promoted_metrics.reply_count | Post に返信された回数。public_metrics フィールドは、オーガニックおよび有料コンテキストの合計値を返します。 |
URL リンククリック | data.non_public_metrics.url_link_clicks , data.organic_metrics.url_link_clicks , data.promoted_metrics.url_link_clicks | ユーザーが Post 内の URL リンクまたは URL プレビューカードをクリックした回数。OAuth 1.0a ユーザーコンテキスト認証が必要です。 |
ユーザープロフィールクリック | data.non_public_metrics.user_profile_clicks , data.organic_metrics.user_profile_clicks , data.promoted_metrics.user_profile_clicks | ユーザーが Post の一部(表示名、ユーザー名、プロフィール画像)をクリックした回数。OAuth 1.0a ユーザーコンテキスト認証が必要です。 |
動画再生数 | includes.media.public_metrics.view_count , includes.media.organic_metrics.view_count , includes.media.promoted_metrics.view_count | Post に含まれる動画が再生された回数。これは、当該動画が含まれるすべての Posts を横断して集計した再生数です。メディアの拡張 expansions=attachment.media_keys が必要です。 |
動画視聴クォータイル | includes.media.non_public_metrics.playback_0_count , includes.media.non_public_metrics.playback_25_count , includes.media.non_public_metrics.playback_50_count , includes.media.non_public_metrics.playback_75_count , includes.media.non_public_metrics.playback_100_count | 動画の各クォータイル到達まで再生したユーザー数。OAuth 1.0a ユーザーコンテキスト認証とメディアの拡張 expansions=attachment.media_keys が必要です。 |
metrics をリクエストする
公開metrics
$BEARER_TOKEN
は自身で生成した Bearer Token に置き換えてください。
tweet.fields=public_metrics
expansions=attachments.media_keys&media.fields=public_metrics
サンプルリクエスト
非公開メトリクス(非公開・オーガニックメトリクス)
tweet.fields=non_public_metrics,organic_metrics
expansions=attachments.media_keys&media.fields=non_public_metrics,organic_metrics