Twitter Data Model

Connection String Options

  1. Account Id
  2. Auto Cache
  3. Batch Size
  4. Cache Connection
  5. Cache Driver
  6. Cache Location
  7. Cache Metadata
  8. Cache Query Result
  9. Callback URL
  10. Connection Life Time
  11. Connect On Open
  12. Firewall Password
  13. Firewall Port
  14. Firewall Server
  15. Firewall Type
  16. Firewall User
  17. Initiate OAuth
  18. Location
  19. Logfile
  20. Max Log File Size
  21. Max Rate Limit Delay
  22. Max Rows
  23. OAuth Access Token
  24. OAuth Access Token Secret
  25. OAuth Client Id
  26. OAuth Client Secret
  27. OAuth Settings Location
  28. Offline
  29. Other
  30. Pool Idle Timeout
  31. Pool Max Size
  32. Pool Min Size
  33. Pool Wait Time
  34. Proxy Auth Scheme
  35. Proxy Auto Detect
  36. Proxy Exceptions
  37. Proxy Password
  38. Proxy Port
  39. Proxy Server
  40. Proxy SSL Type
  41. Proxy User
  42. Pseudo Columns
  43. Readonly
  44. RTK
  45. Search Terms
  46. SSL Server Cert
  47. Stream Page Size
  48. Stream Timeout
  49. Support Enhanced SQL
  50. Tables
  51. Timeout
  52. Use App Only Authentication
  53. Use Connection Pooling
  54. Verbosity
  55. Views

Account Id

Data Type

string

Default Value

""

Remarks

Identifier of the advertising account. This Id is used to get analytic stats for the account that is identified by this Id. The AddAccounts view can be used to list available accounts with their specific Ids.

 

 

Auto Cache

Data Type

bool

Default Value

false

Remarks

When AutoCache is set, the driver automatically maintains a cache of your table's data in the database of your choice. By default, the driver incrementally updates the cache, retrieving only changes since the last SELECT query was run if the length of time since the last run has exceeded the CacheTolerance. After the cache is updated, the query is executed against the cached data. With CacheQueryResult additionally set, the driver updates the cache when you execute a SELECT query and returns the live results from the Twitter data.

 

Explicitly Caching SELECT Results

 

CacheQueryResult is a way to query Twitter in real time while maintaining a cache for offline use. Set CacheQueryResult to update the cache whenever you execute a SELECT statement. When you execute a SELECT statement with AutoCache and CacheQueryResult set, the driver executes the query to the remote data and caches the results; rows that already exist are overwritten. That is, SELECT statements are used to create and refresh the cache, not to query it. Data manipulation commands are executed to the remote data as well.

To query the cached data, set the Offline property. If you need to query the cached data in an online connection, you can append #CACHE to the table name. For example:

SELECT * FROM [Tweets#CACHE]

 

 

Setting the Caching Database

 

When AutoCache is set, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:

 

 

See Also

 

 

  • CacheTolerance: Control the tolerance for stale data in the cache.
  • CacheQueryResult: Insert or update each row returned into the corresponding table in the cache.
  • Caching: Best Practices: This section provides more examples of using AutoCache with Offline, as well as information on determining a caching strategy.
  • CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Twitter metadata. Metadata then needs to be retrieved only once instead of every connection.
  • REPLICATE Statements: When you execute a SELECT statement with AutoCache set, the driver internally calls the REPLICATE statement. The REPLICATE statement enables incremental updates instead of first dropping the cached table.
  • CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.

 

 

 

Batch Size

Data Type

int

Default Value

0

Remarks

When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.

Setting BatchSize to 0 will submit the entire batch as specified.

 

Cache Connection

Data Type

string

Default Value

""

Remarks

 

The cache database is determined based on the CacheDriver and CacheConnection properties. Both properies are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.

The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.

 

Derby and Java DB

 

The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.

Alternatively, you can configure the connection to Derby manually using CacheProvider and CacheConnection. Below is the Derby JDBC URL syntax:

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory

 

 

SQLite

 

To cache to SQLite, you can use the SQLite JDBC driver. Below is the syntax of the JDBC URL:

jdbc:sqlite:dataSource
  • Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.

 

 

MySQL

 

The installation includes the CData JDBC Driver for MySQL. Below is an example JDBC URL:

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
Below are typical connection properties:

 

 

  • Server: The IP address or domain name of the server you want to connect to.
  • Port: The port that the server is running on.
  • User: The username provided for authentication to the database.
  • Password: The password provided for authentication to the database.
  • Database: The name of the database.
SQL Server

 

The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
Below are typical SQL Server connection properties:
  • Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
  • Port: The port SQL Server is running on.
  • Database: The name of the SQL Server database.
  • Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.

    To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.

  • User ID: The username provided for authentication with SQL Server. Only needed if you are not using integrated security.
  • Password: The password provided for authentication with SQL Server. Only needed if you are not using integrated security.
Oracle

 

Below is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
Below are typical connection properties:
  • Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).

  • Password: The password provided for authentication with the Oracle database.
  • User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL

 

Below is the JDBC URL syntax for the official PostgreSQL JDBC driver:

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
Below are typical connection properties:
  • Host: The address of the server hosting the PostgreSQL database.
  • Port: The port used to connect to the server hosting the PostgreSQL database.
  • Database: The name of the database.
  • Username: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
  • Password: The password provided for authentication with the PostgreSQL database.

 

 

Cache Driver

Data Type

string

Default Value

""

Remarks

 

You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.

The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you would like to use to cache data.

Note that you must also add the CacheDriver JAR to the classpath.

The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.

Derby and Java DB

 

 

The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR is shipped in the JDK. You can find the JAR, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath.

jdbc:twitter:CacheLocation='c:/Temp/cachedir';InitiateOAuth=GETANDREFRESH;
To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:twitter:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';InitiateOAuth=GETANDREFRESH;
SQLite

 

Below is a JDBC URL for the SQLite JDBC driver:

jdbc:twitter:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';InitiateOAuth=GETANDREFRESH;
MySQL

 

Below is a JDBC URL for the included CData JDBC Driver for MySQL:

  jdbc:twitter:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';InitiateOAuth=GETANDREFRESH;
  
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Twitter 2018 installation directory.
SQL Server

 

The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:

jdbc:twitter:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';InitiateOAuth=GETANDREFRESH;
Oracle

 

Below is a JDBC URL for the Oracle Thin Client:

jdbc:twitter:Cache Driver=oracle.jdbc.driver.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';InitiateOAuth=GETANDREFRESH;
PostgreSQL

 

The following JDBC URL uses the official PostgreSQL JDBC driver:

