Getting Started

This page provides a guide to Establishing a Connection to LinkedIn in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to LinkedIn

Establishing a Connection shows how to authenticate to LinkedIn and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from LinkedIn through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to LinkedIn by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to LinkedIn

The LinkedIn CompanyId is a string of numbers, usually 6 to 9 digits long, that is unique to your company. Working with LinkedIn entities that require the CompanyId to be exposed, requires Company Page Administrator permissions.

There are two ways to find your site's LinkedIn Company ID:

Look at the URL of the search results page when you search for your company name in your LinkedIn page's Company dropdown. The ID is the value in the URL after /search/?f_C=[numeric value]&.
As a LinkedIn Page Admin, use the All Pages or Home tab to navigate to the page's Admin View. The ID is the numbers in the URL that come after https://www.linkedin.com/company/.

CompanyId is required in most of the LinkedIn data model entities. You can specify it directly as part of a query or -- if the query you are using is not easily modified -- you can set it globally.

If you are not sure if it is required for a query you want to run, check the table or view description, or see whether it is specified as a column or pseudo-column.

Authenticating to LinkedIn

LinkedIn provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to LinkedIn from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in LinkedIn, see Connection.

When the access token expires, the Cloud refreshes it automatically.

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to LinkedIn via a desktop application or a headless machine.

However, you must create a custom OAuth application to connect to LinkedIn via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

control branding of the authentication dialog;
control the redirect URI that the application redirects the user to after the user authenticates; or
customize the permissions that you are requesting from the user.

Procedure

To create a custom OAuth application that obtains the OAuth connection properties:

Log in to the LinkedIn Developer Platform.
Click Create app.
Enter information to be displayed to users when they are prompted to grant permissions to your application.

After the application is created:

Select the application that was created and request access for Advertising API from the list of Products. The LinkedIn Marketing Developer Platform Access Form displays.
Fill in the required details and submit the form.
After LinkedIn makes the new custom application available, navigate to the Auth section.
- Configure the following OAuth 2.0 scopes: r_basicprofile, r_emailaddress, r_organization_social, and r_organization_admin.
- Configure the authorized Redirect URLs.

The OAuthClientId and OAuthClientSecret display on the same page. Make a note of these values for future reference.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Cloud models entities in the LinkedIn API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - LinkedIn Views


Name	Description
Comments	Query Comments data for Posts in the Organization Pages that you administer.
CompanyDetails	Retrieve company profiles and updates.
CompanyFollowerStatistics	Query statistics about followers for a particular company page.
CompanyList	Lists all companies and the privileges that the user has within the organization.
CompanyLocations	Retrieve company locations information.
CompanyPageStatistics	Query statistics about page views for a particular company page.
CompanyStatusUpdates	Lists update events from the LinkedIn company page.
CompanyUpdateStatistics	Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.
GeoLocation	Provides the display name for a given geo Id, or a set of geo Ids.
Industries	Query the list of available industries in LinkedIn.
OrganizationFollowerCount	The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.
Profiles	Query profile information of LinkedIn members.

Comments

Query Comments data for Posts in the Organization Pages that you administer.

Note: Requires the r_organization_social OAuth scope.

Select

The Comments view supports filtering on the WHERE clause only for the UpdateId column and only for the = and IN operators. The = operator is fully supported server-side, whereas the IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Comments WHERE UpdateId = 'urn:li:share:7155174232715386880';
SELECT * FROM Comments WHERE UpdateId IN ('urn:li:share:7155174232715386880', 'urn:li:share:7165681621608738816');

The following query returns the data for the columns we expose in the view, for each Post in each Organization Page that the user administers.

SELECT * FROM Comments;

To retrieve information on Posts in your Organization Pages, use CompanyStatusUpdates.

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier for the comment.
UpdateId	String	Id of the Update associated with the comment.
Text	String	Content of the update comment.
CreatedBy	String	The unique identifier for the person or company.
Date	Datetime	Comment created time.

CompanyDetails

Retrieve company profiles and updates.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyDetails view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyDetails WHERE CompanyId = '183432'

Columns


Name	Type	Description
CompanyId [KEY]	String	The unique, internal, numeric identifier for the company in the following format urn:li:organization:{id}
CompanyName	String	The name of the company.
UniversalName	String	The unique string identifier for the company.
Description	String	The company description. Limit of 500 characters.
Specialties	String	The company specialties.
StaffCountRange	String	The company staff count range.
WebsiteUrl	String	The URL for the company website.
Logo	String	The original company logo.
SquareLogo	String	The square company logo.
CompanyTypeName	String	The name of the company type.
Groups	String	The groups of the company.
Industries	String	The industries of the company.
FoundedYear	Integer	The year the company was founded.
EndYear	Integer	The year listed for when the company closed or was acquired by another.
PrimaryOrganizationType	String	Type of primary organization being used in the lookup. Possible values: SCHOOL,BRAND,NONE
VanityName	String	Entity's unique name used in URLs.
VersionTag	String	Tag indicating version.

