Cloud

Build 25.0.9539
  • LinkedIn
    • Getting Started
      • Establishing a Connection
      • Creating a Custom OAuth Application
      • OAuth Scopes and Endpoints
      • SSL Configuration
      • Firewall and Proxy
    • Data Model
      • Tables
        • Comments
        • CompanyStatusUpdates
        • Events
      • Views
        • CompanyDetails
        • CompanyFollowerStatistics
        • CompanyList
        • CompanyPageStatistics
        • CompanyUpdateStatistics
        • Documents
        • GeoLocation
        • Images
        • Industries
        • OrganizationAuthorizationActions
        • OrganizationFollowerCount
        • OrganizationLocations
        • Organizations
        • Profiles
        • Videos
        • VideoTimeWatchedForVideoViewsStatistics
        • VideoTimeWatchedStatistics
        • VideoViewerStatistics
        • VideoViewStatistics
      • Stored Procedures
        • CreateEvent
      • System Tables
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • Connection String Options
      • Authentication
        • CompanyId
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • Scope
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • Pagesize
        • PseudoColumns
        • ThrowsKeyNotFound
        • Timeout
    • Third Party Copyrights

LinkedIn - CData Cloud

Overview

CData Cloud offers access to LinkedIn across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to LinkedIn through CData Cloud.

CData Cloud allows you to standardize and configure connections to LinkedIn as though it were any other OData endpoint or standard SQL Server.

Key Features

  • Full SQL Support: LinkedIn appears as standard relational databases, allowing you to perform operations - Filter, Group, Join, etc. - using standard SQL, regardless of whether these operations are supported by the underlying API.
  • CRUD Support: Both read and write operations are supported, restricted only by security settings that you can configure in Cloud or downstream in the source itself.
  • Secure Access: The administrator can create users and define their access to specific databases and read-only operations or grant full read & write privileges.
  • Comprehensive Data Model & Dynamic Discovery: CData Cloud provides comprehensive access to all of the data exposed in the underlying data source, including full access to dynamic data and easily searchable metadata.

CData Cloud

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.

CData Cloud

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.

CData Cloud

Creating a Custom OAuth Application

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 for use with LinkedIn:

  1. Log in to the LinkedIn Developer Platform.
  2. Click Create app.
  3. Enter the page URL you want to associate with the app, alongside information to be displayed to users when they are prompted to grant permissions to your application.

After the application is created:

  1. Select your application.
  2. Navigate to the Products tab and request access to the API products (scopes) applicable for your use cases. Refer to OAuth Scopes and Endpoints for more details.
  3. Wait for LinkedIn to approve your application. After that is done, your application will have the OAuth 2.0 permissions it needs. These permissions will be visible in the Auth tab.
  4. Navigate to the Auth tab and configure the authorized Redirect URLs.

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

CData Cloud

OAuth Scopes and Endpoints

Required Scopes and Endpoint Domains for LinkedIn

When integrating with LinkedIn, your application needs specific permissions to interact with the API.

These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.

This topic provides information about the required access scopes and endpoint domains for the LinkedIn Cloud.

Understanding Scopes

Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.

For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.

Required Scopes for LinkedIn

To see what scopes are granted by each API product, refer to LinkedIn's documentation.

EntityStatement TypesMinimal Required Scopes
CommentsSELECTr_organization_social
CommentsINSERT UPDATE DELETE w_organization_social
CompanyStatusUpdatesSELECTr_organization_social
CompanyStatusUpdatesINSERT UPDATE DELETE w_organization_social
EventsSELECTr_events
NOTE: CData's embedded OAuth application does not support this scope. You must create a custom OAuth application and request access for Events Management API from the list of products (see Creating a Custom OAuth Application).
EventsUPDATErw_events
NOTE: CData's embedded OAuth application does not support this scope. You must create a custom OAuth application and request access for Events Management API from the list of products (see Creating a Custom OAuth Application).
CreateEventEXECUTErw_events
CompanyDetailsSELECTr_organization_admin
CompanyFollowerStatisticsSELECTr_organization_admin
CompanyListSELECTr_organization_admin
CompanyPageStatisticsSELECTr_organization_admin
CompanyUpdateStatisticsSELECTr_organization_admin
DocumentsSELECTr_organization_social
GeoLocationSELECT-
ImagesSELECTr_organization_social
IndustriesSELECT-
OrganizationAuthorizationActionsSELECTrw_organization_admin
OrganizationFollowerCountSELECT-
OrganizationLocationsSELECTr_organization_admin
OrganizationsSELECTr_organization_admin
ProfilesSELECTr_basicprofile
VideosSELECTr_organization_social
VideoTimeWatchedForVideoViewsStatisticsSELECTr_organization_social
VideoTimeWatchedStatisticsSELECTr_organization_social
VideoViewerStatisticsSELECTr_organization_social
VideoViewStatisticsSELECTr_organization_social
DownloadAssetEXECUTEr_organization_social
UploadDocumentEXECUTEw_organization_social
UploadImageEXECUTEw_organization_social
UploadVideoEXECUTEw_organization_social
UploadVideoCaptionsEXECUTE-
UploadVideoThumbnailEXECUTE-

