|
1 | 1 | The user Tweet timeline endpoints provides access to Tweets published by a specific Twitter account. |
2 | 2 |
|
| 3 | +Each timeline endpoints may use the following parameters to filter out the timeline. Use these parameters to create |
| 4 | +a more specified timeline catered to your needs: |
| 5 | + |
| 6 | +- user_id: [String] User ID for the target user |
| 7 | +- start_time: [String] Earliest UTC timestamp for tweets, formatted as YYYY-MM-DDTHH:mm:ssZ. |
| 8 | +- end_time: [String] Most Recent UTC timestamp for tweets, formatted as YYYY-MM-DDTHH:mm:ssZ. |
| 9 | +- since_id: [String] Filter out tweets older than the "Since" tweet id |
| 10 | +- until_id: [String] Filter out tweets more recent than the "Until" tweet id |
| 11 | +- max_results: [Integer] Maximum number of tweets to be returned (Must be between 5 and 100) |
| 12 | +- pagination_token: [String] |
| 13 | +- tweet_fields: [Array] Specific information requested for the tweets. The response would include the additional information about each tweet. You simply have to list out the sub-parameters. |
| 14 | + - id: The unique Tweet ID |
| 15 | + - text: The actual UTF-8 text for the tweets |
| 16 | + - edit_history_tweet_ids: Array of unique IDs indicating all verions of tweet (initial version to most recent verison) |
| 17 | + - attachments: Specifies type of attachments present (Poll, Image, etc) in the tweet |
| 18 | + - author_id: User ID of tweet's author |
| 19 | + - context_annotations: Contains context annations for the tweet |
| 20 | + - conversation_id: Tweet ID of the original Tweet of the conversation (which includes replies, etc.) |
| 21 | + - created_at: Creation time of the tweet |
| 22 | + - edit_controls: Indiciates how much longer the Tweet can be edited, and the number of remaining edits |
| 23 | + - entities: Provides additional information about hashtags, urls, user mentions, and cashtags associated with tweet |
| 24 | + - in_reply_to_user_id: If the tweet is a reply, the field will contain the original Tweet's author ID |
| 25 | + - lang: Language of the tweet, if detected. Returned as BCP47 language tag |
| 26 | + - non_public_metrics: Non-public engagement metrics such as impression couunts, URL link clicks, User Profile Clicks |
| 27 | + - organic_metrics: Engagement metrics at time of request, such as like count, reply count, etc. |
| 28 | + - possible_senstive: Indicates if the tweet's content may be senstive |
| 29 | + - promoted_metrics: Engagement metrics in a promoted context (when Tweet is promoted) |
| 30 | + - public_metrics: Public engagement metric such as reply count, like count at time of request |
| 31 | + - referenced_tweets: List of Tweets that this tweet refers to whether it be a retweet, quoted tweet, etc. |
| 32 | + - reply_settings: Shows who can reply to the tweet (Everyone, mentioned users, followers) |
| 33 | + - withheld: Shows information for withheld content |
| 34 | +- exclude: [Array] Fields for what type of twets to exclude from response |
| 35 | +- expansions: [Array] Fields for the expansion |
| 36 | +- user_fields: [Array] Specific information requested for the requested user. The response would include the additional information about each user. You simply have to list out the sub-parameters. |
| 37 | + - id: User ID |
| 38 | + - name: Name of the user as shown on profile. Capped to 50 characters |
| 39 | + - username: User unique screen handle |
| 40 | + - connection_status: Get List of relations between user and user being looked up (Follow Request Received, Following, Muting, etc.) |
| 41 | + - created_at: UTC datetime that the user account was created |
| 42 | + - description: Text of the user's description/bio if provided |
| 43 | + - entities: Additional information about hashtags, urls, user mentions, and cashtags associated |
| 44 | + - location: Locations pecificed in user's profile if provided |
| 45 | + - pinned_tweet_id: Unique Tweet ID of user's pinned Tweet |
| 46 | + - profile_image_url: URL of the profile image for the user |
| 47 | + - protected: Indicates if the user's tweets are private |
| 48 | + - public_metrics: Contains information about user acitvity such as follower count, following count, tweet count, etc. |
| 49 | + - url: URL specified in user's profile, if present |
| 50 | + - verified: Indicates if user is a verified Twitter user |
| 51 | + - withheld: Contains withholding details for withheld content, if applicable |
| 52 | +- media_fields: [Array] Specific information requested for the requested media. The response would include the additional information about each media object. You simply have to list out the sub-parameters. |
| 53 | + - media_key: Unique ID for expanded media content |
| 54 | + - type: Type of content (animated gif, photo, videeo) |
| 55 | + - url: Direct URL to the media file on Twitter |
| 56 | + - duration_ms: Duration of media content if it's a video |
| 57 | + - height: Height of media content in pixels |
| 58 | + - non_public_metrics: Non-public engagement metrics for media content at time of request (playback count, etc.) |
| 59 | + - organic_metrics: Engagement metrics for media content, similar to non public metrics |
| 60 | + - preview_image_url: URL to the static placeholder preview of media content |
| 61 | + - promoted_metrics: Engagement metrics for media content that has been promoted |
| 62 | + - public_metrics: Public engagement metrics for the media content |
| 63 | + - width: Width of media content in pixels |
| 64 | + - alt_text: Description of image to enable and support accessibility. Up to 1000 characters long |
| 65 | + - variants: Each media object may have multiple display or playback variants, with different resolutions or formats |
| 66 | +- place_fields: [Array] Specific information requested for the places tagged in tweets. The response would include the additional information about each place. You simply have to list out the sub-parameters. |
| 67 | + - full_name: Longer-form detailed place name |
| 68 | + - id: Unique ID of expanded place |
| 69 | + - contained_within: Returns IDs of known places contianing referenced place |
| 70 | + - country: Full-length name of the coutunry the place belongs to |
| 71 | + - country_code: ISO Alpha-2 couutnry code the place belongs to |
| 72 | + - geo: Contains place details in GeoJSON format |
| 73 | + - name: Short name for the place |
| 74 | + - place_type: Type of place: city, town, etc. |
| 75 | +- poll_fields: [Array] Specific information requested for the requested poll in tweeets. The response would include the additional information about each poll object. You simply have to list out the sub-parameters. |
| 76 | + - id: Unique ID of expanded poll |
| 77 | + - options: Objects describing each choice in the poll |
| 78 | + - duration_minutes: Total duration of the poll |
| 79 | + - end_datetime: End date adn tiemf or poll in ISO-8601 format |
| 80 | + - voting_status: Indicates if the poll is still activie and can receive votes, or if the voting is now closed |
| 81 | +- return_json: [Boolean] Type for returned data |
| 82 | + |
3 | 83 | ## User Tweet timeline |
4 | 84 |
|
5 | 85 | The user Tweet timeline endpoint provides access to Tweets published by a specific Twitter account. |
|
0 commit comments