CompanyFollowerStatistics

Query statistics about followers for a particular company page.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyFollowerStatistics view supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyFollowerStatistics WHERE CompanyId = '183432'

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.


Inputs specified	Result
None	The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only (no TimeRangeEnd or TimeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only (no TimeRangeStart or TimeGranularity)	The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All	The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns


Name	Type	Description
CompanyId	String	Id of the Company associated with the follow statistics in the following format urn:li:organization:{id}.
Category	String	The category of the followers.
Type	String	Type of the category.
OrganicFollowerCount	Integer	Total number of the organinc followers.
PaidFollowerCount	Integer	Total number of the paid followers.
TimeGranularity	String	Granularity of the statistics. Must be either DAY or MONTH.
ReportTimeRangeStart	Datetime	Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd	Datetime	Inclusive ending timestamp of when the query should end. Queries until current time when not set.
UsageStartTime	Datetime	Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime	Datetime	Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.

CompanyList

Lists all companies and the privileges that the user has within the organization.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyList view returns a list of all companies that the member is an administrator of. For example:

SELECT * FROM CompanyList

Columns


Name	Type	Description
Id [KEY]	String	A unique identifier for the company in the following format urn:li:organization:{id}
RoleAssignee	String	Id of the assigned person.
Role	String	Role of the assigned person.
State	String	State of the company.

CompanyLocations

Retrieve company locations information.

Note: Requires the r_organization_admin OAuth scope.

Select

The CompanyLocations view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyLocations WHERE CompanyId = '183432'

Columns


Name	Type	Description
CompanyId	String	Id of the Company associated with the comment in the following format urn:li:organization:{id}
Description	String	The company description. Limit of 500 characters.
LocationType	String	Type of the location.
Street1	String	The first line of the street address for the company location.
Apartment	String	The number of the apatrment,suite etc. for the company location.
City	String	The city of the company location.
State	String	The state of the company location.
PostalCode	String	The postal code of the company location.
CountryCode	String	The country code of the company location.

CompanyPageStatistics

Query statistics about page views for a particular company page.

Note: Requires the r_organization_admin OAuth scope.

Select

The Cloud uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

CompanyId supports only the '=' operator.
TimeGranularity supports only the '=' operator.
ReportTimeRangeStart supports only the '=' operator.
ReportTimeRangeEnd supports only the '=' operator.

The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.

Lifetime page statistics: To retrieve lifetime page statistics, do not set the ReportTimeRangeStart and ReportTimeRangeEnd in the WHERE clause conditions. The API returns view and click statistics segmented by various facets. For example:
```
SELECT * FROM [CompanyPageStatistics]
```

Time-bound page statistics: To retrieve time-bound page statistics, include the ReportTimeRangeStart and/or ReportTimeRangeEnd in the WHERE clause conditions. The API returns aggregate page statistics within all of the days or months in between the selected date range based on the specified TimeGranularity (DAY or MONTH). For example:

SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-20' AND ReportTimeRangeEnd = '2020-10-15'

SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY'

SELECT * FROM [CompanyPageStatistics] WHERE TimeGranularity = 'MONTH' AND ReportTimeRangeStart = '2019-10-15' AND ReportTimeRangeEnd = '2020-10-15' AND companyId = '10904095'

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.


Inputs specified	Result
None	The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only (no TimeRangeEnd or TimeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only (no TimeRangeStart or TimeGranularity)	The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All	The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns


Name	Type	Description
CompanyId	String	Id of the Company associated with the page statistics in the following format urn:li:organization:{id}
Category	String	The category of the statistics.
Type	String	Type of the category. Not applicable for the totalPageStatistics category.
AllPageViews	Integer	Complete page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
AllDesktopPageViews	Integer	Complete desktop page views count.
AllMobilePageViews	Integer	Complete mobile page views count.
OverviewPageViews	Integer	Total Overview page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
CareersPageViews	Integer	Total Careers page views count.
DesktopCareersPageViews	Integer	Total desktop Careers page views count.
DesktopJobsPageViews	Integer	Total desktop Jobs page views count.
DesktopLifeAtPageViews	Integer	Total desktop Life Atpage views count.
DesktopOverviewPageViews	Integer	Total desktop Overview page views count.
JobsPageViews	Integer	Total Jobs page views count.
LifeAtPageViews	Integer	Total LifeAt page views count.
MobileCareersPageViews	Integer	Total mobile Careers page views count.
MobileJobsPageViews	Integer	Total mobile Jobs page views count.
MobileLifeAtPageViews	Integer	Total mobile LifeAt Page views count.
MobileOverviewPageViews	Integer	Total mobile Overview page views count.
MobileProductsPageViews	Integer	Total mobile Products page views count.
InsightsPageViews	Integer	Total Insights page views count.
MobileAboutPageViews	Integer	Total mobile About page views count.
ProductsPageViews	Integer	Total Products page views count.
DesktopProductsPageViews	Integer	Total desktop Products page views count.
PeoplePageViews	Integer	Total People page views count.
DesktopPeoplePageViews	Integer	Total desktop People page views count.
AboutPageViews	Integer	Total About page views count.
DesktopAboutPageViews	Integer	Total desktop About page views count.
MobilePeoplePageViews	Integer	Total mobile People page views count.
DesktopInsightsPageViews	Integer	Total desktop Insights page views count.
MobileInsightsPageViews	Integer	Total mobile Insights page views count.
MobileCareersPagePromoLinksClicks	Integer	Total mobile clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
MobileCareersPageJobsClicks	Integer	Total mobile clicks count on Careers page Jobs. Applicable only for the totalPageStatistics category.
MobileCareersPageEmployeesClicks	Integer	Total mobile clicks count on Careers page Employees. Applicable only for the totalPageStatistics category.
CareersPagePromoLinksClicks	Integer	Total clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
CareersPageBannerPromoClicks	Integer	Total clicks count on Careers page banner promo. Applicable only for the totalPageStatistics category.
CareersPageJobsClicks	Integer	Total clicks count on Careers page jobs. Applicable only for the totalPageStatistics category.
CareersPageEmployeesClicks	Integer	Total clicks count on Careers page employees. Applicable only for the totalPageStatistics category.
TimeGranularity	String	Granularity of the statistics. Must be either DAY or MONTH.
UsageStartTime	Datetime	Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime	Datetime	Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.
ReportTimeRangeStart	Datetime	Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd	Datetime	Inclusive ending timestamp of when the query should end. Queries until current time when not set.

CompanyStatusUpdates

Lists update events from the LinkedIn company page.

Note: Requires the r_organization_social OAuth scope.

Select

The CompanyStatusUpdates table supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example:

SELECT * FROM CompanyStatusUpdates WHERE CompanyId = '183432'

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier for the update.
Comment	String	Comment associated with update status.
CompanyId	String	Id of the Company associated with the update.
Date	Datetime	Update created time .
CreatedBy	String	Id of the person who created update.
FirstPublishedAt	Datetime	Time when update is published.
LastModified	Datetime	Last time when changes for this update are made.
Visibility	String	Visibility of the update.
LifecycleState	String	State of the update.

CompanyUpdateStatistics

Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.

Note: Requires the r_organization_admin scope.

Select

The Cloud uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.

CompanyId supports the '=' comparisons.
UGCPostId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM CompanyUpdateStatistics WHERE CompanyId = '183432'
SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId = 'urn:li:ugcPost:1234'
SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId IN ('urn:li:ugcPost:1234', 'urn:li:ugcPost:2345')

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.


Inputs specified	Result
None	The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only (no TimeRangeEnd or TimeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity)	The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only (no TimeRangeStart or TimeGranularity)	The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All	The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns


Name	Type	Description
Clicks	Integer	Total clicks count.
Comments	Integer	Total comments count.
CommentMentions	Integer	Total comment mentions count.
Engagement	Double	Total engagement count.
Impressions	Integer	Total impressions count.
Likes	Integer	Total likes count.
Shares	Integer	Total shares count.
ShareMentions	Integer	Total share mentions count.
UniqueImpressions	Integer	Total share mentions count.
TimeRangeStart	Datetime	Exclusive starting datetime of when the query should begin. When not set, queries from the beginning of time.
TimeRangeEnd	Datetime	Inclusive ending datetime of when the query should end. When not set, queries until the current time.
TimeGranularity	String	Granularity of the statistics. Must be either DAY or MONTH. Requires TimeRangeStart and TimeRangeEnd.
UGCPostId	String	The ID of the UGC post.
ShareId	String	The ID of the share.
CompanyId	String	Id of the Company associated with the update statistics.
IntervalStartTime	Datetime	Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime	Datetime	Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

GeoLocation

Provides the display name for a given geo Id, or a set of geo Ids.

GeoLocation requires an Id in SELECT statements. For example:

SELECT * FROM geolocation where id = 'urn:li:geo:123456'

To specify multiple geolocation Ids use the IN operator:

SELECT * FROM geolocation WHERE id IN (<List of geolocation ids>)

Columns


Name	Type	Description
Id [KEY]	String	Unique identifier for the entity. Can be a single Id or a comma-separated list of Ids.
Country	String	An uppercase two-letter country code as defined by ISO-3166.
Language	String	A lowercase two-letter language code as defined by ISO-639.
Value	String	The value of the display text.

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
LocaleLanguage	String	The locale language the country data is requested in. A lowercase two-letter language code as defined by ISO-639. The default value is en.
LocaleCountry	String	The locale country the country data is requested in. An uppercase two-letter country code as defined by ISO-3166. The default value is US.

Industries

Query the list of available industries in LinkedIn.

Columns


Name	Type	Description
Id [KEY]	Integer	The identifier of the industry.
Name	String	The name of the industry.
URN	String	The URN of the industry.
ParentId	Integer	The identifier of the parent industry of this industry.

OrganizationFollowerCount

The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.

Columns


Name	Type	Description
FirstDegreeSize	Integer	The number of first-degree connections (followers) for the organization.

Profiles

Query profile information of LinkedIn members.

Select

The Profiles view supports filtering only on the Id column and only with the = and IN operators, which are both processed server-side. Refer to the query examples below:

SELECT * FROM Profiles WHERE Id = 'XXXXXXXXXX';
SELECT * FROM Profiles WHERE Id IN ('XXXXXXXXXX', 'YYYYYYYYYY');

Note: Your OAuth tokenRequires the r_basicprofile scope.

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the member's profile.
FirstName	String	The first name of the member's profile.
LastName	String	The last name of the member's profile.
MaidenName	String	The maiden name of the member's profile.
Headline	String	The headline of the member's profile. Often this is the job title.
VanityName	String	The vanity name of the member's profile.
PictureAssetURN	String	The digital media asset URN for the picture of the member's profile.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT operations with LinkedIn.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from LinkedIn, along with an indication of whether the procedure succeeded or failed.

CData Cloud - LinkedIn Stored Procedures


Name	Description

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for LinkedIn:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the CompanyStatusUpdates table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='CompanyStatusUpdates'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the CompanyStatusUpdates table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='CompanyStatusUpdates'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:linkedin:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
CompanyId	The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.

Connection

Property	Description
APIVersion	The version of the LinkedIn Marketing API to be used.

OAuth

Property	Description
Scope	A specific scope that the user requires the access token.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from LinkedIn.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
CompanyId	The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.

CompanyId

The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.

Data Type

string

Default Value

""

Remarks

This property must be set in the connection string or query. Otherwise, the Cloud will use the first found company Id.

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

Property	Description
APIVersion	The version of the LinkedIn Marketing API to be used.

APIVersion

The version of the LinkedIn Marketing API to be used.

Data Type

string

Default Value

"202401"

Remarks

The API version used by default is 202401. To use a different API version set this to the format YYYYMM.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
Scope	A specific scope that the user requires the access token.

Scope

A specific scope that the user requires the access token.

Data Type

string

Default Value

""

Remarks

This property must be set in the connection string to get a scoped token with specific privileges.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

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

This property can take the following 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 is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

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

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from LinkedIn.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

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

Cloud

LinkedIn - CData Cloud

Overview

Key Features

Getting Started

Connecting to LinkedIn

Accessing Data from CData Cloud Services

Establishing a Connection

Connecting to LinkedIn

Authenticating to LinkedIn

Creating a Custom OAuth Application

Creating a Custom OAuth Application

Procedure

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Views

Stored Procedures

Views

CData Cloud - LinkedIn Views

Comments

Select

Columns

CompanyDetails

Select

Columns

CompanyFollowerStatistics

Select

Time-Based Data Queries

Columns

CompanyList

Select

Columns

CompanyLocations

Select

Columns

CompanyPageStatistics

Select

Time-Based Data Queries

Columns

CompanyStatusUpdates

Select

Columns

CompanyUpdateStatistics

Select

Time-Based Data Queries

Columns

GeoLocation

Columns

Pseudo-Columns

Industries

Columns

OrganizationFollowerCount

Columns

Profiles

Select

Columns

Stored Procedures

CData Cloud - LinkedIn Stored Procedures

System Tables

Schema Tables

Data Source Tables

Query Information Tables

sys_catalogs

Columns

sys_schemas

Columns

sys_tables

Columns

sys_tablecolumns

Columns

sys_procedures

Columns

sys_procedureparameters

Columns

sys_keycolumns