Understanding Endpoint Domains

Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.

Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.

Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.

Required Endpoint Domains for LinkedIn

DomainAlways RequiredDescription
linkedin.comTrueThe main domain used for accessing the main LinkedIn API-s that the Cloud uses.
licdn.comFalseThe domain used for downloading LinkedIn assets through its CDN such as Images or Videos (see DownloadAsset as well).

CData Cloud

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

CData Cloud

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

  • ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
  • ProxyPort: the TCP port that the proxy server is running on.
  • ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
  • ProxyUser: the username of a user account registered with the proxy server.
  • ProxyPassword: the password associated with the ProxyUser.

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.

CData Cloud

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. The Cloud uses the LinkedIn API to process supported filters. The Cloud processes other filters client-side within the Cloud.

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.

CData Cloud

Tables

The Cloud models the data in LinkedIn as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - LinkedIn Tables

Name Description
Comments Query Comments data for Posts in the Organization Pages that you administer.
CompanyStatusUpdates Read and write posts in your organizations.
Events Read and update events in your organizations.

CData Cloud

Comments

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

Select

The Comments table supports filtering in the WHERE clause using the Id column with only the = operator, and for the UpdateId column with both 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 Id = 7155174232715386880 and UpdateId = 'urn:li:share:7155174232715386880';
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.

Insert

The Comments table supports creating new comments on the posts of the organization pages that the user administers. For successful creation, you will need to specify the UpdateId and Text parameters. If the CreatedBy parameter isn’t filled, the driver will use the URN of the authenticated user or the URN of the company if the CompanyId connection property is specified. Refer to examples below:
INSERT INTO Comments (UpdateId, Text) VALUES ('urn:li:share:7155174232715386880', 'Test Comment')
INSERT INTO Comments (UpdateId, Text, CreatedBy) VALUES ('urn:li:share:7155174232715386880', 'Test Comment', 'urn:li:organisation:101877555')

Update

The Comments table supports updating the content of the comments on the posts of the organization pages that the user administers. Only the Text field is updatable.
UPDATE Comments SET Text = 'Test Comment' WHERE Id = 715517423271578940
UPDATE Comments SET Text = 'Test Comment' WHERE Id = 715517423271578940 AND UpdateId = 'urn:li:share:7155174232715386880'

Delete

The Comments table supports removing comments from the posts of the organization pages that the user administers.
DELETE FROM Comments WHERE Id = 715517423271578940
DELETE FROM Comments WHERE Id = 715517423271578940 AND UpdateId = 'urn:li:share:7155174232715386880'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The unique identifier for the comment.

UpdateId String False

The identifier for the update associated with the comment.

Text String False

The content of the comment regarding the update.

CreatedBy String False

The unique identifier for the person or company.

Date Datetime True

The date or timestamp when the comment was last modified.

Mentions String True

The Uniform Resource Names (URNs) for the organizations or individuals mentioned in the comment.

CData Cloud

CompanyStatusUpdates

Read and write posts in your organizations.

Table-specific Information

Select

For the CompanyId column, the = operator is fully supported server-side. Refer to the query examples below:
SELECT * FROM CompanyStatusUpdates WHERE CompanyId = '183432'

Insert

The CompanyStatusUpdates table supports creating new posts in the organization pages that you administer. The following columns are required when creating a new post:

  • Comment
  • CreatedBy
  • Visibility
  • LifecycleState

Refer to the query examples below:

