Metrics
X (Twitter) metrics via API
Your customer connects their X (Twitter) account and your product queries 17 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"comparison_start": "2026-09-01",
"comparison_end": "2026-09-30",
"metrics": [
{
"id": "m1",
"reference_key": "twitter:followers_count",
"component": "number_v1",
"metrics": [
"followers_count"
],
"dimensions": [
"user"
]
}
]
}More X (Twitter) request examples
The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).
Chart
Total Engagement Over Time
This graph shows the total number of daily engagements received by your posted tweets during the analysis period. This includes all clicks anywhere on the Tweet (including links, avatar and username), retweets, quotes, replies and likes. This metric does not consider follows, hashtag clicks, and tweet expansions.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "twitter:total_engagement_over_time",
"component": "chart_v1",
"metrics": [
"total_engagement_over_time"
],
"dimensions": [
"tweets"
]
}
]
}Table
Featured tweets
Performance summary of Tweets posted during the review period.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "twitter:featured_tweets",
"component": "datatable_v1",
"metrics": [
"tweets_impression",
"tweets_engagement",
"tweets_epi",
"tweets_likes",
"tweets_replies",
"tweets_retweets",
"tweets_clicks",
"profile_clicks",
"created_at"
],
"dimensions": [
"tweets"
]
}
]
}Number
Tweets
Total number of tweets made in your account, in the analyzed period. This metric does not include replies to tweets.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "twitter:only_tweets_count",
"component": "number_v1",
"metrics": [
"only_tweet_count"
],
"dimensions": [
"tweets"
]
}
]
}Numbers
10 metrics
Number of Followers
Total number of followers on your account
twitter:followers_countTweets
Total number of tweets made in your account, in the analyzed period. This metric does not include replies to tweets.
twitter:only_tweets_countTotal Tweets
Total number of tweets made in your account during the analyzed period. This metric considers replies to Tweets.
twitter:total_tweets_countTotal Impressions
Total number of views of your posted Tweets during the review period.
twitter:total_impressions_countTweets Impressions
Number of times a user received a Tweet, posted during the analysis period, on the timeline or in search results. This metric doesn't consider responses to Tweets.
twitter:tweets_impressions_countTotal Engagement
Total number of times users interacted with a posted tweet during the analysis period. This includes all clicks anywhere on the Tweet (including links, avatar and username), retweets, quotes, replies and likes. This metric doesn't consider follows, hashtag clicks, and tweet expansions.
twitter:total_engagementTweets Engagement
Number of times a user interacted with a Tweet (clicks, retweets, replies, quotes and likes) during the analyzed period. This metric doesn't consider interactions in responses.
twitter:tweets_engagementEngagement rate
The number of engagements (clicks, retweets, replies, quotes and likes) divided by the total number of impressions.
twitter:total_engagement_rateTweets engagement rate
The total number of engagements (clicks, retweets, responses, quotes, and likes) divided by the total number of impressions. This metric doesn't consider interactions in responses.
twitter:tweets_engagement_rateMentions
Total number of times your account was mentioned during the review period.
twitter:mentions
Charts
6 metrics
Total Engagement Over Time
This graph shows the total number of daily engagements received by your posted tweets during the analysis period. This includes all clicks anywhere on the Tweet (including links, avatar and username), retweets, quotes, replies and likes. This metric does not consider follows, hashtag clicks, and tweet expansions.
twitter:total_engagement_over_timeTweet Engagement Over Time
This graph shows the number of daily engagements received by your posted tweets during the analysis period. Engagement includes clicks, retweets, replies, quotes, and likes, but doesn't consider interactions in replies.
twitter:tweets_engagement_over_timeTotal Impressions of Tweets over time
This graph shows the total number of views of your posted Tweets during the analysis period.
twitter:total_impressions_over_timeImpressions of Tweets over time
This graph shows the number of times a user received a Tweet posted during the analysis period, either on the timeline or in search results. Replies to Tweets are not considered.
twitter:tweets_impressions_over_timeTweet Engagement Rate Over Time
This graph shows how the tweet engagement rate varied during the analysis period. The rate is the total number of Tweet engagements (clicks, retweets, replies, quotes and likes) divided by the total number of impressions. This metric doesn't consider interactions in responses. This metric is an estimate.
twitter:tweets_engagement_rate_over_timeTotal Engagement Rate Over Time
This graph shows how the total engagement rate varied during the analysis period. The engagement rate is the total number of engagements (clicks, retweets, replies, quotes and likes) divided by the total number of impressions. This metric is an estimate.
twitter:total_engagement_rate_over_time
Tables
1 metric
Featured tweets
Performance summary of Tweets posted during the review period.
twitter:featured_tweets
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
