X Public Basic (Twitter): Most-used fields

X Public Basic (Twitter): Most-used fields#

The table below gives information about most-used fields that you can import from X Public Basic (Twitter). Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name

Adverity UI name

Description

Use in Adverity

Post

Post

Represents a single Tweet object from the X Public Basic (Twitter) API, encompassing all its associated data.

metric

attachments.media_keys

attachments.media_keys

A list of unique identifiers for media objects attached to the Tweet.

metric

attachments.media_source_tweet_id

attachments.media_source_tweet_id

The ID of the Tweet from which the attached media originated, if applicable.

dimension

attachments.poll_ids

attachments.poll_ids

A list of unique identifiers for polls attached to the Tweet.

dimension

author_id

author_id

The unique identifier of the user who authored the Tweet.

dimension

author_name

author_name

The display name of the user who authored the Tweet.

dimension

author_username

author_username

The username of the user who authored the Tweet.

dimension

context_annotations.domain.description

context_annotations.domain.description

A description of the domain associated with the context annotation.

dimension

context_annotations.domain.id

context_annotations.domain.id

The unique identifier of the domain associated with the context annotation.

metric

context_annotations.domain.name

context_annotations.domain.name

The name of the domain associated with the context annotation.

dimension

context_annotations.entity.description

context_annotations.entity.description

A description of the entity associated with the context annotation.

dimension

context_annotations.entity.id

context_annotations.entity.id

The unique identifier of the entity associated with the context annotation.

metric

context_annotations.entity.name

context_annotations.entity.name

The name of the entity associated with the context annotation.

dimension

conversation_id

conversation_id

The unique identifier of the conversation that the Tweet belongs to.

dimension

created_at

created_at

The timestamp indicating when the Tweet or user account was created.

dimension

description

description

The user’s profile description (bio).

dimension

edit_controls.editable_until

edit_controls.editable_until

The timestamp indicating when a Tweet can no longer be edited.

dimension

edit_controls.edits_remaining

edit_controls.edits_remaining

The number of remaining edits for a Tweet.

metric

edit_controls.is_edit_eligible

edit_controls.is_edit_eligible

A boolean value indicating whether the Tweet is eligible for editing.

dimension

edit_history_tweet_ids

edit_history_tweet_ids

A list of Tweet IDs representing the edit history of the current Tweet.

dimension

entities.annotations.end

entities.annotations.end

The character position (zero-based) in the Tweet text where the annotation ends.

metric

entities.annotations.normalized_text

entities.annotations.normalized_text

The normalized text of the annotation, providing a standardized form of the annotated entity.

dimension

entities.annotations.probability

entities.annotations.probability

The confidence score assigned to the annotation, indicating the likelihood of its correctness.

metric

entities.annotations.start

entities.annotations.start

The character position (zero-based) in the Tweet text where the annotation begins.

metric

entities.annotations.type

entities.annotations.type

The type of entity identified by the annotation (e.g., ‘Person’, ‘Place’, ‘Organization’).

dimension

entities.description.mentions.end

entities.description.mentions.end

The ending index (zero-based) of a user mention within the user’s profile description.

metric

entities.description.mentions.start

entities.description.mentions.start

The starting index (zero-based) of a user mention within the user’s profile description.

metric

entities.description.mentions.username

entities.description.mentions.username

The username of the mentioned user in the user’s profile description.

dimension

entities.description.urls.display_url

entities.description.urls.display_url

The shortened URL as it appears in the user’s profile description.

dimension

entities.description.urls.end

entities.description.urls.end

The character position (zero-based) in the user’s profile description where the URL ends.

metric

entities.description.urls.expanded_url

entities.description.urls.expanded_url

The full, unshortened URL from the user’s profile description.

dimension

entities.description.urls.start

entities.description.urls.start

The character position (zero-based) in the user’s profile description where the URL begins.

metric

entities.description.urls.url

entities.description.urls.url

The original URL from the user’s profile description.

dimension

entities.hashtags

entities.hashtags

A list of hashtags included in the Tweet’s text, with their start and end positions.

dimension

entities.mentions

entities.mentions

A list of all user mentions included in the Tweet’s text, with their IDs, usernames, and text positions.

dimension

entities.mentions.end

entities.mentions.end

The ending index (zero-based) of the user mention within the Tweet’s text.

metric

entities.mentions.id

entities.mentions.id

The unique identifier of the mentioned user.

metric

entities.mentions.start

entities.mentions.start