INSERT INTO CompanyStatusUpdates(Comment, CreatedBy, Visibility, LifecycleState, IsReshareDisabled) VALUES('Test Post', 'urn:li:organization:101409996', 'PUBLIC', 'DRAFT', true);

Update

The CompanyStatusUpdates table supports updating the posts in the organization pages that you administer. Only the following columns can be updated:

  • Comment
  • LifecycleState

The Id column must be specified in the criteria. Refer to the query examples below:

UPDATE CompanyStatusUpdates SET Comment = 'My Post', LifecycleState = 'PUBLISHED' WHERE Id = 'urn:li:share:7383870244806791168'

Delete

The CompanyStatusUpdates table supports deleting the posts in the organization pages that you administer. The Id column must be specified in the criteria. Refer to the query examples below:
DELETE FROM CompanyStatusUpdates WHERE Id = 'urn:li:share:7383870244806791168'

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique identifier for the post.

Comment String False

Text comment associated with the post.

CompanyId String True

Identifier of the company to which the post belongs.

Date Datetime True

Timestamp when the post was created.

CreatedBy String False

Identifier of the user who created the post.

FirstPublishedAt Datetime True

Timestamp when the post was published.

LastModified Datetime True

Timestamp when the post most last modified.

Visibility String False

Specifies who can view the post.

The allowed values are CONNECTIONS, PUBLIC, LOGGED_IN.

LifecycleState String False

Current lifecycle state of the post.

The allowed values are DRAFT, PUBLISHED, PUBLISH_REQUESTED, PUBLISH_FAILED.

Content String False

Main content of the post.

ContentCTALabel String True

The call-to-action label used in the post's content.

The allowed values are APPLY, DOWNLOAD, VIEW_QUOTE, LEARN_MORE, SIGN_UP, SUBSCRIBE, REGISTER, JOIN, ATTEND, REQUEST_DEMO, SEE_MORE, BUY_NOW, SHOP_NOW.

IsReshareDisabled Boolean False

Indicates if the author has disabled re-sharing for the post.

ParentPostURN String False

CompanyStatusUpdates.Id

URN of the parent post if the post is a re-share.

RootPostURN String True

CompanyStatusUpdates.Id

URN of the root post in the re-share chain if the post is a re-share.

CData Cloud

Events

Read and update events in your organizations.

Table-specific Information

Select

The = operator is fully supported server-side for the OrganizerURN column. The IN operator is partially supported server-side. Refer to the query examples below:
SELECT * FROM Events WHERE OrganizerURN = 'urn:li:organization:4975021'
SELECT * FROM Events WHERE OrganizerURN IN ('urn:li:organization:4975021', 'urn:li:organization:6554901')

When the OrganizerURN column is not specified in the criteria as in the example below:

SELECT * FROM Events
the Cloud internally transforms the query to the following before executing:
SELECT * FROM Events WHERE OrganizerURN IN (SELECT Id FROM CompanyList WHERE State = 'APPROVED' AND Role = 'ADMINISTRATOR')

Update

When updating events, the Id column must be specified in the criteria as in the query example below:
UPDATE Events SET VanityName = 'mytestevent7382067115601719297456' WHERE Id = '7382067115601719297456'

Deleting Events

To delete an event, delete its corresponding post. You can delete posts in your organization by executing DELETE statements on the CompanyStatusUpdates table.

Columns

Name Type ReadOnly References Description
Id [KEY] String True

Unique identifier for the event.

URN String True

URN of the event.

OrganizerURN String True

URN of the event organizer.

Name String True

Name of the event.

Description String True

Detailed description of the event.

Type String True

Type or category of the event. Data is returned in JSON format.

VanityName String False

Custom or user-friendly name for the event.

StartsAt Datetime True

Timestamp when the event starts.

BackgroundImageURN String True

URN of the event's background image.

LeadFormURN String True

URN of the lead generation form associated with the event.

DiscoveryMode String True

How the event is discovered or promoted.

PostURN String True

CompanyStatusUpdates.Id

URN of the post associated with the event.

CreatedBy String True

URN of the actor who created the event.

CreatedAt Datetime True

Timestamp when the event was created.

LastUpdatedBy String True

URN of the actor who last updated the event.

LastUpdatedAt Datetime True

Timestamp when the event was last updated.

