Skip to main content
GET
Get Media analytics

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://api.x.com/2/oauth2/authorize
Token URL
https://api.x.com/2/oauth2/token
Scopes1
tweet.read
View all Posts you can see, including those from protected accounts.

Query Parameters

media_keys
string[]
required

A comma separated list of Media Keys. Up to 100 are allowed in a single request.

Required array length: 1 - 100 elements

The Media Key identifier for this attachment.

Pattern: ^([0-9]+)_([0-9]+)$
end_time
string<date-time>
required

YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the end of the time range.

start_time
string<date-time>
required

YYYY-MM-DDTHH:mm:ssZ. The UTC timestamp representing the start of the time range.

granularity
enum<string>
default:daily
required

The granularity for the search counts results.

Available options:
hourly,
daily,
total
media_analytics.fields
enum<string>[]

A comma separated list of MediaAnalytics fields to display. The fields available for a MediaAnalytics object.

Minimum array length: 1
Available options:
cta_url_clicks,
cta_watch_clicks,
media_key,
play_from_tap,
playback25,
playback50,
playback75,
playback_complete,
playback_start,
timestamp,
video_views,
watch_time_ms
Example:

Response

The request has succeeded.

data
object[]
errors
object[]
Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).