The starting index (zero-based) of the user mention within the Tweet’s text.

metric

entities.mentions.username

entities.mentions.username

The username of the mentioned user.

dimension

entities.url.urls.display_url

entities.url.urls.display_url

The shortened URL as it appears in the user’s profile description.

dimension

entities.url.urls.end

entities.url.urls.end

The character position (zero-based) in the user’s profile description where the URL ends.

metric

entities.url.urls.expanded_url

entities.url.urls.expanded_url

The full, unshortened URL from the user’s profile description.

dimension

entities.url.urls.start

entities.url.urls.start

The character position (zero-based) in the user’s profile description where the URL begins.

metric

entities.url.urls.url

entities.url.urls.url

The original URL from the user’s profile description.

dimension

entities.urls.description

entities.urls.description

A description of the URL provided by the link’s metadata, if available.

dimension

entities.urls.display_url

entities.urls.display_url

The shortened URL as it appears in the Tweet text.

dimension

entities.urls.end

entities.urls.end

The character position (zero-based) in the Tweet text where the URL ends.

metric

entities.urls.expanded_url

entities.urls.expanded_url

The full, unshortened URL.

dimension

entities.urls.images

entities.urls.images

Information about images associated with the URL, such as thumbnails.

dimension

entities.urls.media_key

entities.urls.media_key

The unique identifier for the media associated with the URL, if it’s a media URL.

metric

entities.urls.start

entities.urls.start

The character position (zero-based) in the Tweet text where the URL begins.

metric

entities.urls.status

entities.urls.status

The HTTP status code returned when trying to resolve the URL.

metric

entities.urls.title

entities.urls.title

The title of the webpage linked by the URL, if available.

dimension

entities.urls.unwound_url

entities.urls.unwound_url

The final resolved URL after all redirects.

dimension

entities.urls.url

entities.urls.url

The original URL as it appears in the Tweet’s entities.

dimension

geo

geo

Geographical information associated with the Tweet, if available.

dimension

id

id

The unique identifier for the Tweet, user, or other object.

dimension

in_reply_to_user_id

in_reply_to_user_id

The unique identifier of the user this Tweet is in reply to.

dimension

lang

lang

The language of the Tweet, represented by a BCP47 language tag.

dimension

location

location

The user-provided location in their profile.

dimension

media_duration_ms

media_duration_ms

The duration of the media in milliseconds, for video and audio content.

metric

media_media_key

media_media_key

The unique identifier for a media object associated with the Tweet.

dimension

media_non_public_metrics

media_non_public_metrics

Non-public engagement metrics for the media attached to the Tweet, only available to the media owner.

metric

media_organic_metrics

media_organic_metrics

Organic (unpaid) engagement metrics for the media attached to the Tweet.

metric

media_preview_image_url

media_preview_image_url

The URL to a preview image of the attached media.

dimension

media_public_metrics

media_public_metrics

Public engagement metrics for the media attached to the Tweet, such as view counts.

metric

media_type

media_type

The type of media attached to the Tweet (e.g., ‘photo’, ‘video’, ‘gif’).

dimension

media_url

media_url

The URL of the media file.

dimension

name

name

The display name of the user.

dimension

non_public_metrics.engagements

non_public_metrics.engagements

Total non-public engagements with the Tweet, only available to the Tweet author.

metric

non_public_metrics.impression_count

non_public_metrics.impression_count

Non-public impression count for the Tweet, only available to the Tweet author.

metric

non_public_metrics.url_link_clicks

non_public_metrics.url_link_clicks

The number of non-public clicks on URLs within the Tweet, only available to the Tweet author.

metric

non_public_metrics.user_profile_clicks

non_public_metrics.user_profile_clicks

The number of non-public clicks on the user’s profile from the Tweet, only available to the Tweet author.

metric

organic_metrics.impression_count

organic_metrics.impression_count

The number of organic (unpaid) impressions for the Tweet.

metric

organic_metrics.like_count

organic_metrics.like_count

The number of organic (unpaid) likes for the Tweet.

metric

organic_metrics.reply_count

organic_metrics.reply_count

The number of organic (unpaid) replies for the Tweet.

metric

organic_metrics.retweet_count

organic_metrics.retweet_count

The number of organic (unpaid) retweets for the Tweet.

metric

organic_metrics.url_link_clicks

organic_metrics.url_link_clicks

The number of organic (unpaid) clicks on URLs within the Tweet.

metric

organic_metrics.user_profile_clicks

organic_metrics.user_profile_clicks