CData Cloud

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
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.
CompanyPageStatistics Query statistics about page views for a particular 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.
Documents Read the metadata of the document assets created in the organizations you administer.
GeoLocation Provides the display name for a given geo Id, or a set of geo Ids.
Images Read the metadata of the image assets created in the organizations you administer.
Industries Query the list of available industries in LinkedIn.
OrganizationAuthorizationActions Read data on the authorization action assignments for the organizations in which you are a member.
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.
OrganizationLocations Retrieve location information for any LinkedIn organization, regardless of whether you manage that organization.
Organizations Query information about any LinkedIn organization, regardless of whether the individual is an administrator for that organization.
Profiles Retrieves LinkedIn member profile information.
Videos Read the metadata of the video assets created in the organizations you administer.
VideoTimeWatchedForVideoViewsStatistics Query statistics about the time watched in milliseconds for video.
VideoTimeWatchedStatistics Query statistics about the time the video was watched in milliseconds.
VideoViewerStatistics Query statistics about unique viewers who made engaged plays on the video.
VideoViewStatistics Query statistics about video views for a particular company page.

CData Cloud

CompanyDetails

Retrieve company profiles and updates.

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

CData Cloud

CompanyFollowerStatistics

Query statistics about followers for a particular company page.

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.

For example, the following queries are processed server side:

SELECT * FROM CompanyFollowerStatistics WHERE CompanyId = '183432'
SELECT * FROM CompanyFollowerStatistics WHERE ReportTimeRangeStart = '2019-10-20' AND ReportTimeRangeEnd = '2020-10-15'
SELECT * FROM CompanyFollowerStatistics WHERE ReportTimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY'
SELECT * FROM CompanyFollowerStatistics 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 References 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.

CData Cloud

CompanyList

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

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.
  • Role supports only the '=' and IN operators.
  • State supports only the '=' and IN operators.

The following query returns a list of all companies that the corresponding member is an administrator of:

SELECT * FROM CompanyList

The following queries are processed server side:

SELECT * FROM CompanyList Role = 'ANALYST';
SELECT * FROM CompanyList WHERE State IN ('APPROVED', 'REQUESTED');
SELECT * FROM CompanyList WHERE State = 'APPROVED' AND Role = 'ADMINISTRATOR';

Columns

Name Type References Description
Id 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. Possible values are: ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, RECRUITING_POSTER, LEAD_CAPTURE_ADMINISTRATOR, LEAD_GEN_FORMS_MANAGER, ANALYST, CURATOR, CONTENT_ADMINISTRATOR.
State String State of the role assigned to the person. Possible values are: APPROVED, REJECTED, REQUESTED, REVOKED.

CData Cloud

CompanyPageStatistics

Query statistics about page views for a particular company page.

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

CData Cloud

CompanyUpdateStatistics

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

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.
  • TimeRangeStart supports only the '=' operator.
  • TimeRangeEnd supports only the '=' operator.
  • UGCPostId supports the '=,IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM CompanyUpdateStatistics WHERE TimeRangeStart = '2019-10-20' AND TimeRangeEnd = '2020-10-15'
SELECT * FROM CompanyUpdateStatistics WHERE TimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY'
SELECT * FROM CompanyUpdateStatistics WHERE TimeGranularity = 'MONTH' AND TimeRangeStart = '2019-10-15' AND TimeRangeEnd = '2020-10-15' AND CompanyId = '10904095'
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 References 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

CompanyList.Id

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.

CData Cloud

Documents

Read the metadata of the document assets created in the organizations you administer.

Table Specific Information

Select

The URN column is required and must be specified in the criteria to query data from this table.

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Documents WHERE URN = 'urn:li:document:D4D10AQGFjOtqZWBMww';
SELECT * FROM Documents WHERE URN IN ('urn:li:document:D4D10AQGFjOtqZWBMww', 'urn:li:document:D4D10AQFVYoDpcZs86Q')

The rest of the query is processed client-side.

Columns

Name Type References Description
URN [KEY] String The URN of the document.
OwnerURN String The URN of the entity who owns the document.
DownloadURL String The URL for downloading the document.
DownloadURLExpiresAt Datetime The time when the URL for downloading the document expires.
Status String The status of the document.

The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

CData Cloud

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

CData Cloud

Images

Read the metadata of the image assets created in the organizations you administer.

