The CData Sync App provides a straightforward way to continuously pipeline your LinkedIn data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The LinkedIn connector can be used from the CData Sync application to pull data from LinkedIn and move it to any of the supported destinations.
The Sync App mostly leverages LinkedIn's versioned APIs (currently 202510) and in some rare cases LinkedIn's unversioned APIs (/v2) for performing read and write operations.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
There are two ways to find your site's LinkedIn Company ID:
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.
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 Sync App refreshes it automatically.
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 Sync App.
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.
To see what scopes are granted by each API product, refer to LinkedIn's documentation.
| Entity | Statement Types | Minimal Required Scopes |
| Comments | SELECT | r_organization_social |
| Comments | INSERT UPDATE DELETE | w_organization_social |
| CompanyStatusUpdates | SELECT | r_organization_social |
| CompanyStatusUpdates | INSERT UPDATE DELETE | w_organization_social |
| Events | SELECT | r_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). |
| Events | UPDATE | rw_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). |
| CreateEvent | EXECUTE | rw_events |
| CompanyDetails | SELECT | r_organization_admin |
| CompanyFollowerStatistics | SELECT | r_organization_admin |
| CompanyList | SELECT | r_organization_admin |
| CompanyPageStatistics | SELECT | r_organization_admin |
| CompanyUpdateStatistics | SELECT | r_organization_admin |
| Documents | SELECT | r_organization_social |
| GeoLocation | SELECT | - |
| Images | SELECT | r_organization_social |
| Industries | SELECT | - |
| OrganizationAuthorizationActions | SELECT | rw_organization_admin |
| OrganizationFollowerCount | SELECT | - |
| OrganizationLocations | SELECT | r_organization_admin |
| Organizations | SELECT | r_organization_admin |
| Profiles | SELECT | r_basicprofile |
| Videos | SELECT | r_organization_social |
| VideoTimeWatchedForVideoViewsStatistics | SELECT | r_organization_social |
| VideoTimeWatchedStatistics | SELECT | r_organization_social |
| VideoViewerStatistics | SELECT | r_organization_social |
| VideoViewStatistics | SELECT | r_organization_social |
| DownloadAsset | EXECUTE | r_organization_social |
| UploadDocument | EXECUTE | w_organization_social |
| UploadImage | EXECUTE | w_organization_social |
| UploadVideo | EXECUTE | w_organization_social |
| UploadVideoCaptions | EXECUTE | - |
| UploadVideoThumbnail | EXECUTE | - |
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.
| Domain | Always Required | Description |
| linkedin.com | True | The main domain used for accessing the main LinkedIn API-s that the Sync App uses. |
| licdn.com | False | The domain used for downloading LinkedIn assets through its CDN such as Images or Videos (see DownloadAsset as well). |
This section details a selection of advanced features of the LinkedIn Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App 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.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App 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 Sync App uses the LinkedIn API to process supported filters. The Sync App processes other filters client-side within the Sync App.
Views are tables that cannot be modified. Typically, read-only data are shown as views.
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
The Sync App models the data in LinkedIn as a list of tables in a relational database that can be queried using standard SQL statements.
| 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. |
Query Comments data for Posts in the Organization Pages that you administer.
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 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 Comments SET Text = 'Test Comment' WHERE Id = 715517423271578940 UPDATE Comments SET Text = 'Test Comment' WHERE Id = 715517423271578940 AND UpdateId = 'urn:li:share:7155174232715386880'
DELETE FROM Comments WHERE Id = 715517423271578940 DELETE FROM Comments WHERE Id = 715517423271578940 AND UpdateId = 'urn:li:share:7155174232715386880'
| 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. |
Read and write posts in your organizations.
SELECT * FROM CompanyStatusUpdates WHERE CompanyId = '183432'
Refer to the query examples below:
INSERT INTO CompanyStatusUpdates(Comment, CreatedBy, Visibility, LifecycleState, IsReshareDisabled) VALUES('Test Post', 'urn:li:organization:101409996', 'PUBLIC', 'DRAFT', true);
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 FROM CompanyStatusUpdates WHERE Id = 'urn:li:share:7383870244806791168'
| 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 |
URN of the parent post if the post is a re-share. | |
| RootPostURN | String | True |
URN of the root post in the re-share chain if the post is a re-share. |
Read and update events in your organizations.
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 Sync App 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 Events SET VanityName = 'mytestevent7382067115601719297456' WHERE Id = '7382067115601719297456'
| 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 |
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. |
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.
| 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. |
Retrieve company profiles and updates.
SELECT * FROM CompanyDetails WHERE CompanyId = '183432'
| 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. |
Query statistics about followers for a particular company page.
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'
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. |
| 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. |
Lists all companies and the privileges that the user has within the organization.
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';
| 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. |
Query statistics about page views for a particular company page.
The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.
SELECT * FROM [CompanyPageStatistics]
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'
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. |
| 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. |
Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.
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')
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. |
| 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. |
Read the metadata of the document assets created in the organizations you administer.
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.
| 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. |
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>)
| 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 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. |
Read the metadata of the image assets created in the organizations you administer.
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.
| 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. |
Query the list of available industries in LinkedIn.
| 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. |
Read data on the authorization action assignments for the organizations in which you are a member.
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)'
| 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. |
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.
| Name | Type | References | Description |
| FirstDegreeSize | Integer | The number of first-degree connections (followers) for the organization. |
Retrieve location information for any LinkedIn organization, regardless of whether you manage that organization.
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');
| Name | Type | References | Description |
| OrganizationId | String | 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. |
Query information about any LinkedIn organization, regardless of whether the individual is an administrator for that organization.
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');
| 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. |
Retrieves LinkedIn member profile information.
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;
| 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. |
Read the metadata of the video assets created in the organizations you administer.
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.
| 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. |
Query statistics about the time watched in milliseconds for video.
| 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. |
Query statistics about the time the video was watched in milliseconds.
| 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. |
Query statistics about unique viewers who made engaged plays on the video.
| 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. |
Query statistics about video views for a particular company page.
| 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. |
Stored procedures are function-like interfaces that extend the functionality of the Sync App 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.
| 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. |
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.
| 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. |
| 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. |
Download document, image, and video assets from your LinkedIn organization.
| Name | Type | Required | Description |
| URN | String | True | The URN of the asset that you want to download. Must be one from the following types: 'urn:li:document:', 'urn:li:image:', 'urn:li:video:'. |
| LocalFile | String | False | The absolute path of the file in your system to use for downloading the asset. |
| Overwrite | Boolean | False | A boolean value indicating whether to overwrite the file in the path provided in the 'LocalFile' parameter if it already exists.
The default value is false. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the asset was downloaded successfully or not. |
| FileData | String | A Base64-encoded string containing the data of the asset downloaded. This will be returned only if both the 'LocalFile' parameter and the 'FileStream' parameter are not specified. |
Gets the OAuth access token from LinkedIn.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. The allowed values are APP, WEB. |
| Verifier | String | False | The verifier token returned by LinkedIn after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
| Scope | String | False | The scope or permissions you are requesting. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the LinkedIn authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| OAuthAccessToken | String | The OAuth token. |
| ExpiresIn | String | The remaining lifetime for the access token in seconds. |
| OAuthRefreshToken | String | The OAuth refresh token. |
Gets the LinkedIn authorization URL. Access the URL returned in the output in a Web browser. This requests the access token that can be used as part of the connection string to LinkedIn.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL that LinkedIn will return to after the user has authorized your app. |
| Scope | String | False | The scope or permissions you are requesting. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the LinkedIn authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
| Name | Type | Description |
| URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the data provider with. |
Refreshes the OAuth access token used for authentication with LinkedIn.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | The refresh token returned from the original authorization code exchange. |
| Name | Type | Description |
| OAuthAccessToken | String | The authentication token returned from LinkedIn. This can be used in subsequent calls to other operations for this particular service. |
| OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
| ExpiresIn | String | The remaining lifetime on the access token. |
Upload document assets in your LinkedIn organization which can be used to create posts.
If no parameter is used, or more than one parameter is used, the procedure fails.
Below are some other restrictions for document assets:
| Name | Type | Required | Description |
| OwnerURN | String | True | The URN of the organization to use as the new document's owner. |
| LocalFile | String | False | The absolute path of the document in your system to upload to LinkedIn. |
| FileData | String | False | A Base64-encoded string containing the data of the document to upload to LinkedIn. Useful in cases when neither the 'LocalFile' parameter nor the 'FileStream' parameter are viable options. |
| Name | Type | Description |
| DocumentURN | String | The URN of the new document asset that was created, if the upload was successful. |
Upload image assets in your LinkedIn organization which can be used to create posts or events.
If no parameter is used, or more than one parameter is used, the procedure will fail.
Below are some other restrictions for image assets:
| Name | Type | Required | Description |
| OwnerURN | String | True | The URN of the entity that will own the uploaded image asset. For event background images (when IsEventBackground=true), you must use a person URN (format: 'urn:li:person:{id}') representing your LinkedIn member account. |
| IsEventBackground | Boolean | False | Set this to true if the uploaded image will be used as an event background image. When true, the image is registered with specific dimensions and requirements for event headers. The resulting ImageURN can then be passed to the BackgroundImageURN parameter in the CreateEvent stored procedure. Event background images must be owned by a person URN, not an organization URN.
The default value is false. |
| LocalFile | String | False | The absolute path of the image file in your system to upload to LinkedIn. |
| FileData | String | False | A Base64-encoded string containing the data of the image to upload to LinkedIn. Useful in cases when neither the 'LocalFile' parameter nor the 'FileStream' parameter are viable options. |
| Name | Type | Description |
| ImageURN | String | The URN of the new image asset that was created, if the upload was successful. |
Upload video assets in your LinkedIn organization which can be used to create posts.
If no parameter is used, or more than one parameter is used, the procedure will fail.
If the video has a thumbnail, you can use the value returned in the ThumbnailUploadURL output parameter to upload the video's thumbnail through the UploadVideoThumbnail stored procedure.
If the video has captions, you can use the value returned in the CaptionsUploadURL output parameter to upload the video's captions through the UploadVideoCaptions stored procedure.
For a video asset to be usable (can be used to create posts), you must:
Below are some other restrictions for video assets:
| Name | Type | Required | Description |
| OwnerURN | String | True | The URN of the organization to use as the new video's owner. |
| LocalFile | String | False | The absolute path of the video file in your system to upload to LinkedIn. |
| FileStreamSize | Long | False | The size in bytes of the 'InputStream' object provided in the 'FileStream' parameter. This input is required if the 'FileStream' parameter was used. |
| FileData | String | False | A Base64-encoded string containing the data of the video to upload to LinkedIn. Useful in cases when neither the 'LocalFile' parameter nor the 'FileStream' parameter are viable options. |
| HasCaptions | Boolean | False | Boolean value indicating whether the new video will contain captions or not. If yes (true), the URL for uploading the captions will be returned in the results of the procedure.
The default value is false. |
| HasThumbnail | Boolean | False | Boolean value indicating whether the new video will contain a thumbnail or not. If yes (true), the URL for uploading the thumbnail will be returned in the results of the procedure.
The default value is false. |
| Name | Type | Description |
| VideoURN | String | The URN of the new video asset that was created, if the upload was successful. |
| CaptionsUploadURL | String | The URL to use for uploading the video's captions. |
| ThumbnailUploadURL | String | The URL to use for uploading the video's thumbnail. |
Upload the captions of your video assets. Ony the '.srt' format is supported.
If no parameter is used, or more than one parameter is used, the procedure will fail.
| Name | Type | Required | Description |
| UploadURL | String | True | The URL to use for uploading the video's captions. |
| LocalFile | String | False | The absolute path of the subtitle file in your system to upload for the video's captions. |
| FileData | String | False | A Base64-encoded string containing the subtitle data to upload for the video's captions. Useful in cases when neither the 'LocalFile' parameter nor the 'FileStream' parameter are viable options. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the captions were uploaded successfully or not. |
Upload the thumbnails of your video assets.
If no parameter is used, or more than one parameter is used, the procedure will fail.
| Name | Type | Required | Description |
| UploadURL | String | True | The URL to use for uploading the video's thumbnail. |
| LocalFile | String | False | The absolute path of the image file in your system to upload for the video's thumbnail. |
| FileData | String | False | A Base64-encoded string containing the image data to upload for the video's thumbnail. Useful in cases when neither the 'LocalFile' parameter nor the 'FileStream' parameter are viable options. |
| Name | Type | Description |
| Success | Boolean | A boolean value indicating whether the thumbnail was uploaded successfully or not. |
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.
| Property | Description |
| CompanyId | The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}. |
| Property | Description |
| 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. |
| 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.). |
| Scope | A specific scope that the user requires the access token. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| CompanyId | The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}. |
The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.
This property must be set in the connection string or query. Otherwise, the Sync App will use the first found company Id.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| 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. |
| 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.). |
| Scope | A specific scope that the user requires the access token. |
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.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App 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.
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.).
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:
For more information on how this property is used when configuring a connection, see Establishing a Connection
A specific scope that the user requires the access token.
This property must be set in the connection string to get a scoped token with specific privileges.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
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.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to LinkedIn. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to LinkedIn. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to LinkedIn. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\LinkedIn Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
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.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn.
When processing a query, instead of requesting all of the queried data at once from LinkedIn, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App 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:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM CompanyStatusUpdates WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
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.