jdbc:twitter:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';InitiateOAuth=GETANDREFRESH;

 

 

Cache Location

Data Type

string

Default Value

""

Remarks

The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR to the classpath. The JAR, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.

CacheLocation defaults to the directory specified by the Location setting.

See Also

 

 

  • AutoCache: Set this to implicitly create and maintain a cache for later offline use.
  • CacheMetadata: Set this to persist the Twitter catalog in CacheLocation.

 

 

Cache Metadata

Data Type

bool

Default Value

false

Remarks

As you execute queries with this property set, table metadata in the Twitter catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.

When to Use CacheMetadata

 

The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.

When Not to Use CacheMetadata

 

 

  • When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metdata will change often.
  • When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use REPLICATE Statements or CACHE Statements to cache explicitly.

 

 

Cache Query Result

Data Type

bool

Default Value

false

Remarks

When CacheQueryResult and AutoCache are set, the rows returned from a SELECT query are cached in the cache database. The driver handles caching in a streaming fashion with each row being processed into the cache database from the original result set as you read the row from the returned ResultSet object. This ensures that the live data is not queried twice. Note that any rows you do not read from the returned ResultSet will not be updated in the cache.

 

Callback URL

Data Type

string

Default Value

""

Remarks

 

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

 

Connection Life Time

Data Type

string

Default Value

"0"

Remarks

The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.

 

Connect On Open

Data Type

bool

Default Value

false

Remarks

When set to 'true', a connection will be made to Twitter when the connection is opened. This property enables the 'Test Connection' feature available in various database tools.

This feature acts as a NOOP command as it is used to verify a connection can be made to Twitter and nothing from this initial connection is maintained.

Setting this property to 'false' may provide performance improvements (depending upon the number of times a connection is opened).

 

Firewall Password

Data Type

string

Default Value

""

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

 

Firewall Port

Data Type

string

Default Value

""

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

 

Firewall Server

Data Type

string

Default Value

""

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

 

Firewall Type

Data Type

string

Default Value

"NONE"

Remarks

This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

 

   
Type Default Port Description
TUNNEL 80 When this is set, the driver opens a connection to Twitter and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

 

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

 

 

Firewall User

Data Type

string

Default Value

""

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

 

Initiate OAuth

Data Type

string

Default Value

"OFF"

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

 

 

Location

Data Type

string

Default Value

""

Remarks

The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the driver assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

 

Logfile

Data Type

string

Default Value

""

Remarks

For more control over what is written to the log file, take a look at Verbosity.

 

Max Log File Size

Data Type

string

Default Value

"100MB"

Remarks

A string specifying the maximum size in bytes for a log file (ex: 10MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100MB. Values lower than 100kB will use 100kB as the value instead.

 

Max Rate Limit Delay

Data Type

string

Default Value

"60"

Remarks

Twitter uses different rate limits for total number of requests for different endpoints. These can range from as few as 15 per 15 minute window, up to 900 for a 15 minute window. Internally the CData JDBC Driver for Twitter 2018 keeps track of if a given request would result in a rate limit exception. If a rate limit would occur, the CData JDBC Driver for Twitter 2018 can internally delay submitting a request until the limit is up. However, this could also result in waiting for several minutes before requesting data, which is also not a good behavior.

The MaxRateLimitDelay gives control over the maximum amount of time the CData JDBC Driver for Twitter 2018 will wait once it detects a rate limit would occur. Since the amount of time the CData JDBC Driver for Twitter 2018 needs to wait can be calculated, if it would have to wait longer than the MaxRateLimitDelay, it will simply error immediately when it sees the time would take too long.

 

 

Max Rows

Data Type

string

Default Value

"-1"

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

 

OAuth Access Token

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

 

OAuth Access Token Secret

Data Type

string

Default Value

""

Remarks

The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.

 

OAuth Client Id

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

 

OAuth Client Secret

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

 

OAuth Settings Location

Data Type

string

Default Value

"%APPDATA%\\CData\\Twitter Data Provider\\OAuthSettings.txt"

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes. The default OAuthSettingsLocation is a settings file located in the %AppData%\CData folder. Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

 

Offline

Data Type

bool

Default Value

false

Remarks

When Offline is set to TRUE, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.

 

Other

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Caching Configuration

 

   
CachePartial=True Caches only a subset of columns, which you can specify in your query.
QueryPassthrough=True Passes the specified query to the cache database instead of using the SQL parser of the driver.

 

Integration and Formatting

 

   
DefaultColumnSize Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT Whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename Records the underlying socket data transfer to the specified file.

 

 

Pool Idle Timeout

Data Type

string

Default Value

""

Remarks

The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.

 

Pool Max Size

Data Type

string

Default Value

"100"

Remarks

The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.

 

Pool Min Size

Data Type

string

Default Value

"1"

Remarks

The minimum number of connections in the pool. The default is 1.

 

Pool Wait Time

Data Type

string

Default Value

""

Remarks

The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.

 

Proxy Auth Scheme

Data Type

string

Default Value

"BASIC"

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The driver performs HTTP BASIC authentication.
  • DIGEST: The driver performs HTTP DIGEST authentication.
  • NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

 

 

Proxy Auto Detect

Data Type

bool

Default Value

true

Remarks

By default, the driver uses the system HTTP proxy. Set this to false if you want to connect to another proxy.

To connect to an HTTP proxy, see ProxyServer.

For other proxies, such as SOCKS or tunneling, see FirewallType.

 

Proxy Exceptions

Data Type

string

Default Value

""

Remarks

The ProxyServer will be used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you will need to set ProxyAutoDetect to false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

 

Proxy Password

Data Type

string

Default Value

""

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

 

Proxy Port

Data Type

string

Default Value

"80"

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

 

Proxy Server

Data Type

string

Default Value

""

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

 

Proxy SSL Type

Data Type

string

Default Value

"AUTO"

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

 

   
AUTO Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS The connection is always SSL enabled.
NEVER The connection is not SSL enabled.
TUNNEL The connection is through a tunneling proxy: The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

 

 

Proxy User

Data Type

string

Default Value

""

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the username of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a username in one of the following formats:

user@domain
domain\user

 

 

Pseudo Columns

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; i.e., "*=*".

 

Readonly

Data Type

bool

Default Value

false

Remarks

If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

 

RTK

Data Type

string

Default Value

""

Remarks

 

The RTK property may be used to license a build. Please see the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.

 

Search Terms

Data Type

string

Default Value

""

Remarks

Default SearchTerms if none are specified. Used for some tables such as Tweets where SearchTerms may be specified.

 

 

SSL Server Cert

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

   
Description Example
A full PEM Certificate (example shortened for brevity) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate C:\cert.cer
The public key (example shortened for brevity) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated) ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated) 34a929226ae0819f2ec14b4a3d904f801cbb150d

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

 