Table Specific Information

Select

The URN column is required and must be specified in the criteria to query data from this table.

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Images WHERE URN = 'urn:li:image:D4D10AQHqn3iVssgwvA';
SELECT * FROM Images WHERE URN IN ('urn:li:image:D4D10AQHqn3iVssgwvA', 'urn:li:image:D4D10AQGGB-vB21hq4g')

The rest of the query is processed client-side.

Columns

Name Type References Description
URN [KEY] String The URN of the image.
OwnerURN String The URN of the entity who owns the image.
DownloadURL String The URL for downloading the image.
DownloadURLExpiresAt Datetime The time when the URL for downloading the image expires.
Status String The status of the image.

The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

CData Cloud

Industries

Query the list of available industries in LinkedIn.

Columns

Name Type References 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

Industries.Id

The identifier of the parent industry of this industry.

CData Cloud

OrganizationAuthorizationActions

Read data on the authorization action assignments for the organizations in which you are a member.

Table-specific Information

Select

The AuthorizationAction column must be specified in the criteria to read data from this view. The = and IN operators are fully supported server-side for this column. Refer to the query examples below:
SELECT * FROM OrganizationAuthorizationActions WHERE AuthorizationAction = 'organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)'
SELECT * FROM OrganizationAuthorizationActions WHERE AuthorizationAction IN ('organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)', 'organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_WRITE)')

The values to use for the AuthorizationAction column must be in exactly the following format:

{ACTION}:(actionType:{TYPE})
Additionally, the casing used for these values matters. The {ACTION} part must be in camel case (for example: 'organizationRoleAuthorizationAction') and the {TYPE} part must be in all-caps snake case (for example: 'ADMINISTRATOR_READ'). Refer to LinkedIn's API documentation for the values to use for the {ACTION} and {TYPE} placeholders.

The = operator is fully supported server-side for the OrganizationURN and MemberURN columns (composite key). The IN operator is partially supported server-side. Refer to the query examples below:

SELECT * FROM OrganizationAuthorizationActions WHERE (OrganizationURN, MemberURN) = ('urn:li:organization:4975021', 'urn:li:person:XXXXXXXXXX') AND AuthorizationAction = 'organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)'
SELECT * FROM OrganizationAuthorizationActions WHERE (OrganizationURN, MemberURN) IN (('urn:li:organization:4975021', 'urn:li:person:XXXXXXXXXX'), ('urn:li:organization:6554901', 'urn:li:person:YYYYYYYYYY')) AND AuthorizationAction IN ('organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)', 'organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_WRITE)')

When the OrganizationURN and MemberURN columns are not specified in the criteria as in the example below:

SELECT * FROM OrganizationAuthorizationActions WHERE AuthorizationAction = 'organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)'
we internally transform the query to the following before executing:
SELECT * FROM OrganizationAuthorizationActions WHERE (OrganizationURN, MemberURN) IN (SELECT Id, RoleAssignee FROM CompanyList WHERE State='APPROVED' AND Role='ADMINISTRATOR') AND AuthorizationAction = 'organizationRoleAuthorizationAction:(actionType:ADMINISTRATOR_READ)'

Columns

Name Type References Description
OrganizationURN [KEY] String Unique identifier of the organization.
MemberURN [KEY] String Unique profile identifier of the member assigned the authorization action.
AuthorizationAction [KEY] String Authorization action assigned to the member for organization management.
Status String Status of the authorization action assignment.

CData Cloud

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 References Description
FirstDegreeSize Integer The number of first-degree connections (followers) for the organization.

CData Cloud

OrganizationLocations

Retrieve location information for any LinkedIn organization, regardless of whether you manage that organization.

Select

To use this view, you must specify either the OrganizationId or OrganizationVanityName columns. If you specify both columns with an AND clause, the OrganizationId criterion takes precedence over OrganizationVanityName. You cannot use the OR logical operator with criteria involving columns other than OrganizationId or OrganizationVanityName.

Refer to the query examples below:

SELECT * FROM OrganizationLocations WHERE OrganizationId = '4975021';
SELECT * FROM OrganizationLocations WHERE OrganizationId IN ('4975021', '6554901');
SELECT * FROM OrganizationLocations WHERE OrganizationVanityName IN ('CDataSoftware', 'OtherOrganization');

