​

Overview

The metrics field allows developers to access public and private engagement metrics for Post and media objects. Public metrics are accessible by anyone with a developer account, while private metrics are accessible from owned/authorized accounts (definition below). Metrics include the total count of impressions, Retweets, Quote Tweets, likes, replies, video views, video view quartiles, URL and profile link clicks for each Post specified in the request. There is also the option to view a breakdown of metrics earned in an organic or promoted context, if the Post was promoted as an Ad.

Public metrics can be requested with App-only Token authentication. Non-public metrics can be requested for owned/authorized Posts only, meaning developers need to authenticate using OAuth 2.0 or OAuth 1.0a user context authorization.

Non-public, organic, and promoted metrics are only available for Posts created within the last 30 days.

​

Terminology

• Authorized account: An X account that has authorized your X developer app by granting it access to that account (any app permission level will permit access to Post metrics).
• Owned account: An X account linked to your X developer app.
• Public metrics: Totals that are available for anyone to access on X, such as the number of likes and number of Retweets.
• Non-public metrics: Totals not available for public viewing on X, such as the number of impressions and video view quartiles. Requires OAuth 2.0 or OAuth 1.0a user context authentication.
• Organic metrics: A grouping of public and non-public metrics attributed to an organic context (posted and viewed in a regular manner). Requires OAuth 2.0 or OAuth 1.0a user context authentication.
• Promoted metrics: A grouping of public and non-public metrics attributed to a promoted context (posted or viewed as part of an Ads campaign). Requires OAuth 2.0 or OAuth 1.0a user context authentication and that the Post was promoted in an Ad.

​

Available Metrics

​

Requesting Metrics

​

Public Metrics

In the following request, we are requesting public metrics on the Post and on the attached video with the following fields and expansion. Be sure to replace $BEARER_TOKEN with your own generated bearer token.

• tweet.fields=public_metrics
• expansions=attachments.media_keys&media.fields=public_metrics

​

Sample Request

curl 'https://api.x.com/2/tweets?ids=1204084171334832128&tweet.fields=public_metrics&expansions=attachments.media_keys&media.fields=public_metrics' --header 'Authorization: Bearer $BEARER_TOKEN'

​

Private Metrics (Non-public, Organic Metrics)

The following request asks for non-public metrics with additional details on organic metrics for the Post and attached video. Since these fields are private and not available for public view on X, the request requires OAuth 2.0 or OAuth 1.0a user context authentication. Refer to our guide for generating the OAuth 1.0a signature needed below.

• tweet.fields=non_public_metrics,organic_metrics
• expansions=attachments.media_keys&media.fields=non_public_metrics,organic_metrics

​

Sample Request

curl 'https://api.x.com/2/tweets/1204084171334832128?tweet.fields=non_public_metrics,organic_metrics&media.fields=non_public_metrics,organic_metrics&expansions=attachments.media_keys' --header 'authorization: OAuth oauth_consumer_key="CONSUMER_API_KEY", oauth_nonce="OAUTH_NONCE", oauth_signature="OAUTH_SIGNATURE", oauth_signature_method="HMAC-SHA1", oauth_timestamp="OAUTH_TIMESTAMP", oauth_token="ACCESS_TOKEN", oauth_version="1.0"'

​

Sample Response

{
  "data": {
    "attachments": {
      "media_keys": ["13_1204080851740315648"]
    },
    "id": "1263145271946551300",
    "non_public_metrics": {
      "impression_count": 956,
      "url_link_clicks": 9,
      "user_profile_clicks": 34
    },
    "organic_metrics": {
      "impression_count": 956,
      "like_count": 49,
      "reply_count": 2,
      "retweet_count": 9,
      "url_link_clicks": 9,
      "user_profile_clicks": 34
    },
    "text": "test"
  },
  "includes": {
    "media": [
      {
        "media_key": "13_1204080851740315648",
        "non_public_metrics": {
          "playback_0_count": 0,
          "playback_100_count": 1,
          "playback_25_count": 2,
          "playback_50_count": 1,
          "playback_75_count": 1
        },
        "organic_metrics": {
          "playback_0_count": 0,
          "playback_100_count": 1,
          "playback_25_count": 2,
          "playback_50_count": 1,
          "playback_75_count": 1,
          "view_count": 1
        },
        "type": "video"
      }
    ]
  }
}