Adapter Online Help > TDV Twitter Adapter > Data Model > Views
 
Views
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Twitter Adapter Views
Name
Description
Query account settings about the currently authenticated user.
Query a list of users following the current Twitter account.
Query the members of a specified list.
Query Twitter list information based on a set of criteria.
Query the subscribers to a specified list.
Query the most recent mentions (tweet containing @username) for the authenticating user.
Query a list of retweets of the authenticated user.
Query the daily trending topics from Twitter.
Query public data flowing through Twitter.
Query a list of users based on the SearchTerms, Id, or Screen_Name.
AccountSettings
Query account settings about the currently authenticated user.
Columns
Name
Type
Description
Screen_Name [KEY]
String
The screen name of the currently authenticated user.
Always_Use_Https
Boolean
A boolean indicating if the user has specified in their user settings to always use HTTPS URLs.
Discoverable_By_Email
Boolean
A boolean indicating if the user can be found by email. This can be enabled in the 'let others find me by my email address' check box.
Discoverable_By_Mobile
Boolean
A boolean indicating if the user can be found by their mobile number.
Geo_Enabled
Boolean
A boolean indicating if the user has enabled adding locations to their tweets.
Language
String
The default language code for the user. For example: en.
Protected
Boolean
A boolean indicating if the user has selected the Protect My Tweets setting.
Show_All_Inline_Media
Boolean
A boolean indicating if the user has enabled all media to be displayed in tweets.
Sleep_Time_Enabled
Boolean
A boolean indicating if the user has selected to turn off updates during certain hours if they have added a mobile phone to their account.
Sleep_Time_Start_Time
String
The start time for the range when Twitter updates will not be submitted to the user's mobile phone.
Sleep_Time_End_Time
String
An ending time for the range when Twitter updates will not be submitted to the user's mobile phone.
Time_Zone_Name
String
The name of the time zone the user is located in.
Time_Zone_TZInfo_Name
String
A more specific location for the time zone the user is located in.
Time_Zone_Utc_Offset
Int
The Coordinated Universal Time offset in seconds from GMT.
Trend_Location
String
An XML aggregate of trending locations for the user.
Followers
Query a list of users following the current Twitter account.
View Specific Information
The authenticated user's followers and a specified user's followers may be viewed from Followers.
By default, Followers will return the followers of the authenticated user. By specifying a Followers_Of_User_Id or Followers_Of_Screen_Name, the followers of the specified user will be returned.
LookUpUsers refers to looking up additional information about the followers returned from Twitter. Normally only the Ids of followers are returned from Twitter. If LookUpUsers is set to true, additional queries will be made to Twitter to retrieve user details, such as the Screen_Name. LookUpUsers is true by default.
MaxUserLookup refers to the maximum number of users to additionally look up information on. A maximum of 100 user details may be returned from Twitter per request. Setting this value higher will cause details for more users to be returned, but at the cost of additional requests. MaxUserLookup defaults to 100.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the user.
Name
String
The name of the user.
User_Id
String
The Id of the user.
Screen_Name
String
The screen name of the user.
Followers_Of_User_Id
String
Use this in the WHERE clause to retrieve the users a specific user is following other than the authenticated user.
Followers_Of_Screen_Name
String
Use this in the WHERE clause to retrieve the users a specific user is following other than the authenticated user.
Location
String
The location of the user.
Profile_URL
String
The URL for the user's profile.
Profile_Image_URL
String
The URL for the image of the user.
Protected
Boolean
The privacy flag of the user. If true, then the user's account is private and only their approved followers can read their tweets or see extended information about them.
Lang
String
The ISO language code of the user.
Created_At
Datetime
When the user account was created.
Friends_Count
Integer
The number of people this user is following.
Followers_Count
Integer
The number of followers the user has.
Favourites_Count
Integer
The number of favorites the user has.
Statuses_Count
Integer
The number of status updates or tweets the user has made.
UTC_Offset
Integer
The Coordinated Universal Time offset for the user in seconds.
Time_Zone
String
The time zone of the user.
Notifications
Boolean
Boolean indicating if the user has notifications enabled.
Geo_Enabled
Boolean
Boolean indicating if the user has geo-enabled turned on in their profile.
Verified
Boolean
Boolean indicating if the user account has been verified.
Following
Boolean
Boolean indicating if the user is following you.
Contributors_Enabled
Boolean
Boolean indicating if contributors are enabled for the account. Typically used in multiuser accounts.
Follow_Request_Sent
Boolean
If the user is a protected user, indicates if the authenticated user has sent a request to follow them.
Listed_Count
Integer
The number of public lists a user is listed in. -1 if unknown.
Is_Translator
Boolean
Boolean indicating if the user contributes to translating Twitter in other languages.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
LookUpUsers
String
A boolean indicating if you would like to additionally look up details about the user Ids returned. Normally only Ids will be returned from Twitter, but additional requests can be made to Twitter to retrieve user details.
The default value is true.
MaxUserLookup
String
The maximum number of users to perform a lookup on. Each user lookup is limited to a maximum of 100 Ids per request.
The default value is 100.
ListMembers
Query the members of a specified list.
View Specific Information
Members of a specified list can be found under ListMembers.
The column List_Id can be used to specify the Id of a list you wish to obtain the members of.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the user.
List_Id
String
The Id of the list. Used to specify the list Id to retrieve tweets from.
The default value is 2031945.
Name
String
The name of the user.
Screen_Name
String
The screen name of the user.
Location
String
The location of the user.
Profile_URL
String
The URL for the user's profile.
Profile_Image_URL
String
The URL for the image of the user.
Protected
Boolean
The privacy flag of the user. If true, then the user's account is private and only their approved followers can read their tweets or see extended information about them.
Lang
String
The ISO language code of the user.
Created_At
Datetime
When the user account was created.
Friends_Count
Integer
The number of people this user is following.
Followers_Count
Integer
The number of followers the user has.
Favourites_Count
Integer
The number of favorites the user has.
Statuses_Count
Integer
The number of status updates or tweets the user has made.
UTC_Offset
Integer
The Coordinated Universal Time offset for the user in seconds.
Time_Zone
String
The time zone of the user.
Notifications
Boolean
Boolean indicating if the user has notifications enabled.
Geo_Enabled
Boolean
Boolean indicating if the user has geo-enabled turned on in their profile.
Verified
Boolean
Boolean indicating if the user account has been verified.
Following
Boolean
Boolean indicating if the user is following you.
Contributors_Enabled
Boolean
Boolean indicating if contributors are enabled for the account. Typically used in multiuser accounts.
Follow_Request_Sent
Boolean
If the user is a protected user, this column indicates if the authenticated user has sent a request to follow them.
Listed_Count
Integer
The number of public lists a user is listed in. -1 if unknown.
Is_Translator
Boolean
Boolean indicating if the user contributes to translating Twitter in other languages.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
Lists
Query Twitter list information based on a set of criteria.
View Specific Information
Information on Twitter lists may be obtained in Lists. By default, lists that the authenticated user is subscribed to will appear. Lists may returned in several different ways using both pseudo columns and normal columns.
Specify the Subscriber_Id or Subscriber_Screen_Name in the WHERE clause of the request to return lists that the specified Twitter user is subscribed to. Other pseudo columns may not be used when specifying these values.
Specify the Member_Id or Member_Screen_Name in the WHERE clause of the request to return lists that the specified Twitter user is a member of. Other pseudo columns may not be used when specifying these values.
Specify both the Slug and Owner_User_Id or only the Owner_Screen_Name to return one specific list. This is an alternative to specifying the Id of the list and will return only one result.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the list.
Name
String
The name of the list.
Full_Name
String
The full name of the list.
Slug
String
The Slug or name of the list.
Description
String
A description of the list.
Subscriber_Count
Integer
The number of subscribers to the list.
Member_Count
Integer
The number of members in the list.
Created_At
Datetime
When the list was created.
Following
Boolean
Boolean indicating if the authenticated user is following the list.
Mode
String
What mode the list is set to.
Owner_Id
String
User Id for the owner of the list.
Owner_Name
String
Name for the owner of the list.
Owner_Screen_Name
String
Screen name for the owner of the list.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
Subscriber_Id
String
Used to retrieve lists the specified User_Id is subscribed to.
Subscriber_Screen_Name
String
Used to retrieve lists the specified User_Screen_Name is subscribed to.
Member_Id
String
Used to retrieve lists the specified User_Id is a member of.
Member_Screen_Name
String
Used to retrieve lists the specified User_Screen_Name is a member of.
Owner_User_Id
String
Alternative method of specifying a list. Use this with a Slug to specify a list without the List_Id.
ListSubscribers
Query the subscribers to a specified list.
View Specific Information
Subscribers of a specified list can be found under ListSubscribers.
The column List_Id can be used to specify the Id of a list you wish to obtain the members of.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the user.
List_Id
String
Used to specify the list Id to retrieve tweets from.
The default value is 2031945.
Name
String
The name of the user.
Screen_Name
String
The screen name of the user.
Location
String
The location of the user.
Profile_URL
String
The URL for the user's profile.
Profile_Image_URL
String
The URL for the image of the user.
Protected
Boolean
The privacy flag of the user. If true, then the user's account is private and only their approved followers can read their tweets or see extended information about them.
Lang
String
The ISO language code of the user.
Created_At
Datetime
When the user account was created.
Friends_Count
Integer
The number of people this user is following.
Followers_Count
Integer
The number of followers the user has.
Favourites_Count
Integer
The number of favorites the user has.
Statuses_Count
Integer
The number of status updates or tweets the user has made.
UTC_Offset
Integer
The Coordinated Universal Time offset for the user in seconds.
Time_Zone
String
The time zone of the user.
Notifications
Boolean
Boolean indicating if the user has notifications enabled.
Geo_Enabled
Boolean
Boolean indicating if the user has geo-enabled turned on in their profile.
Verified
Boolean
Boolean indicating if the user account has been verified.
Following
Boolean
Boolean indicating if the user is following you.
Contributors_Enabled
Boolean
Boolean indicating if contributors are enabled for the account. Typically used in multiuser accounts.
Follow_Request_Sent
Boolean
If the user is a protected user, this column indicates if the authenticated user has sent a request to follow them.
Listed_Count
Integer
The number of public lists a user is listed in. -1 if unknown.
Is_Translator
Boolean
Boolean indicating if the user contributes to translating Twitter in other languages.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
Mentions
Query the most recent mentions (tweet containing @username) for the authenticating user.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the status update or tweet. Set this value when inserting to instead retweet an existing tweet.
IDLong
Long
The long type Id of the status update or tweet.
Created_At
Datetime
When the tweet was made.
Text
String
The text of the tweet.
Source
String
Source of the tweet.
Favorited
Boolean
Boolean indicating if this tweet has been favorited.
Favorite_Count
Integer
The approximate number of times this tweet has been favorited.
Retweet_Count
Integer
The number of times the tweet has been retweeted.
Retweeted_Status_Id
String
Id of the tweet which was retweeted by this one. Empty if the current tweet is not a retweet.
User_Id
String
Id of the user who made the tweet.
User_Name
String
Name of the user who made the tweet.
User_Screen_Name
String
Screen name of the user who made the tweet.
User_Location
String
Location of the user who made the tweet.
User_Profile_URL
String
URL to the profile of the user who made the tweet.
User_Profile_Image_URL
String
URL to the user's profile image.
User_Mentions
String
Mentions of other users in the tweet, returned as an XML aggregate.
URLs
String
URLs in the tweet, returned as an XML aggregate.
Hashtags
String
Hashtags in the tweet, returned as an XML aggregate.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
Min_ID
String
Specifies the lowest Id to return results for. Ids are stored in increasing numerical order, so specifying this value means that only tweets that are equal to or newer than the creation date of the specified Id will be returned. The Min_Id must be a valid number but does not need to be a valid tweet Id.
Max_ID
String
Specifies the highest Id to return results for. Ids are stored in increasing numerical order, so specifying this value means that only tweets that are equal to or older than the creation date of the specified Id will be returned. The Max_Id must be a valid number but does not need to be a valid tweet Id.
Include_Entities
String
Boolean indicating whether or not to include entities such as URLs, hashtags, and user mentions in the response.
The allowed values are true, false.
The default value is false.
Include_Retweets
String
Boolean indicating whether or not to include retweets in the result set.
The allowed values are true, false.
The default value is true.
Retweets
Query a list of retweets of the authenticated user.
View Specific Information
Select
Tweets from the authenticated user that have been retweeted by other users will appear in Retweets by default.
The Min_Id and Max_Id pseudo columns may be used to narrow down a range of retweets to return, or to return only recent retweets. Ids are created in increasing numerical order on Twitter. Specifying a Min_Id will return only results with a greater Id or tweets that were created more recently than the specified one. Setting a Max_Id will return only tweets that are older than the creation date of the specified Id. Note that while these values must be valid, non-negative numbers, they do not have to be Ids that exist.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the status update or tweet.
IDLong
Long
The long type Id of the status update or tweet.
Created_At
Datetime
When the tweet was made.
Text
String
The text of the tweet.
Lang
String
Language code the tweet was made in.
Source
String
Source of the tweet.
Favorited
Boolean
Boolean indicating if this tweet has been favorited.
Favorite_Count
Integer
The approximate number of times this tweet has been favorited.
Retweeted
Boolean
Boolean indicating if this tweet has been retweeted.
Retweet_Count
Integer
The number of times the tweet has been retweeted.
Retweeted_Status_Id
String
Id of the tweet which was retweeted by this one. Empty if the current tweet is not a retweet.
Truncated
Boolean
Boolean indicating if this tweet has been truncated.
Filter_Level
String
Indicates the maximum value that may be used and still stream this tweet.
Possibly_Sensitive
String
This field is available only when a tweet contains a link. The meaning of the field does not pertain to the tweet content itself, but instead it is an indicator that the URL contained in the tweet may contain content or media identified as sensitive content.
Withheld_Copyright
Boolean
When present and set to true, it indicates that this piece of content has been withheld due to a DMCA complaint.
Withheld_Scope
String
When present, this column indicates whether the content being withheld is the status or a user.
Withheld_In_Countries
String
A list of uppercase, two-letter country codes of the countries this content is withheld from.
Contributors
String
An XML collection of user objects (usually only one) indicating users who contributed to the authorship of the tweet, on behalf of the official tweet author.
Coordinates_Coordinates
String
The geographic coordinates of this tweet (longitude first, then latitude).
Coordinates_Type
String
The type of coordinate, if applicable.
Place_Full_Name
String
The full name of the location of this tweet (city and state).
Place_Country
String
The country of origin of this tweet.
Current_User_Retweet_Id
String
Details the tweet Id of the authenticated user's own retweet (if it exists) of this tweet.
Scopes
String
A set of key-value pairs indicating the intended contextual delivery of the containing tweet. Currently used by Twitter's promoted products.
In_Reply_To_Status_Id
String
Represents the Id of the original status if this tweet is in reply to another.
User_Id
String
Id of the user who made the tweet. Use this in the WHERE clause to get retweets for a specific user other than the authenticated user.
User_Name
String
Name of the user who made the tweet.
User_Screen_Name
String
Screen name of the user who made the tweet.
User_Location
String
Location of the user who made the tweet.
User_Profile_URL
String
URL to the user who made the tweet.
User_Profile_Image_Url
String
URL to the profile image for the user who made the tweet.
User_Mentions
String
Mentions of other users in the tweet, returned as an XML aggregate.
URLs
String
URLs in the tweet, returned as an XML aggregate.
Hashtags
String
Hashtags in the tweet, returned as an XML aggregate.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
Min_ID
String
Specifies the lowest Id to return results for. Ids are stored in increasing numerical order, so specifying this value means that only retweets that are equal to or newer than the creation date of the specified Id will be returned. The Min_Id must be a valid number but does not need to be a valid retweet Id.
Max_ID
String
Specifies the highest Id to return results for. Ids are stored in increasing numerical order, so specifying this value means that only retweets that are equal to or older than the creation date of the specified Id will be returned. The Max_Id must be a valid number but does not need to be a valid retweet Id.
Include_Entities
String
Boolean indicating whether or not to include entities such as URLs, hashtags, and user mentions in the response.
The allowed values are true, false.
The default value is false.
Trends
Query the daily trending topics from Twitter.
Columns
Name
Type
Description
ID [KEY]
String
A unique Id for the trending topic, denoted by the syntax Date | #
Date
Datetime
The date for the trending topic.
Topic
String
The name of the trending topic.
WoeId
String
A Where on Earth Id for the location the topic is trending. Input this to keep from making an extra request to get the woeId from Twitter each time.
Country
String
The country the topic is trending in.
CountryCode
String
The country code the topic is trending in.
Latitude
String
The latitude where trends are being searched for.
The default value is 40.7142.
Longitude
String
The longitude where trends are being searched for.
The default value is -74.0064.
Search_Terms
String
The search terms you would need to search for this trending topic.
Events
String
Any events associated with the topic.
Url
String
A URL to the Twitter search for this topic.
Promoted_Content
String
Any promoted content that is associated with the topic.
TweetStream
Query public data flowing through Twitter.
View Specific Information
TweetStream is a stream that will continuously read public Tweets until the operation is killed.
Select
Below are the fields that can be specified to filter the results.
Follow
A comma-separated list of user Ids, indicating the users you are following whose Tweets should be delivered on the stream.
Track
A comma-separated list of phrases that will be used to deliver the Tweets on the stream containing the phrases.
Language
Return Tweets that have been detected as being written in the specified list of comma-separated languages. You must use BCP 47 language identifiers, such as 'en','fr','ja'. Twitter will respond with a "406 Not Acceptable" error if the coordinates entered were incorrect.
Locations
A comma-separated list of longitude and latitude pairs specifying a set of bounding boxes to filter Tweets by. You must use at least two pairs of longitude and latitude coordinates, with the first pair indicating the southwest bound of the region you will search in.
BackfillCount
When reconnecting to a streaming endpoint, the BackfillCount parameter may be included to attempt to backfill missed messages that occurred during the disconnect period. The supplied value can be an integer from 1 to 150000 or from -1 to -150000. If a positive number is specified, the stream will transition to live values once the backfilled values have been delivered to the client. If a negative number is specified, the stream will disconnect once the backfilled values have been delivered to the client. This filter is only allowed to users with these elevated access roles: Firehose, Links, Birddog and Shadow. Twitter will respond with a "416 Requested Range Not Satisfiable" error if your role does not support this filter.
Filter_Level
The level of tweets returned. The default value is none, which includes all available Tweets.
SELECT * FROM TweetStream WHERE Follow = '51192312'
If either Follow, Track, or Language, is not specified, a small random sample of all public Tweets will be returned, and using any other filter is not going to affect Twitter's streaming results.
Retrieve a large number of tweets that contain the word 'Assembly' in the tweet's body:
SELECT * FROM TweetStream WHERE Track = 'Assembly' AND Filter_Level='low'
The following filter will retrieve all tweets originating from New York City:
SELECT * FROM TweetStream WHERE Locations = '-74,40,-73,41'
Retrieve tweets in the French or English language containing the word 'fillet', and if disconnected, stop retrieving after 50 tweets:
SELECT * FROM TweetStream WHERE Track = 'fillet' AND Language = 'fr,en' AND BackfillCount='-50'
Columns
Name
Type
Description
ID
String
The Id of the status update or tweet. Set this value when inserting to retweet an existing tweet.
Created_At
Datetime
When the tweet was made.
Text
String
The text of the tweet.
Lang
String
Language code the tweet was made in.
Source
String
Source of the tweet.
Favorited
Boolean
Boolean indicating if this tweet has been favorited.
Favorite_Count
Integer
The approximate number of times this tweet has been favorited.
Retweeted
Boolean
Boolean indicating if this tweet has been retweeted.
Retweet_Count
Integer
The number of times the tweet has been retweeted.
Retweeted_Status_Id
String
Id of the tweet which was retweeted by this one. Empty if the current tweet is not a retweet.
Truncated
Boolean
Boolean indicating if this tweet has been truncated.
Filter_Level
String
Indicates the maximum value of the Filter_Level parameter that can be used and still stream this tweet.
Possibly_Sensitive
String
This field is available only when a tweet contains a link. The meaning of the field does not pertain to the tweet content itself, but instead it is an indicator that the URL contained in the tweet may contain content or media identified as sensitive content.
Contributors
String
A JSON collection of user objects (usually only one) indicating users who contributed to the authorship of the tweet, on behalf of the official tweet author.
Coordinates_Coordinates
String
The geographic coordinates of this tweet (longitude first, then latitude).
Coordinates_Type
String
The type of coordinate, if applicable.
Place_Full_Name
String
The full name of the location of this tweet (city and state).
Place_Country
String
The country of origin of this tweet.
Current_User_Retweet_Id
String
Details the tweet Id of the authenticated users own retweet (if it exists) of this tweet.
In_Reply_To_Status_Id
String
Represents the Id of the original status if this tweet is in reply to another.
In_Reply_To_User_Id
String
Represents the Id of the original user if this tweet is in reply to another.
From_User_Id
String
Id of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
From_User_Screen_Name
String
Screen name of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.
From_User_Name
String
Name of the user who made the tweet.
From_User_Location
String
Location of the user who made the tweet.
From_User_Profile_URL
String
URL to the user who made the tweet. This is not returned when a SearchTerms is specified.
From_User_Profile_Image_Url
String
URL to the profile image for the from user.
User_Mentions
String
Mentions of other users in the tweet, returned as an JSON aggregate.
URLs
String
URLs in the tweet, returned as an XML aggregate.
Hashtags
String
Hashtags in the tweet, returned as an XML aggregate.
Follow
String
A comma separated list of user IDs, indicating the users whose Tweets should be delivered on the stream. Following protected users is not supported.
Track
String
A comma separated list of phrases which will be used to determine what Tweets will be delivered on the stream.
Language
String
Setting this parameter to a comma-separated list of BCP 47 language identifiers corresponding to any of the languages listed on Twitter's advanced search page will only return Tweets that have been detected as being written in the specified languages.
Locations
String
A comma separated list of longitude,latitude pairs specifying a set of bounding boxes to filter Tweets by. Only geolocated Tweets falling within the requested bounding boxes will be included unlike the Search API, the location of the user field is not used to filter Tweets.
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
BackfillCount
String
When reconnecting to a streaming endpoint, the count parameter may included to attempt to backfill missed messages which occurred during the disconnect period. The supplied value may be an integer from 1 to 150000 or from -1 to -150000. If a positive number is specified, the stream will transition to live values once the backfill has been delivered to the client. If a negative number is specified, the stream will disconnect once the backfill has been delivered to the client.
Users
Query a list of users based on the SearchTerms, Id, or Screen_Name.
View Specific Information
Users may be obtained via a search or specified in a list of Ids or screen names.
SearchTerms may be used to search for users in a method that is similar to the Find People search on Twitter.com. Up to the first 1000 matches will be available using SearchTerms.
You can specify either the Screen_Name or User_Id pseudo columns to perform a lookup. Up to 100 screen names or Ids may be specified by using a comma-separated list. Id may also be specified using a comma-separated list and will perform the same lookup.
The Min_Id and Max_Id pseudo columns may be used to narrow down a range of users to return, or to return only recently created users. Ids are created in increasing numerical order on Twitter. Specifying a Min_Id returns only results with a greater Id or tweets that were created more recently than the specified one. Setting a Max_Id returns only tweets that are older than the creation date of the specified Id to return. Note that while these values must be valid, non-negative numbers, they do not have to be Ids that exist.
Columns
Name
Type
Description
ID [KEY]
String
The Id of the user. A comma-separated list of user Ids may be used in the WHERE clause to get data about multiple users.
SearchTerms
String
A SearchTerms to use while searching users. This can return up to 1000 results.
Name
String
The name of the user.
Screen_Name
String
The screen name of the user. A comma-separated list of screen names may be used in the WHERE clause to get data about multiple users.
Location
String
The location of the user.
Profile_URL
String
The URL for the user's profile.
Profile_Image_URL
String
The URL for the image of the user.
Protected
Boolean
The privacy flag of the user. If true, then the user's account is private and only their approved followers can read their tweets or see extended information about them.
Lang
String
The ISO language code of the user.
Created_At
Datetime
When the user account was created.
Friends_Count
Integer
The number of people this user is following.
Followers_Count
Integer
The number of followers the user has.
Favourites_Count
Integer
The number of favorites the user has.
Statuses_Count
Integer
The number of status updates or tweets the user has made.
UTC_Offset
Integer
The Coordinated Universal Time offset for the user in seconds.
Time_Zone
String
The time zone of the user.
Notifications
Boolean
Boolean indicating if the user has notifications enabled.
Geo_Enabled
Boolean
Boolean indicating if the user has geo-enabled turned on in their profile.
Verified
Boolean
Boolean indicating if the user account has been verified.
Following
Boolean
Boolean indicating if the user is following you.
Contributors_Enabled
Boolean
Boolean indicating if contributors are enabled for the account. Typically used in multiuser accounts.
Follow_Request_Sent
Boolean
If the user is a protected user, this column indicates if the authenticated user has sent a request to follow them.
Listed_Count
Integer
The number of public lists a user is listed in. -1 if unknown.
Is_Translator
Boolean
Boolean indicating if the user contributes to translating Twitter in other languages.
Description
String
The description of the user.
Url
String
A URL to the user page on Twitter.
Default_Profile
Boolean
Boolean indicating if the user is using the default profile design/theme.
Default_Profile_Image
Boolean
Boolean indicating if the user is using the default Twitter profile image.
Profile_Background_Color
String
Background color for the user's theme.
Profile_Background_Image_Url
String
HTTP URL for the user's background image in their theme settings.
Profile_Background_Image_Url_Https
String
HTTPS URL for the user's background image in their theme settings.
Profile_Background_Tile
Boolean
Boolean indicating if the user has used the Tile Background checkbox in their theme settings.
Profile_Image_Url_Https
String
HTTPS URL for the user's profile image.
Profile_Link_Color
String
Hexadecimal color code for the user's links.
Profile_Sidebar_Border_Color
String
The sidebar border color for the user.
Profile_Sidebar_Fill_Color
String
The sidebar fill color for the user.
Profile_Text_Color
String
The hexadecimal color code for text in the user's settings.
Profile_Use_Background_Image
String
Boolean indicating if the user is using the background image.
Show_All_Inline_Media
String
Boolean indicating if the user has enabled viewing all in-line media (pictures, videos, etc).
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name
Type
Description
NextPageToken
String
An identifier to retrieve the next page of results. Specify only if an error occurs during the original request. Make sure any criteria specified in the original request are still specified when using the NextPageToken.
User_ID
String
The Id of the user to return results for. This can be used in the WHERE clause of an SQL statement as a comma-separated list. Only up to 100 user Ids can be submitted per request.
Min_ID
String
Specifies the lowest Id to return results for. Ids are stored in increasing numerical order, so specifying this value means that only users that are equal to or newer than the creation date of the specified Id will be returned. The Min_Id must be a valid number but does not need to be a valid user Id.
Max_ID
String
Specifies the highest Id to return results for. Ids are stored in increasing numerical order, so specifying this value means that only users that are equal to or older than the creation date of the specified Id will be returned. The Max_Id must be a valid number but does not need to be a valid user Id.