Skip to content

Latest commit

 

History

History
114 lines (91 loc) · 4.62 KB

File metadata and controls

114 lines (91 loc) · 4.62 KB

StreamQueryParameters

Properties

Name Type Description Notes
backfillMinutes Integer The number of minutes of backfill requested. [optional]
tweetFields Collection<TweetField> A comma separated list of Tweet fields to display. [optional] [enum: attachments, author_id, context_annotations, conversation_id, created_at, entities, geo, id, in_reply_to_user_id, lang, non_public_metrics, organic_metrics, possibly_sensitive, promoted_metrics, public_metrics, referenced_tweets, reply_settings, source, text, withheld]
expansions Collection<Expansion> A comma separated list of fields to expand. [optional] [enum: attachments.media_keys, attachments.poll_ids, author_id, entities.mentions.username, geo.place_id, in_reply_to_user_id, referenced_tweets.id, referenced_tweets.id.author_id]
mediaFields Collection<MediaField> A comma separated list of Media fields to display. [optional] [enum: alt_text, duration_ms, height, media_key, non_public_metrics, organic_metrics, preview_image_url, promoted_metrics, public_metrics, type, url, variants, width]
pollFields Collection<PollField> A comma separated list of Poll fields to display. [optional] [enum: duration_minutes, end_datetime, id, options, voting_status]
userFields Collection<UserField> A comma separated list of User fields to display. [optional] [enum: created_at, description, entities, id, location, name, pinned_tweet_id, profile_image_url, protected, public_metrics, url, username, verified, withheld]
placeFields Collection<PlaceField> A comma separated list of Place fields to display. [optional] [enum: contained_within, country, country_code, full_name, geo, id, name, place_type]

Enum: TweetField

Name Value
ATTACHMENTS "attachments"
AUTHOR_ID "author_id"
CONTEXT_ANNOTATIONS "context_annotations"
CONVERSATION_ID "conversation_id"
CREATED_AT "created_at"
ENTITIES "entities"
GEO "geo"
ID "id"
IN_REPLY_TO_USER_ID "in_reply_to_user_id"
LANG "lang"
POSSIBLE_SENSITIVE "possibly_sensitive"
PUBLIC_METRICS "public_metrics"
REFERENCED_TWEETS "referenced_tweets"
REPLY_SETTINGS "reply_settings"
SOURCE "source"
TEXT "text"
WITHHELD "withheld"

Enum: Expansion

Name Value
ATTACHMENTS_MEDIA_KEYS "attachments.media_keys"
ATTACHMENTS_POLL_IDS "attachments.poll_ids"
AUTHOR_ID "author_id"
ENTITIES_MENTIONS_USERNAME "entities.mentions.username"
GEO_PLACE_ID "geo.place_id"
IN_REPLY_TO_USER_ID "in_reply_to_user_id"
REFERENCED_TWEETS_ID "referenced_tweets.id"
REFERENCED_TWEETS_ID_AUTHOR_ID "referenced_tweets.id.author_id"

Enum: MediaField

Name Value
ALT_TEXT "alt_text"
DURATION_MS "duration_ms"
HEIGHT "height"
MEDIA_KEY "media_key"
PREVIEW_IMAGE_URL "preview_image_url"
PUBLIC_METRICS "public_metrics"
TYPE "type"
URL "url"
VARIANTS "variants"
WIDTH "width"

Enum: PollField

Name Value
DURATION_MINUTES "duration_minutes"
END_DATETIME "end_datetime"
ID "id"
OPTIONS "options"
VOTING_STATUS "voting_status"

Enum: UserField

Name Value
CREATED_AT "created_at"
DESCRIPTION "description"
ENTITIES "entities"
ID "id"
LOCATION "location"
NAME "name"
PINNED_TWEET_ID "pinned_tweet_id"
PROFILE_IMAGE_URL "profile_image_url"
PROTECTED "protected"
PUBLIC_METRICS "public_metrics"
URL "url"
USERNAME "username"
VERIFIED "verified"
WITHHELD "withheld"

Enum: PlaceField

Name Value
CONTAINED_WITHIN "contained_within"
COUNTRY "country"
COUNTRY_CODE "country_code"
FULL_NAME "full_name"
GEO "geo"
ID "id"
NAME "name"
PLACE_TYPE "place_type"