Columns

Name Type References Description
OrganizationId String

Organizations.Id

The identifier of the organization.
OrganizationVanityName String The vanity name of the organization.
GeoLocationURN [KEY] String The geolocation URN of the organization's location.
LocationType String The type of the organization's location.
Description String The description of the organization's location.
StaffCountRange String The range of staff members of the organization's location.
AddressLine1 String The first line of the address of the organization's location.
AddressLine2 String The second line of the address of the organization's location.
City String The city of the organization's location.
AdministrativeUnit String This refers to the administrative unit (e.g. state, country, province) of the organization's location.
PostalCode String The postal code of the organization's location.
Country String The country of the organization's location.

CData Cloud

Organizations

Query information about any LinkedIn organization, regardless of whether the individual is an administrator for that organization.

Select

This view differs from CompanyDetails, because it only exposes Non-Admin Organization data. You can use it whether or not you own the organization. If you are an Organization Administrator and need access to full data beyond the Non-Admin set, use CompanyDetails instead.

You must specify either the Id or VanityName column in the criteria to use this view. If you specify both columns with an AND clause, the Id criterion takes precedence over VanityName. Additionally, you cannot use the OR logical operator with criteria that involve columns other than Id or VanityName.

The = and IN operators are fully supported server-side for the Id column. Refer to the query examples below:

SELECT * FROM Organizations WHERE Id = '4975021';
SELECT * FROM Organizations WHERE Id IN ('4975021', '6554901');

The = operator is fully supported server-side for the VanityName column, while the IN operator is processed client-side. The values specified in the criteria are case-insensitive. Refer to the query examples below:

SELECT * FROM Organizations WHERE VanityName = 'cdatasoftware';
SELECT * FROM Organizations WHERE VanityName IN ('CDataSoftware', 'OtherOrganization');

Columns

Name Type References Description
Id [KEY] String The identifier of the organization.
Name String The name of the organization.
VanityName String The vanity name of the organization.
Website String The organization's website.
PrimaryType String The primary type of the organization.
LogoAssetURN String The digital media asset URN for the organization's logo.
HierarchyClassification String The classification for the school's hierarchy in case the organization is a school.
SchoolType String The type of school in case the organization is a school.
YearLevel String The classification of the length of the school's educational programs in case the organization is a school.

CData Cloud

Profiles

Retrieves LinkedIn member profile information.

Select

When querying Profiles with a criteria, Id is required and must be included in the criteria. The OR logical operator is not supported in the criteria for columns other than Id.

The = and IN operators are fully supported server-side for the Id column. Refer to the query examples below:

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

If no criteria is specified, as shown in the query below, the view returns the authenticated user's LinkedIn profile data.

SELECT * FROM Profiles;

Columns

Name Type References 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.
URN String URN of the member's profile.

CData Cloud

Videos

Read the metadata of the video assets created in the organizations you administer.

Table Specific Information

Select

The URN column is required and must be specified in the criteria to query data from this table.

For the URN column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. Refer to the query examples below:

SELECT * FROM Videos WHERE URN = 'urn:li:video:D4D10AQGLvWblHowYUw';
SELECT * FROM Videos WHERE URN IN ('urn:li:video:D4D10AQGLvWblHowYUw', 'urn:li:video:D4D10AQFLAKXbRnqwLQ')

The rest of the query is processed client-side.

Columns

Name Type References Description
URN [KEY] String The URN of the video.
OwnerURN String The URN of the entity who owns the video.
DownloadURL String The URL for downloading the video.
DownloadURLExpiresAt Datetime The time when the URL for downloading the video expires.
Status String The status of the video.

The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

AspectRatioHeight Decimal The aspect ratio height of the video.
AspectRatioWidth Decimal The aspect ratio width of the video.
Duration Long The duration of the video.
ThumbnailDownloadURL String The URL for downloading the video's thumbnail.
CaptionsDownloadURL String The URL for downloading the video's captions.

CData Cloud

VideoTimeWatchedForVideoViewsStatistics

Query statistics about the time watched in milliseconds for video.

Columns

Name Type References Description
UGCPostId String Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
TimeWatchedForVideoViews Long The time watched in milliseconds for video play-pause cycles that are at least 3 seconds.
TimeGranularity String Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime Inclusive ending timestamp of when the query should end. Queries until current time when not set.
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.