Stream Page Size

Data Type

string

Default Value

"50"

Remarks

The number of results to return per page of data retrieved from the Twitter stream.

 

Stream Timeout

Data Type

string

Default Value

"0"

Remarks

Set the value of StreamTimeout to 0 in order to keep the connection open indefinitely. Note that, if the value of this property is greater than zero, the value of the StreamPageSize property, will be overwriten and will be set to one(1).

 

Support Enhanced SQL

Data Type

bool

Default Value

true

Remarks

When SupportEnhancedSQL is set to true, the driver offloads as much of the SELECT statement processing as possible to Twitter and then processes the rest of the query in memory. In this way the driver can execute unsupported predicates, joins, and aggregation.

When SupportEnhancedSQL is set to false, the driver limits SQL execution to what is supported by the Twitter API.

Execution of Predicates

 

The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.

Execution of Joins

 

The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.

Execution of Aggregates

 

The driver retrieves all rows necessary to process the aggregation in memory.

 

Tables

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. For example: Tables=TableA,TableB,TableC

 

Timeout

Data Type

string

Default Value

"60"

Remarks

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the driver throws an exception.

 

Use App Only Authentication

Data Type

bool

Default Value

false

Remarks

Set this to true to have your Twitter app log in to Twitter instead of a user.

 

Use Connection Pooling

Data Type

bool

Default Value

false

Remarks

Enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.

 

Verbosity

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described below:

 

   
1 Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
2 Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable, such as HTTP headers.
3 Setting Verbosity to 3 will additionally log the body of the request and the response.
4 Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation.
5 Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands.

The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.

 

Views

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. For example: For example: Views=ViewsA,ViewsB,ViewsC




 

Tables

  1. DirectMessages
  2. Favorites
  3. Following
  4. Tweets

DirectMessages

Send direct messages and query messages sent and received by the authenticated user.

 

Table Specific Information

 

Direct messages that have been sent and received by the authenticated user will appear in DirectMessages.

Select

 

The Min_Id and Max_Id pseudo columns may be used to narrow down a range of direct messages to return, or to return only recent direct messages. The Id may be specified to return a specific direct message.

Insert

 

New direct messages may be sent by performing an insert. Note that only Text and the Recipient_Id may be specified in an insert. In order to attach a media to the message, simply specify the media file paths MediaFilePath or the MediaId for the media file in the INSERT command.It is possible to attach only one media to a message. For example:

INSERT INTO DirectMessages (Recipient_Id, Text, MediaFilePath) VALUES ('0000000000000000000', 'Hello World', 'C:\\myFile.jpg')
 
INSERT INTO DirectMessages (Recipient_Id, Text, MediaId) VALUES ('1001073178217713668', 'Hello World', '1001072801250529280')
Update

 

The UPDATE operation is not available on this table.

Delete

 

Direct messages may be deleted by using the DELETE operation.

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String True

The Id of the direct message.

Created_At Datetime True

When the direct message was made.

Text String True

The text of the direct message.

Sender_Id String True

The Id for the sender of the message.

Source_App_Id String True

The name for the sender of the message.

Recipient_ID String True

The Id for the recipient of the message.

User_Mentions String True

Mentions of other users in the tweet, returned as an XML aggregate.

URLs String True

URLs in the tweet, returned as an XML aggregate.

Hashtags String True

Hashtags in the tweet, returned as an XML aggregate.

Attachment_Id String True

Identifier of the media attached to the message.

Attachment_Url String True

Url of the media attached to the message.

Attachment_Type String True

Type of media attached to the message.

NextPageToken String True

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.

 

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
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 direct messages that are equal to or newer than the creation date of the specified Id will be returned. The Min_Id column must be a valid number but does not need to be a valid direct message 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 direct messages that are equal to or older than the creation date of the specified Id will be returned. The Max_Id column must be a valid number but does not need to be a valid direct message Id.

MediaId String

The media Ids to associate with the tweet.

MediaFilePath String

The media file path to associate with the tweet.

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.

rows@next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Favorites

Create, delete, and query a list of favorite tweets of the authenticated user and allow the user to favorite new tweets or remove existing favorites.

 

Table Specific Information

 

The authenticated user's favorites may be viewed from Favorites.

Select

 

The Min_Id and Max_Id pseudo columns may be used to narrow down a range of tweets to return, or to return only recent tweets. Additionally, the Include_Entities pseudo column may be specified, which can reduce the size of the response if it is set to false.

Insert

 

New tweets may be favorited by performing an insert and specifying the Id of the tweet.

Update

 

The UPDATE operation is not available on this table.

Delete

 

Favorites may be removed by performing a DELETE operation and specifying the Id of the tweet to remove from Favorites.

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String False

The Id of the status update or tweet. Set this value when inserting to retweet an existing tweet.

IDLong Long False

The long type Id of the status update or tweet.

Created_At Datetime True

When the tweet was made.

Text String False

The text of the tweet.

Source String True

Source of the tweet.

Favorited Boolean True

Boolean indicating if this tweet has been favorited.

Retweet_Count Integer True

The number of times the tweet has been retweeted.

From_User_Id String True

Id of the user who made the tweet.

From_User String True

Screen name of the user who made the tweet.

From_User_Name String True

Name of the user who made the tweet.

From_User_Lang String True

Language code the from user is using.

From_User_Profile_URL String True

URL to the user who made the tweet.

From_User_Profile_Image_URL String True

URL to the profile image for the from user.

From_User_Location String True

The location of the user.

To_User_Id String True

Id of the user whom the tweet was sent to.

To_User_Screen_Name String True

Screen name of the user whom the tweet was sent to.

User_Mentions String True

Mentions of other users in the tweet, returned as an XML aggregate.

URLs String True

URLs in the tweet, returned as an XML aggregate.

Hashtags String True

Hashtags in the tweet, returned as an XML aggregate.

NextPageToken String True

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.

 

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
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.

rows@next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Following

Create, delete, and query a list of users that the current Twitter account is following, otherwise known as friends.

 

Table Specific Information

 

Users whom the authenticated user is following will appear here. Additionally, users whom a specified user is following may be viewed from Following.

Select

 

By default, Following will return users whom the authenticated user is following. By specifying a Following_User_Id or Following_Screen_Name, users whom the specified user is following will be returned.