The number of organic (unpaid) clicks on the user’s profile from the Tweet.

metric

pinned_tweet_attachments

pinned_tweet_attachments

A list of attachments (e.g., media keys, poll IDs) associated with the pinned Tweet.

dimension

pinned_tweet_author_id

pinned_tweet_author_id

The unique identifier of the user who authored the pinned Tweet on a user’s profile.

dimension

pinned_tweet_context_annotations

pinned_tweet_context_annotations

Contextual annotations (domains and entities) for the pinned Tweet.

dimension

pinned_tweet_conversation_id

pinned_tweet_conversation_id

The unique identifier of the conversation that the pinned Tweet belongs to.

dimension

pinned_tweet_created_at

pinned_tweet_created_at

The timestamp indicating when the pinned Tweet was created.

dimension

pinned_tweet_edit_history_tweet_ids

pinned_tweet_edit_history_tweet_ids

A list of Tweet IDs representing the edit history of the pinned Tweet.

dimension

pinned_tweet_entities

pinned_tweet_entities

Contains parsed entities (hashtags, mentions, URLs) present in the text of the pinned Tweet.

dimension

pinned_tweet_geo

pinned_tweet_geo

Geographical information associated with the pinned Tweet, if available.

dimension

pinned_tweet_id

pinned_tweet_id

The unique identifier of the Tweet pinned to the user’s profile.

dimension

pinned_tweet_in_reply_to_user_id

pinned_tweet_in_reply_to_user_id

The unique identifier of the user this pinned Tweet is in reply to.

dimension

pinned_tweet_lang

pinned_tweet_lang

The language of the pinned Tweet, represented by a BCP47 language tag.

dimension

pinned_tweet_non_public_metrics

pinned_tweet_non_public_metrics

Non-public engagement metrics for the pinned Tweet, only available to the Tweet author.

metric

pinned_tweet_organic_metrics

pinned_tweet_organic_metrics

Organic (unpaid) engagement metrics for the pinned Tweet.

metric

pinned_tweet_public_metrics

pinned_tweet_public_metrics

Public engagement metrics for the pinned Tweet, such as like, retweet, and reply counts.

metric

pinned_tweet_referenced_tweets

pinned_tweet_referenced_tweets

A list of Tweets referenced by the pinned Tweet (e.g., replies, quotes, retweets).

dimension

pinned_tweet_text

pinned_tweet_text

The full text content of the pinned Tweet.

dimension

possibly_sensitive

possibly_sensitive

A boolean indicating if the Tweet contains content that is considered potentially sensitive.

dimension

profile_image_url

profile_image_url

The URL of the user’s profile image.

dimension

protected

protected

Indicates whether the user’s Tweets are protected (private).

dimension

public_metrics.bookmark_count

public_metrics.bookmark_count

The number of times the Tweet has been bookmarked.

metric

public_metrics.followers_count

public_metrics.followers_count

The total number of followers the user has.

metric

public_metrics.following_count

public_metrics.following_count

The total number of users the user is following.

metric

public_metrics.impression_count

public_metrics.impression_count

The total number of impressions (views) the Tweet has received.

metric

public_metrics.like_count

public_metrics.like_count

The number of times the Tweet has been liked.

metric

public_metrics.listed_count

public_metrics.listed_count

The total number of public lists the user is a member of.

metric

public_metrics.media_count

public_metrics.media_count

The total number of media attachments (e.g., photos, videos) associated with a Tweet.

metric

public_metrics.quote_count

public_metrics.quote_count

The number of times the Tweet has been quoted.

metric

public_metrics.reply_count

public_metrics.reply_count

The number of replies the Tweet has received.

metric

public_metrics.retweet_count

public_metrics.retweet_count

The number of times the Tweet has been retweeted.

metric

public_metrics.tweet_count

public_metrics.tweet_count

The total number of Tweets published by the user.

metric

referenced_tweets.id

referenced_tweets.id

The unique identifier of a Tweet referenced by the current Tweet.

metric

referenced_tweets.type

referenced_tweets.type

The type of reference to another Tweet (e.g., ‘replied_to’, ‘retweeted’, ‘quoted’).

dimension

report_date

report_date

dimension

text

text

The full text content of the Tweet.

dimension

type

type

Indicates the type of media attached to a Tweet, such as photo, video, or GIF.

dimension

url

url

The URL provided by the user in their profile description.

dimension

username

username

The unique username of the user.

dimension

verified

verified

Indicates whether the user’s account is verified.

dimension