CData Cloud

VideoTimeWatchedStatistics

Query statistics about the time the video was watched in milliseconds.

Columns

Name Type References Description
UGCPostId String Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
TimeWatched Long The time the video was watched in milliseconds.
TimeGranularity String Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime Inclusive ending timestamp of when the query should end. Queries until current time when not set.
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.

CData Cloud

VideoViewerStatistics

Query statistics about unique viewers who made engaged plays on the video.

Columns

Name Type References Description
UGCPostId String Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
Viewers Long Unique viewers who made engaged plays on the video.
TimeGranularity String Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime Inclusive ending timestamp of when the query should end. Queries until current time when not set.
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.

CData Cloud

VideoViewStatistics

Query statistics about video views for a particular company page.

Columns

Name Type References Description
UGCPostId String Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
Views Long Video views of the statistic.
TimeGranularity String Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime Inclusive ending timestamp of when the query should end. Queries until current time when not set.
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.

CData Cloud

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE 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
CreateEvent Create a new event in a LinkedIn organization. Events can be used to promote gatherings, webinars, conferences, or other activities to your LinkedIn audience. Once created, the event can be shared as posts and tracked through analytics.

CData Cloud

CreateEvent

Create a new event in a LinkedIn organization. Events can be used to promote gatherings, webinars, conferences, or other activities to your LinkedIn audience. Once created, the event can be shared as posts and tracked through analytics.

Input

Name Type Required Description
Name String True The display name of the event. This is the primary title that will be shown to LinkedIn users when they view the event.
OrganizerURN String True The URN of the organization or person organizing this event. This must be an entity you have administrative access to. For organization events, use format 'urn:li:organization:{id}'. For personal events, use 'urn:li:person:{id}'.
Type String True The type of event being created. Use 'IN_PERSON' for physical events at a venue, or 'ONLINE_EXTERNAL' for virtual events hosted on external platforms (e.g., Zoom, Teams, webinar software).

The allowed values are IN_PERSON, ONLINE_EXTERNAL.

Description String False A detailed description of the event. This can include the event agenda, what attendees will learn, speaker information, or any other relevant details to help users understand the event's purpose and value.
StartsAt Datetime True The date and time when the event begins.
EndsAt Datetime False The date and time when the event ends. Must be after the StartsAt time. If not provided, the event will not have a defined end time. Format as ISO 8601 datetime (e.g., '2024-12-25T16:00:00Z').
URL String False The URL where the online event will be hosted or where users can find more information. Required for ONLINE_EXTERNAL events. For in-person events, this can be used to provide a registration or informational website.
LeadGenFormPrivacyPolicyUrl String False The URL to your organization's privacy policy. This is displayed to users when they register for the event through a lead generation form, ensuring compliance with data protection regulations.
BackgroundImageURN String False The URN of the image asset to use as the event's background image. Upload an image first using the UploadImage stored procedure with IsEventBackground=true to obtain a valid URN.
VenueDetails String False Additional information about the event venue. For in-person events, this can include venue name, room number, parking instructions, or other location-specific details that complement the address information.
AddressLine1 String False The first line of the street address for in-person events. This typically includes the building number and street name (e.g., '123 Main Street').
AddressLine2 String False The second line of the street address for in-person events. This can include suite numbers, apartment numbers, building names, or other secondary address information (e.g., 'Suite 400').
AddressCity String False The city where the in-person event will take place (e.g., 'San Francisco', 'New York').
AddressCountry String False The country where the in-person event will take place. Use the two-letter ISO 3166-1 alpha-2 country code (e.g., 'US' for United States, 'GB' for United Kingdom, 'DE' for Germany).
AddressGeographicArea String False The geographic region where the in-person event will take place (e.g., 'CA', 'NY').
AddressPostalCode String False The postal code or ZIP code for the event venue's address.

Result Set Columns

Name Type Description
Id String The unique identifier of the newly created event. This ID can be used to reference the event in subsequent operations, such as updating event details or sharing the event in posts.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

CData Cloud

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.

CData Cloud

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

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.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric 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.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided Boolean Whether the procedure is added/implemented by CData, as opposed to being a native LinkedIn procedure.

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

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.

CData Cloud

sys_connection_props

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

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.

CData Cloud

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.