LookUpUsers refers to looking up additional information on the users returned from Twitter. Normally, only the Ids of users someone is following are returned from Twitter. If LookUpUsers is set to true, additional queries will be made to Twitter to retrieve user details, such as a 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.

Insert

 

The authenticated user may follow another user by performing an insert based on either the User_Id or the Screen_Name.

Update

 

The UPDATE operation is not available on this table.

Delete

 

The authenticated user may stop following another user by performing a delete based on the Id.

Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String False

The Id of the user.

Name String True

The name of the user.

User_Id String False

The Id of the user.

Screen_Name String False

The screen name of the user.

Following_User_Id String False

Use this in the WHERE clause to retrieve the users a specific user is following other than the authenticated user.

Following_Screen_Name String False

Use this in the WHERE clause to retrieve the users a specific user is following other than the authenticated user.

Location String True

The location of the user.

Profile_URL String True

The URL for the user's profile.

Profile_Image_URL String True

The URL for the image of the user.

Protected Boolean True

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 True

The ISO language code of the user.

Created_At Datetime True

When the user account was created.

Friends_Count Integer True

The number of people this user is following.

Followers_Count Integer True

The number of followers the user has.

Favourites_Count Integer True

The number of favorites the user has.

Statuses_Count Integer True

The number of status updates or tweets the user has made.

UTC_Offset Integer True

The Coordinated Universal Time offset for the user in seconds.

Time_Zone String True

The time zone of the user.

Notifications Boolean True

Boolean indicating if the user has notifications enabled.

Geo_Enabled Boolean True

Boolean indicating if the user has geo-enabled turned on in their profile.

Verified Boolean True

Boolean indicating if the user account has been verified.

Following Boolean True

Boolean indicating if the user is following you.

Contributors_Enabled Boolean True

Boolean indicating if contributors are enabled for the account. Typically used in multiuser accounts.

Follow_Request_Sent Boolean True

If the user is a protected user, this column indicates if the authenticated user has sent a request to follow them.

Listed_Count Integer True

The number of public lists a user is listed in. -1 if unknown.

Is_Translator Boolean True

Boolean indicating if the user contributes to translating Twitter in other languages.

NextPageToken String True

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.

 

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
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.

rows@next String

This is used to page through multiple pages of results and should not be set manually.

 

 

 

Tweets

Create, delete, and query status updates and tweets from the authenticated user.

 

Table Specific Information
Select

 

 

Tweets posted on Twitter will appear here. Tweets may come from the authenticated user's home page, they may be searched for, or they may come from a specific user or list. Note that some columns will always be null unless the SearchTerms pseudo column is specified.

By default, Tweets will return tweets from the authenticated user's home page. By specifying SearchTerms, tweets that match the terms used in the search will return. Valid search terms may be found under the topic "Standard Search Operators", located here: https://developer.twitter.com/en/docs/tweets/search/guides/standard-operators.

Note:SearchTerms may not be used with Screen_Name, User_Id, List_Id, Slug, Owner_User_Id, or Owner_Screen_Name.

The Screen_Name and User_Id pseudo columns can be used to return tweets made by the specified user. Alternatively, use the From_User_Name and From_User_Id columns to do the same thing.

The List_Id pseudo column may be specified to return tweets made in a specific list. Alternatively, the list may be specified using the Slug and either Owner_User_Id or Owner_Screen_Name.

The Min_Id and Max_Id pseudo columns may be used to narrow down a range of tweets to return, or to return only recent tweets. 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 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.

Full Archive and 30-day Searches

 

By default, Twitter only supports returning Tweets from searches that are up to 7 days old. However, customers with premium accounts may retrieve tweets older than this by executing either a 30-day or full archive search.

The EnvType and DevEnvironment pseudo columns may be used to query Premium Search APIs. EnvType specifies the environment type. It can take one of 30day or fullarchive values. The default value is 30day. The DevEnvironment is required in order to query the Premium Search API and must be set to the value of the dev environment label, created in your Twitter Developer Account. You should use a Premium or Enterprise app in your OAuth connection properties to use the feature. A SearchTerms value must be specified in order to use this feature.

Insert

 

In order to insert a tweet, simply specify the text of the tweet in the INSERT command. For example:

INSERT INTO Tweets (Text) VALUES ('Hello World')

 

In order to insert a tweet with media, specify the text of the tweet and the media file paths MediaFilePath#INDEX for every media file in the INSERT command.You may include up to 4 photos or 1 animated GIF or 1 video in a Tweet. For example:

INSERT INTO Tweets (Text, MediaFilePath#1,MediaFilePath#2) VALUES ('Hello World','C:\\myfile.jpg','C:\\myfile2.jpg')

 

If you already have media ids you can insert them in a tweet by providing media ids MediaId#INDEX of every media, in INSERT command. For example:

INSERT INTO Tweets (Text, MediaId#1,MediaId#2) VALUES ('Hello World','123456789','123456789')

 

In order to retweet an existing tweet, specify the Id column when inserting the tweet. For example:

INSERT INTO Tweets (Id) VALUES ('123456789')
Columns

 

 

 

   
Name Type ReadOnly Description
ID [KEY] String False

The Id of the status update or tweet. Set this value when inserting to retweet an existing tweet.

IDLong Long False

The long type Id of the status update or tweet.

SearchTerms String False

The SearchTerms to search against. This cannot be used with the Screen_Name or User_Id inputs. For more information on using the advanced query operators, see the Twitter API documentation here: https://dev.twitter.com/docs/using-search. Roughly 1500 results can be returned using the SearchTerms.

Created_At Datetime True

When the tweet was made.

Text String False

The text of the tweet.

Lang String True

Language code the tweet was made in.

Source String True

Source of the tweet.

Favorited Boolean True

Boolean indicating if this tweet has been favorited.

Favorite_Count Integer True

The approximate number of times this tweet has been favorited.

Retweeted Boolean True

Boolean indicating if this tweet has been retweeted.

Retweet_Count Integer True

The number of times the tweet has been retweeted.

Retweeted_Status_Id String True

Id of the tweet which was retweeted by this one. Empty if the current tweet is not a retweet.

Truncated Boolean True

Boolean indicating if this tweet has been truncated.

Filter_Level String True

Indicates the maximum value of the Filter_Level parameter that can be used and still stream this tweet.

Possibly_Sensitive String True

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 True

When present and set to true, indicates that this piece of content has been withheld due to a DMCA complaint.

Withheld_Scope String True

When present, indicates whether the content being withheld is the status or a user.

Withheld_In_Countries String True

A list of uppercase, two-letter country codes this content is withheld from.

Contributors String True

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 True

The geographic coordinates of this tweet (longitude first, then latitude).

Coordinates_Type String True

The type of coordinate, if applicable.

Place_Full_Name String True

The full name of the location of this tweet (city and state).

Place_Country String True

The country of origin of this tweet.

Current_User_Retweet_Id String True

Details the tweet Id of the authenticated user's own retweet (if it exists) of this tweet.

Scopes String True

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 True

Represents the Id of the original status if this tweet is in reply to another.

From_User_Id String True

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 True

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 True

Name of the user who made the tweet.

From_User_Location String True

Location of the user who made the tweet.

From_User_Profile_URL String True

URL to the user who made the tweet. This is not returned when a SearchTerms is specified.

From_User_Profile_Image_Url String True

URL to the profile image for the from user.

To_User_Id String True

Id of the user who made the tweet. Use this in the WHERE clause to get tweets for the specified user.

To_User_Screen_Name String True

Screen name of the user who made the tweet.

User_Mentions String True

Mentions of other users in the tweet, returned as an XML aggregate.

URLs String True

URLs in the tweet, returned as an XML aggregate.

Hashtags String True

Hashtags in the tweet, returned as an XML aggregate.

Media String True

Media in the tweet, returned as an XML aggregate.

NextPageToken String True

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.

 

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
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. Only useful when no filters are specified (listing own tweets), From_User_Id, From_User_Screen_Name are specified (listing a user's tweets) or when List_Id is specified (listing the tweets from a list of User ids). Has no effect when used with SearchTerms. By default twitter includes retweets.

The allowed values are true, false.

The default value is true.

Result_Type String

Indicates the type of results to return when using a SearchTerms. Currently Twitter has only popular and recent results.

The allowed values are popular, recent.

List_Id String

Used to specify the list Id to retrieve tweets from. This value does not work with SearchTerms, Screen_Name, or User_Id.

Slug String

Alternative method of specifying a list. Use this in with an Owner_User_Id and Owner_Screen_Name to specify a list without a List_Id.

Owner_User_Id String

Alternative method of specifying a list. Use this with a Slug to specify a list without the list Id.

Owner_Screen_Name String

Alternative method of specifying a list. Use this with a Slug to specify a list without the List_Id.

Geocode String

If this parameter is used with a SearchTerms, the query will return tweets from the specified geographical location. The geocode is specified in this manner: Lat,Long,Radius. For example: 37.781157,-122.398720,25mi

RetweetId String

When making a new tweet, specify this value to retweet the specified tweet.

MediaId# String

The media Ids to associate with the tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a tweet.

MediaFilePath# String

The media file path to associate with the tweet. You may include up to 4 photos or 1 animated GIF or 1 video in a tweet.

EnvType String

The environment type you want to use.

The allowed values are 30day, fullarchive.

The default value is 30day.

DevEnvironment String

To begin using the new Premium APIs, you need to setup one or more dev environments for the endpoint and connect it to an app.

rows@next String

This is used to page through multiple pages of results and should not be set manually.

 

 




 

Views

  1. AccountSettings
  2. AdAccounts
  3. AdAudienceConversations
  4. AdAudienceDemographics
  5. AdAvailableAudiences
  6. AdCampaigns
  7. AdFundingInstruments
  8. AdInsights
  9. AdLineItems
  10. AdPromotedTweets
  11. AdStats
  12. Followers
  13. ListMembers
  14. Lists
  15. ListSubscribers
  16. Mentions
  17. Retweets
  18. Trends
  19. Users

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.

 

 

 

AdAccounts

Retrieve all of the advertising-enabled accounts the authenticating user has access to.

 

View Specific Information
Select

 

There are no available filters for this view.

Columns

 

 

 

   
Name Type Description
Id [KEY] String The unique identifier of the ad account.
Name String The name of the account.
ApprovalStatus String Indicates if this account is eligible for promoting. One of the following values: ACCEPTED, UNDER_REVIEW, or REJECTED.
CreatedAt Datetime The time when the account was created.
UpdatedAt Datetime The time of the last change of the properties of this account.
Timezone String Time zone selected on account setup. Each campaign will run in this timezone.
TimezoneSwitchAt Datetime The time of the last timezone switch.
Deleted Boolean Whether the account is deleted.
Salt String Random string used to uniquely identify an account.

 

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.

 

 

 

AdAudienceConversations

Retrieve audience conversations based on a given conversation type for a set of targeting inputs and conversation type.

 

View Specific Information
Select
The driver uses the Twitter API to process search criteria that refer to AccountId, ConversationType, Gender, AgeBucket, and Geo. The driver processes other filters client-side within the driver. For example, the queries mentioned below are processed server side. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will be ignored.

 

The AccountId criteria is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

You can use any combination of ConversationType (required) and Gender, AgeBucket, and Geo (at least one required) as inputs for conversation related statistics.

SELECT * FROM AdAudienceConversations WHERE ConversationType='HASHTAG' AND Gender='1' AND AgeBucket='AGE_13_TO_24'

SELECT * FROM AdAudienceConversations WHERE ConversationType='EVENT' AND Geo='5a110d312052166f'

SELECT * FROM AdAudienceConversations WHERE ConversationType='HANDLE' AND AgeBucket='AGE_21_TO_34'
Columns

 

 

 

   
Name Type Description
AccountId String Id of the advertising account to work with.
TargetingType String The type of target used in the conversation.
LocalizedTargetingType String The localized version of the type of target used in the conversation.
OperatorType String The type of operator connecting the targeting type and the targeting value.
TargetingValue String The targeting value used in the conversation.
LocalizedTargetingValue String The localized version fo the targeting value used in the conversation.
ConversationType String The type of conversation being requested for the given inputs.

The allowed values are EVENT, HASHTAG, HANDLE.

Gender String The value of gender to filter conversations by.

The allowed values are 0, 1, 2.

AgeBucket String The age bucket to be used as input for filtering conversations.

The allowed values are AGE_13_TO_24, AGE_13_TO_34, AGE_13_TO_49, AGE_13_TO_54, AGE_18_TO_34, AGE_18_TO_49, AGE_18_TO_54, AGE_21_TO_34, AGE_21_TO_49, AGE_21_TO_54, AGE_25_TO_49, AGE_25_TO_54, AGE_35_TO_49, AGE_35_TO_54, AGE_OVER_13, AGE_OVER_18, AGE_OVER_21, AGE_OVER_25, AGE_OVER_35, AGE_OVER_50.

Geo String The id of the location to be used for filtering conversation.

 

 

 

AdAudienceDemographics

Retrieve audience intelligence demographics for a set of targeting inputs and audience definition (either TARGETING_CRITERIA or KEYWORD_AUDIENCE).

 

View Specific Information
Select
The driver uses the Twitter API to process search criteria that refer to AccountId, AudienceDefinition, Gender, AgeBucket, Geo, BoardMatchKeyword, StartTime, and EndTime. The driver processes other filters client-side within the driver. For example, the queries mentioned below are processed server side. You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will be ignored.

 

The AccountId criteria is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

For TARGETING_CRITERIA audience definition, you can use Gender, AgeBucket, and Geo as inputs (at least one required). For KEYWORD_AUDIENCE audience definition, you can use BroadMatchKeyword (required), StartTime (required), and EndTime as inputs.

SELECT * FROM AdAudienceDemographics WHERE AudienceDefinition='TARGETING_CRITERIA' AND Gender='2' AND AgeBucket='AGE_OVER_50'

SELECT * FROM AdAudienceDemographics WHERE AudienceDefinition='TARGETING_CRITERIA' AND Gender='2' AND AgeBucket='AGE_OVER_50' AND Geo='5a110d312052166f'

SELECT * FROM AdAudienceDemographics WHERE AudienceDefinition='KEYWORD_AUDIENCE' AND BroadMatchKeyword='womensmarch6018' AND StartTime='2017-12-31'

SELECT * FROM AdAudienceDemographics WHERE AudienceDefinition='KEYWORD_AUDIENCE' AND BroadMatchKeyword='facebook' AND StartTime='2017-12-31' AND EndTime='2018-01-30'
Columns

 

 

 

   
Name Type Description
AccountId String Id of the advertising account to work with.
Category String The demographic category for the given inputs.
MatchRate Double The match rate for the category for the given inputs.
Name String The name of the result for the category.
Percentage Double The percentage of people that fit to the given target.
Value String The value of the result for the category.
Source String The source of the data for the category.
AudienceDefinition String The type of audience definition to be used to collect stats for this demographic.

The allowed values are TARGETING_CRITERIA, KEYWORD_AUDIENCE.

Gender String The value of gender to filter demographics by. Only valid for TARGETING_CRITERIA audience definition.

The allowed values are 0, 1, 2.

AgeBucket String The age bucket to be used as input for filtering demographics. Only valid for TARGETING_CRITERIA audience definition.

The allowed values are AGE_13_TO_24, AGE_13_TO_34, AGE_13_TO_49, AGE_13_TO_54, AGE_18_TO_34, AGE_18_TO_49, AGE_18_TO_54, AGE_21_TO_34, AGE_21_TO_49, AGE_21_TO_54, AGE_25_TO_49, AGE_25_TO_54, AGE_35_TO_49, AGE_35_TO_54, AGE_OVER_13, AGE_OVER_18, AGE_OVER_21, AGE_OVER_25, AGE_OVER_35, AGE_OVER_50.

Geo String The id of the location to be used for filtering demographics. Only valid for TARGETING_CRITERIA audience definition.
BroadMatchKeyword String A broad keyword to be used for filtering demographics. Only valid for KEYWORD_AUDIENCE audience definition.
StartTime Date Specifies the date starting from when the demographics will be collected. Required, and only valid for KEYWORD_AUDIENCE audience definition.
EndTime Date Specifies the date untill when the demographics will be collected. Only valid for KEYWORD_AUDIENCE audience definition.

 

 

 

AdAvailableAudiences

Query available audiences for this account.

 

View Specific Information
Select

 

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

 

 

 

   
Name Type Description
AccountId String Id of the advertising account to work with.
AudienceType String A group which includes certain users based on location and activity. There are three types of audiences: ALL_ON_TWITTER is an audience type that includes all users in the United States. ORGANIC is an audience type that includes the set of users who have interacted with organic content belonging to the full promotable (primary) user of the ads account. CAMPAIGN is an audience type that includes the set of users who have interacted with past campaigns.
InteractionTypes String How the audience interacted with the ad. Your reached audience refers to users who are viewing your campaign, while your engaged audience includes the users who are actively engaging (responding to, favoriting, and retweeting) with your ads. Data on users who have converted in the past is available if the ads account has conversion tracking.
AudienceValue String The identifier (Id) of the available audience set requested. Availability depends on the AudienceType.

 

 

 

AdCampaigns

Retrieve details for some or all campaigns associated with the current account.

 

View Specific Information
Select

 

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

 

 

 

   
Name Type Description
Id [KEY] String The unique identifier of the campaign. Used to identify a specific campaign.
AccountId String Id of the advertising account to work with.
Name String The name of the campaign.
CreatedAt Datetime The time when campaign was created.
UpdatedAt Datetime The time of the last change of the properties of this campaign.
StartTime Datetime The time when the campaign started serving.
EndTime Datetime The time when the campaign stopped serving.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
TotalBudget Long The total budget the user has set for this campaign.
DailyBudget Long Daily budget limit to spend on this campaign.
Currency String Default currency.
FundingInstrumentId String The Id which identifies the funding instrument used to get the budget for this campaign.
StandardDelivery String If true, this field specifies an even spend rate throughout the day. Otherwise impressions will be served and engagements will be generated as quickly as possible until your daily budget is exhausted, which may be quite early on in the day, depending on targeting and competition. This is called accelerated delivery.
Deleted Boolean Indicates if this campaign is deleted and not serving anymore.

 

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.

 

 

 

AdFundingInstruments

Retrieve some or all funding instruments associated with the account specified in the path.

 

View Specific Information
Select

 

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

 

 

 

   
Name Type Description
Id [KEY] String Identifier for a funding instrument.
AccountId String Id of the advertising account to work with.
Type String A funding instrument can be one of the following types: Credit Cards, Credit Lines, Multi-Handle Credit Lines.
Description String Exdended info for the funding instrument.
CreatedAt Datetime The time when this record was created.
UpdatedAt Datetime The time of the last charge related to the properties of this item.
CreditLimit Long The credit limit in local micro.
FundedAmount Long The funded amount in local micro.
CreditRemaining Long The credit remaining in local micro.
Currency String Default currency.
StartTime Datetime The time when this instrument became available to use.
EndTime Datetime The time when this instrument stoped being available to use.
Cancelled Boolean Indicates if an instrument is canceled.
Deleted Boolean Indicates if this item is deleted and cannot be used anymore.

 

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.

 

 

 

AdInsights

Provide qualitative information about various Twitter audiences.

 

View Specific Information
Select

 

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

 

 

 

   
Name Type Description
AccountId String The Id of the advertising account to work with.
Category String The top level category of the insight. For example: network_operators, interests, or devices.
Type String This is a specific type of insight and takes values based on the parent category. For instance, for the category Devices, the type can be Android or iOS.
Percentage Decimal The percentage of the audience which is part of this category type.
TypeValue String The internal API value related to a specific audience type.
AudienceType String A group which includes certain users based on location and activity. There are three types of audiences: ALL_ON_TWITTER is an AudienceType that includes all users in the United States. ORGANIC is an AudienceType that includes the set of users who have interacted with organic content belonging to the full promotable (primary) user of the ads account. CAMPAIGN is an AudienceType that includes the set of users who have interacted with past campaigns.
AudienceValue String The identifier (Id) of the available audience set requested. Availability depends on the audience type.
InteractionType String The type of interaction captured for the available audience set requested.

 

 

 

AdLineItems

Retrieve some or all funding instruments associated with the account specified.

 

View Specific Information
Select

 

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

 

 

 

   
Name Type Description
Id [KEY] String The unique line item Id. Used to identify a specific line item.
AccountId String The identifier for the leveraged account.
CampaignId String The Id of the campaign to work with.
Name String A name assigned to the line item. If left blank, the name will default to Untitled.
TotalBudget Long An number representing the bid amount associated with this line item. The currency associated with the specified funding instrument will be used. For USD, $1.50 is encoded as 1.50*1e6, or 1,500,000.
BidType String The bidding mechanism.
AutomaticallySelectBid Boolean This boolean parameter, when set to true, will automatically optimize bidding based on daily budget and campaign flight dates.
ProductType String The type of promoted product that this line item will contain.
Placements String The comma-separated list of placement locations for this line item to display in.
Objective String The campaign objective for this line item.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
IncludeSentiment String Whether this line item is targeted to tweets with both positive or negative sentiment. A tweet is said to have positive or negative sentiment if the tone of the tweet is positive. This is only valid for the ProductType of PROMOTED_TWEETS and with either placements of ALL_ON_TWITTER or TWITTER_TIMELINES. Possible values: POSITIVE_ONLY (default) targets only tweets with positive sentiment; ALL targets all tweets, including those with negative sentiment.
TotalBudgetAmountLocalMicro Long An number representing the total budget amount to be allocated to the line item. The currency associated with the specified funding instrument and campaign will be used. For USD, $37.50 is encoded as 37.50*1e6, or 37,500,000.
StartTime Datetime The UTC time that the line item will begin serving. Must be more recent than the current time.
EndTime Datetime The UTC time that the line item will stop serving. If specified, must be more recent than the StartTime of the line item.
PrimaryWebEventTag String The identifier of the primary Web event tag. Allows more accurate tracking of engagements for the campaign pertaining to this line item.
Optimization String The optimization setting to use on this ad group (line item).
BidUnit String This field is returned for line items using the APP_INSTALLS objective. Defaults to bid unit based on objective.
ChargeBy String This field is returned for line items using the APP_INSTALLS objective. Defaults to charging by bid unit except for line items with bid unit APP_INSTALLS, where it defaults to charging by app clicks.
AdvertiserDomain String The website domain for this advertiser, without protocol specification. This field is available for line items using the Twitter Audience Platform (TAP).
Categories String The relevant IAB categories for this advertiser. This setting is available for line items using the Twitter Audience Platform (TAP).
TargetCPALocalMicro Integer An integer representing the target CPA amount to be allocated to the line item. The currency associated with the specified funding instrument and campaign will be used. For USD, $5.50 is encoded as 5.50*1e6, or 5,500,000.
CreatedAt Datetime The time when the campaign was created.
UpdatedAt Datetime The time of the last change of the properties of this campaign.

 

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.

 

 

 

AdPromotedTweets

Retrieve all of the advertising-enabled Tweets the authenticating user has access to.

 

View Specific Information
Select

 

Only the AccountId filter is supported. This is a common required filter for all views related to analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.

Columns

 

 

 

   
Name Type Description
Id [KEY] String The identifier corresponding to the specific promotion.
TweetId String The Id of the status update or tweet that is promoted.
LineItemId String The Id of the line item this tweet is part of.
AccountId String The Id of the advertising account to work with.
CreatedAt Datetime The time when the tweet was promoted.
UpdatedAt Datetime The time when the tweet was updated.
Deleted Boolean A boolean indicating if this item is deleted.
EntityStatus String The status for this entity: ACTIVE, DRAFT, and PAUSED.
ApprovalStatus String Indicates if this promotion is approved.

 

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
IncludeDeleted String Boolean used for including or not the deleted accounts.

The default value is false.

 

 

 

AdStats

Query information about all available metrics for a certain entity.

 

View Specific Information

 

AdStats contain all available analytic metrics for all types of entities. When querying this view only the metrics supported by the specified entity will be populated with values.

Select

 

Below are the fields that can be specified to filter the results.

 

   
AccountId This is a common required filter for all views related to Twitter analytics. If specified, it will override the value of the AccountId connection property. Otherwise, if no value is specified, the driver will try to get the first account from the list returned by the AdAccount view.
StartTime and EndTime Used to specify the time window. It should not exceed the interval of 7 days. If a window is not specified, the stats for the last seven days will be returned.
SELECT * FROM AdStats WHERE StartTime >= '12/02/2016' AND EndTime <= '12/09/2016'
Entity and EntityId There are 5 entity types:
  • ACCOUNT
  • FUNDING_INSTRUMENT
  • CAMPAIGN
  • LINE_ITEM
  • PROMOTED_TWEET
  • ORGANIC_TWEET

Each entity has its own view that can be used to list available items and get their respective Id. By default, if none of those filters are specified, the driver tries to get stats for the account whose Id is specified in the AccountId connection property.

SELECT * FROM AdStats WHERE EntityId='807000624822882304' and Entity='ORGANIC_TWEET'

 

Granularity This value determines how granular the data points will be returned. Available values for granularity are TOTAL, DAY, and HOUR. If set to a value other than TOTAL, the stats will be returned broken down for each unit of the interval specified by StartTime and EndTime. For instance if set to DAY, there will be returned stats for each day of the specified interval. By default this is set to DAY.
SELECT * FROM AdStats WHERE Granularity='HOUR'
Placement Used to return preaggregated metrics for all placements across Twitter or on the Twitter Audience Platform. Available values are ALL_ON_TWITTER and PUBLISHER_NETWORK. Do note that placement takes in a single value, so separate queries are required to fetch analytics data for placement on Twitter and placement on the Twitter Audience Platform. By default this is set to ALL_ON_TWITTER.
SELECT * FROM AdStats WHERE Placement='PUBLISHER_NETWORK'

 

The listed filters are optional, but it is recommended to specify at least the Entity, EntityId, and the time window.

SELECT * FROM AdStats WHERE EntityId='807000624822882304' and Entity='ORGANIC_TWEET' and StartTime >= '12/02/2016' and EndTime <= '12/09/2016' 
Columns

 

 

 

   
Name Type Description
AccountId String The Id of the advertising account to work with.
Entity String The entity to query.
EntityId String The Id of the entity to query.
StartTime Date Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
EndTime Date Scopes the retrieved data to data collected in the window of time between StartTime and EndTime. Must be expressed in whole hours.
Placement String The placement. Possible values: ALL_ON_TWITTER, PUBLISHER_NETWORK.

The allowed values are ALL_ON_TWITTER, PUBLISHER_NETWORK.

Granularity String Determines how granular the data points will be returned within the time range specified by StartTime and EndTime. For instance, when set to HOUR, you will be presented with a datapoint for each hour between StartTime and EndTime.

The allowed values are TOTAL, DAY, HOUR.

Engagements Integer Total number of engagements.
Impressions Integer Total number of impressions.
Retweets Integer Total number of retweets.
Replies Integer Total number of replies.
Likes Integer Total number of likes.
Follows Integer Total number of follows.
CardEngagements Integer Total number of card engagements.
Clicks Integer Total number of clicks.
AppClicks Integer Number of app install or app open attempts.
UrlClicks Integer Number of clicks on linked URLs.
QualifiedImpressions Integer Total number of qualified impressions.
BilledEngagements Integer Total number of billed engagements.
BilledCharge Integer Total spent in micros.
VideoTotalViews Integer Total number of video views.
VideoViews25 Integer Total number of views where at least 25% of the video was viewed.
VideoViews50 Integer Total number of views where at least 50% of the video was viewed.
VideoViews75 Integer Total number of views where at least 75% of the video was viewed.
VideoViews100 Integer Total number of views where 100% of the video was viewed.
VideoCTAClicks Integer Total clicks on the call to action.
VideoContentStarts Integer Total number of video playback starts.
VideoMrcViews Integer Total number of views according to Media Rating Council guidelines.
Video3s100pctViews Integer Total number of views where at least 3 seconds were played while 100% in view.
MediaViews Integer Total number of views (autoplay and click) of media across videos, vines, GIFs, and images.
MediaEngagements Integer Total number of clicks of media across videos, vines, GIFs, and images.
Purchases Integer Number of conversions of type PURCHASE and the corresponding sale amount and order quantity.
SignUps Integer Number of conversions of type SIGN_UP and the corresponding sale amount and order quantity.
SiteVisits Integer Number of conversions of type SITE_VISIT and the corresponding sale amount and order quantity.
Downloads Integer Number of conversions of type DOWNLOAD and the corresponding sale amount and order quantity.
ConversionCustom Integer Number of conversions of type CUSTOM and the corresponding sale amount and order quantity.
MobileConversionSpentCredits Integer Breakdown of mobile conversions of type SPENT_CREDIT by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionInstalls Integer Breakdown of mobile conversions of type INSTALL by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionContentViews Integer Breakdown of mobile conversions of type CONTENT_VIEW by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionAddToWishlists Integer Breakdown of mobile conversions of type ADD_TO_WISHLIST by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionCheckoutsInitiated Integer Breakdown of mobile conversions of type CHECKOUT_INITIATED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionReservations Integer Breakdown of mobile conversions of type RESERVATION by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionTutorialsCompleted Integer Breakdown of mobile conversions of type TUTORIAL_COMPLETED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionAchievementsUnlocked Integer Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionSearches Integer Breakdown of mobile conversions of type SEARCH by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionAddToCarts Integer Breakdown of mobile conversions of type ADD_TO_CART by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionPaymentInfoAdditions Integer Breakdown of mobile conversions of type PAYMENT_INFO_ADDITION by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionReEngages Integer Breakdown of mobile conversions of type RE_ENGAGE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionShares Integer Breakdown of mobile conversions of type SHARE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionRates Integer Breakdown of mobile conversions of type RATE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionLogins Integer Breakdown of mobile conversions of type LOGIN by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionUpdates Integer Breakdown of mobile conversions of type UPDATE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionLevelsAchieved Integer Breakdown of mobile conversions of type LEVEL_ACHIEVED by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionInvites Integer Breakdown of mobile conversions of type INVITE by post view, post engagement, whether assisted, order quantity, and sale amount.
MobileConversionKeyPageViews Integer Breakdown of mobile conversions of type KEY_PAGE_VIEW by post view and post engagement.
LifetimeValuePurchases Integer Breakdown of mobile conversions of type PURCHASE.
LifetimeValueSignUps Integer Breakdown of mobile conversions of type SIGN_UP.
LifetimeValueUpdates Integer Breakdown of mobile conversions of type UPDATE.
LifetimeValueTutorialsCompleted Integer Breakdown of mobile conversions of type TUTORIAL_COMPLETED.
LifetimeValueReservations Integer Breakdown of mobile conversions of type RESERVATION.
LifetimeValueAddToCarts Integer Breakdown of mobile conversions of type ADD_TO_CART.
LifetimeValueAddToWishlists Integer Breakdown of mobile conversions of type ADD_TO_WISHLIST.
LifetimeValueCheckoutsInitiated Integer Breakdown of mobile conversions of type CHECKOUT_INITIATED.
LifetimeValueLevelsAchieved Integer Breakdown of mobile conversions of type LEVEL_ACHIEVED.
LifetimeValueAchievementsUnlocked Integer Breakdown of mobile conversions of type ACHIEVEMENT_UNLOCKED.
LifetimeValueShares Integer Breakdown of mobile conversions of type SHARE.
LifetimeValueInvites Integer Breakdown of mobile conversions of type INVITE.
LifetimeValuePaymentInfoAdditions Integer Breakdown of mobile conversions of type PAYMENT_INFO_ADDITION.
LifetimeValueSpentCredits Integer Breakdown of mobile conversions of type SPENT_CREDIT.
LifetimeValueRates Integer Breakdown of mobile conversions of type RATE.

 

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
rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.
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.

 

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
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.

rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.
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.

 

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
rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.
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.

 

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
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.
rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.
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.

 

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
rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.
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.

 

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
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.

rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.
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.

 

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
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.

rows@next String This is used to page through multiple pages of results and should not be set manually.

 

 

 

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.

 

 

 

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).
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.

 

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
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.
rows@next String This is used to page through multiple pages of results and should not be set manually.