NameDescriptionPossible Values
AGGREGATE_FUNCTIONSSupported aggregation functions.AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTWhether COUNT function is supported.YES, NO
IDENTIFIER_QUOTE_OPEN_CHARThe opening character used to escape an identifier.[
IDENTIFIER_QUOTE_CLOSE_CHARThe closing character used to escape an identifier.]
SUPPORTED_OPERATORSA list of supported SQL operators.=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYWhether GROUP BY is supported, and, if so, the degree of support.NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESThe supported varieties of outer joins supported.NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINSWhether outer joins are supported.YES, NO
SUBQUERIESWhether subqueries are supported, and, if so, the degree of support.NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSSupported 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_FUNCTIONSSupported 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_FUNCTIONSSupported 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_TABLESIndicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNSA 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_PATTERNString value indicating what string is valid for an identifier.
SUPPORT_TRANSACTIONIndicates if the provider supports transactions such as commit and rollback.YES, NO
DIALECTIndicates the SQL dialect to use.
KEY_PROPERTIESIndicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMASIndicates if multiple schemas may exist for the provider.YES, NO
SUPPORTS_MULTIPLE_CATALOGSIndicates if multiple catalogs may exist for the provider.YES, NO
DATASYNCVERSIONThe CData Data Sync version needed to access this driver.Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYThe CData Data Sync category of this driver.Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLWhether enhanced SQL functionality beyond what is offered by the API is supported.TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSWhether batch operations are supported.YES, NO
SQL_CAPAll 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_OPTIONSA string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERYIndicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.YES, NO
PSEUDO_COLUMNSA string array indicating the available pseudo columns.
MERGE_ALWAYSIf the value is true, The Merge Mode is forcibly executed in Data Sync.TRUE, FALSE
REPLICATION_MIN_DATE_QUERYA select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTIONAllows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATEAllows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERYA select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTIONAllows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATEA list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTIDIndicates whether the CheckCache statement should be done against the parent key column.TRUE, FALSE
CREATE_SCHEMA_PROCEDURESIndicates 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.

CData Cloud

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.

CData Cloud

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductStringThe name of the product.
VersionStringThe version number of the product.
DatasourceStringThe name of the datasource the product connects to.
NodeIdStringThe unique identifier of the machine where the product is installed.
HelpURLStringThe URL to the product's help documentation.
LicenseStringThe license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
LocationStringThe file path location where the product's library is stored.
EnvironmentStringThe version of the environment or rumtine the product is currently running under.
DataSyncVersionStringThe tier of CData Sync required to use this connector.
DataSyncCategoryStringThe category of CData Sync functionality (e.g., Source, Destination).

CData Cloud

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


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

OAuth


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
ScopeA specific scope that the user requires the access token.

SSL


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

Logging


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from LinkedIn.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

Authentication

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


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

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.

CData Cloud

OAuth

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


PropertyDescription
OAuthClientIdSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecretSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
ScopeA specific scope that the user requires the access token.
CData Cloud

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

  • When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
  • If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

CData Cloud

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

  • This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
  • Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

CData Cloud

Scope

A specific scope that the user requires the access token.

Data Type

string

Default Value

"r_basicprofile,r_emailaddress,r_organization_social,w_organization_social,w_member_social,rw_organization_admin"

Remarks

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

CData Cloud

SSL

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


PropertyDescription
SSLServerCertSpecifies the certificate to be accepted from the server when connecting using TLS/SSL.
CData Cloud

SSLServerCert

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

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

CData Cloud

Logging

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


PropertyDescription
VerbositySpecifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
CData Cloud

Verbosity

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

CData Cloud

Schema

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


PropertyDescription
BrowsableSchemasOptional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
CData Cloud

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

CData Cloud

Miscellaneous

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


PropertyDescription
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from LinkedIn.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFoundSpecifies whether or not throws an exception if there is no rows updated.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
CData Cloud

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

CData Cloud

Pagesize

Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn.

Data Type

int

Default Value

100

Remarks

When processing a query, instead of requesting all of the queried data at once from LinkedIn, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

CData Cloud

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

CData Cloud

ThrowsKeyNotFound

Specifies whether or not throws an exception if there is no rows updated.

Data Type

bool

Default Value

false

Remarks

Specifies whether or not throws an exception if there is no rows updated.

CData Cloud

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

CData Cloud

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9539