Adding a Connection to LinkedIn Marketing Solutions

To add a connection to LinkedIn Marketing Solutions:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the LinkedIn Marketing Solutions icon is not available, click the Add More icon to download and install the LinkedIn Marketing Solutions connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Authenticating to LinkedIn Marketing Solutions (OAuth)

LinkedIn Marketing Solutions supports OAuth authentication only.

Required Scopes and Endpoint Domains for LinkedIn Marketing Solutions

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

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

This topic provides information about the required access scopes and endpoint domains for the LinkedIn Marketing Solutions Sync App.

Understanding Scopes

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

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

Required Scopes for LinkedIn Marketing Solutions

Scope	Description
r_ads	Read-only access to ad accounts. Required for the following views: Accounts AudienceCount BudgetPricing CampaignGroups CampaignRecommendations Campaigns Conversions Creatives Forms JobFunctions ThirdPartyTracking
rw_ads	Read and write access to ad accounts. Required for the following views: Accounts AudienceCount BudgetPricing CampaignGroups CampaignRecommendations Campaigns Conversions Creatives Forms JobFunctions ThirdPartyTracking
r_ads_reporting	Read access to ad reporting and analytics data. Required for the following view: Analytics
r_marketing_leadgen_automation	Access to lead generation forms and marketing automation data. Required for the following view: AdFormResponses
w_organization_social	Write access to organizational social media content. Required for the following views: Posts SocialActions
r_organization_social	Read-only access to organizational social media content. Required for the following views: Posts SocialActions
w_member_social	Write access to member social media content. Required for the following views: Posts SocialActions
r_member_social	Provides read access to member social media content. Required for the following views: Posts SocialActions
r_compliance	Required to retrieve activities for compliance monitoring and archiving. Required for the following views: Industries SocialActions
w_compliance	Manage and delete data on behalf of an authenticated member for compliance requirements. This is a private permission and access is granted to select developers. Required for the following views: Industries SocialActions

Understanding Endpoint Domains

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

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

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

Required Endpoint Domains for LinkedIn Marketing Solutions

Domain	Always Required	Description
accounts.linkedin.com	TRUE	The subdomain used for OAuth.
api.linkedin.com	TRUE	The subdomain used for accessing various services.

This section details a selection of advanced features of the LinkedIn Marketing Solutions Sync App.

User Defined Views

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 .

SSL Configuration

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

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to LinkedIn Marketing Solutions and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

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

Tables

The CData Sync App models the data in Views so that it can be easily queried and updated.

Views

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

Stored Procedures

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

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

LinkedIn Marketing Solutions Connector for CData Sync Views

Name	Description
Accounts	The Account status finder returns all accounts in a specified status that the authenticated user has access to.
AdFormResponses	Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form.
Analytics	The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.
AudienceCount	The Audience Count API allows advertisers to forecast the reach of targeting criteria.
BudgetPricing	The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.
CampaignGroups	The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
CampaignInsights	The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.
Campaigns	The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
Conversions	Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.
Creatives	The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.
Degrees	Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
FieldsOfStudy	Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Forms	Query form data for the forms that belong to a specified owner (account).
GeoLocations	Provides the display name for a given geo Id, or a set of geo Ids.
Industries	Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
JobFunctions	Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Posts	Retrieve all posts for an organization.
Seniorities	Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
Skills	Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
SocialActions	The socialActions API allows access to both personal and organization social actions.
ThirdPartyTracking	Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.
Titles	Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

The Account status finder returns all accounts in a specified status that the authenticated user has access to.

Table Specific Information

Select

The Accounts view returns a list of the accounts that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Accounts WHERE Status = 'ACTIVE'

Columns

Name	Type	Description
Id	String	Id of the account
Name	String	A label for the account
Currency	String	The account's ISO-4217currency code.
Type	String	The type of account.
NotifiedOnCreativeRejection	Boolean	Indicates if creative contact is notified when a creative has been rejected due to content.
NotifiedOnEndOfCampaign	Boolean	Indicates if campaign contact is notified when an associated campaign has been completed.
Status	String	Status of the account
NotifiedOnCampaignOptimization	Boolean	Indicates if campaign contact is notified about campaign optimization opportunities.
Version	String	Version of the account
Reference	String	The entity on whose behalf the account advertises.
NotifiedOnCreativeApproval	Boolean	Indicates if creative contact is notified when a creative has been reviewed and approved.
AuditStampsCreator	String	The person who created audit stamps for the first time
AuditStampsCreatedAt	Datetime	The datetime in which the audit stamp was created first
AuditStampsLastModifier	String	Last modifier of the Audit stamps
AuditStampsLastModifiedAt	Datetime	Last modified datetime of the audit stamps

Query the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form.

Table Specific Information

The Account and LeadType columns must be specified in the criteria to use this view.

Select

For the Account 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 AdFormResponses WHERE Account = '512859024';
SELECT * FROM AdFormResponses WHERE Account IN ('512859024', '513009855');

To satisfy the requirement mentioned in the beginning, we internally post-process the queries above to the following before executing:

SELECT * FROM AdFormResponses WHERE Account = '512859024' AND LeadType = 'STANDARD';
SELECT * FROM AdFormResponses WHERE Account IN ('512859024', '513009855') AND LeadType = 'STANDARD';

For the LeadType 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 AdFormResponses WHERE LeadType = 'STANDARD';
SELECT * FROM AdFormResponses WHERE LeadType IN ('STANDARD', 'COMPANY');

To satisfy the requirement mentioned in the beginning, we internally post-process the queries above to the following before executing:

SELECT * FROM AdFormResponses WHERE LeadType = 'STANDARD' AND Account IN (SELECT Id FROM Accounts);
SELECT * FROM AdFormResponses WHERE LeadType IN ('STANDARD', 'COMPANY') AND Account IN (SELECT Id FROM Accounts);

When no criteria is specified as shown below:

SELECT * FROM AdFormResponses;

, we internally post-process the query to the following before executing:

SELECT * FROM AdFormResponses WHERE Account IN (SELECT Id FROM Accounts) AND LeadType = 'STANDARD';

The rest of the query is processed client-side.

Columns

Name	Type	Description
Id [KEY]	String	Identifier for the form response.
Account	String	Identifier for the owner of the form. This is the advertiser account.
Campaign	String	URN identifying the campaign to which the form response is responding.
Creative	String	URN identifying the creative to which the form response is responding.
Form	String	URN identifying which form this response responds to.
SubmitedAt	Datetime	Timestamp for when the form response was submitted.
LeadType	String	Type of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED.
TestLead	Boolean	Whether the lead is a test lead.
ConsentResponses	String	A JSON object containing all the consent responses.
Answers	String	A JSON object containing all the answers and the respective questions.

The Analytics API provides account, campaign, and creative level insights on click intelligence numbers.

Table Specific Information

Select

The Analytics view provides account, campaign, and creative level insights on click intelligence numbers. Examples of these insights include clicks, shares, and impressions.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT ReportStartTime, ReportEndTime, Clicks, Impressions, Follows, TotalEngagements FROM Analytics WHERE ReportStartTime = '07/20/2016' AND Account = '123456789' AND Granularity = 'MONTHLY'

Select Rules

Analytic reports:

Dimensions	Required	FinderMethod, ReportStartTime, Granularity
	Optional	ReportEndTime, CampaignType
If FinderMethod is Analytics	Use 0 or 1 (Default is Campaign)	Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex, MemberCompanySize, MemberIndustry, MemberSeniority, MemberJobTitle, MemberJobFunction, MemberCountry, MemberRegion, MemberCompany
If FinderMethod is Statistics	Use 1 or 2 (Default is Campaign)	Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex Note: The default value for FinderMethod will be Analytics. The default value for Granularity will be MONTHLY. The default time window will be the last year period.
Metrics	Use 1 or more	ActionClicks, AdUnitClicks, CardClicks, CardImpressions, Clicks, CommentLikes, Comments, CompanyPageClicks, ConversionValueInLocalCurrency, CostInLocalCurrency, CostInUsd, StartPeriod, EndPeriod, ExternalWebsiteConversions, ExternalWebsitePostClickConversions, ExternalWebsitePostViewConversions, Follows, FullScreenPlays, Impressions, LandingPageClicks, LeadGenerationMailContactInfoShares, LeadGenerationMailInterestedClicks, Likes, OneClickLeadFormOpens, OneClickLeads, Opens, OtherEngagements, Pivot, PivotValue, Shares, TextUrlClicks, TotalEngagements, VideoCompletions, VideoFirstQuartileCompletions, VideoMidpointCompletions, VideoStarts, VideoThirdQuartileCompletions, VideoViews, ViralCardClicks, ViralCardImpressions, ViralClicks, ViralComments, ViralCompanyPageClicks, ViralExternalWebsiteConversions, ViralExternalWebsitePostClickConversions, ViralExternalWebsitePostViewConversions, ViralFollows, ViralFullScreenPlays, ViralImpressions, ViralLandingPageClicks, ViralLikes, ViralOneClickLeadFormOpens, ViralOneClickLeads, ViralOtherEngagements, ViralShares, ViralTotalEngagements, ViralVideoCompletions, ViralVideoFirstQuartileCompletions, ViralVideoMidpointCompletions, ViralVideoStarts, ViralVideoThirdQuartileCompletions, ViralVideoViews, AverageDailyReachMetricsApproximateReach, AverageDailyReachMetricsApproximateFrequency, AverageDailyReachMetricsApproximateCost, AveragePreviousSevenDayReachMetricsApproximateReach, AveragePreviousSevenDayReachMetricsApproximateFrequency, AveragePreviousSevenDayReachMetricsApproximateCost, AveragePreviousThirtyDayReachMetricsApproximateReach, AveragePreviousThirtyDayReachMetricsApproximateFrequency, AveragePreviousThirtyDayReachMetricsApproximateCost, ApproximateMemberReach, ValidWorkEmailLeads, PostClickRegistrations, PostViewRegistrations, DownloadClicks, QualifiedLeads, CostPerQualifiedLead, MessagingAdvertSendCount, MessagingAdvertOpenCount
Filter	Use 1 or more	Account, Campaign, Creative Note: If there are no filters specified the default filter will be all the accounts that belong to the user.

Columns

Name	Type	Description
Company	String	Pivot value which groups the result by advertiser's company.
Account	String	Pivot value which groups the result by account.
Share	String	Pivot value which groups the result by sponsored share.
Campaign	String	Pivot value which groups the result by campaign.
Creative	String	Pivot value which groups the result by creative.
CampaignGroup	String	Pivot value which groups the result by campaign group.
Conversion	String	Pivot value which groups the result by conversion.
ServingLocation	String	Pivot value which groups the result by serving location.
CardIndex	String	Pivot value which groups the result by card index.
MemberCompanySize	String	Pivot value which groups the result by member company size.
MemberIndustry	String	Pivot value which groups the result by member industry.
MemberSeniority	String	Pivot value which groups the result by member seniority.
MemberJobTitle	String	Pivot value which groups the result by member job title.
MemberJobFunction	String	Pivot value which groups the result by member job function.
MemberCountry	String	Pivot value which groups the result by member country.
MemberRegion	String	Pivot value which groups the result by member region.
MemberCounty	String	Pivot value which groups the result by member county.
MemberCompany	String	Pivot value which groups the result by member company.
PlacementName	String	Pivot value which groups the result by member company.
ImpressionDeviceType	String	Pivot value which groups the result by member company.
CampaignType	String	Match result by campaign type.
Granularity	String	Time granularity of results. The default value is MONTHLY.
FinderMethod	String	Designates the query finder. The only allowed values are analytics or statistics. The default value is analytics.
ReportStartTime	String	The start time of the period.
ReportEndTime	String	The end time of the period.
EventStage	String	Organize results based on the stage of the live event.
ActionClicks	Long	The count of clicks on the action button of the Sponsored InMail.
AdUnitClicks	Long	The count of clicks on the ad unit displayed alongside the Sponsored InMail.
CardClicks	Long	The number of clicks for each card of a carousel ad.
CardImpressions	Long	The number of impressions shown for each card of a carousel ad.
Clicks	Long	The count of chargeable clicks.
CommentLikes	Long	The count of likes of a comment.
Comments	Long	The count of comments. Sponsored
CompanyPageClicks	Long	The count of clicks to view the company page.
ConversionValueInLocalCurrency	Decimal	Value of the conversions in the account's local currency based on rules defined by the advertiser.
CostInLocalCurrency	Decimal	Cost in the account's local currency based on the pivot and timeGranularity.
CostInUsd	Decimal	Cost in USD based on the pivot and timeGranularity.
UsageStartTime	String	Date start covered by the report data point.
UsageEndTime	String	Date end covered by the report data point.
ExternalWebsiteConversions	Long	The count of conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostClickConversions	Long	The count of post-click conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostViewConversions	Long	The count of post-view conversions indicated by pixel loads on an external advertiser website.
Follows	Long	The count of follows. Sponsored
FullScreenPlays	Long	A user taps on the video, going into video view mode.
Impressions	Long	This is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails.
LandingPageClicks	Long	The count of clicks which take the user to the creative landing page.
LeadGenerationMailContactInfoShares	Long	The number of times a user shared contact info through the One Click Leadgen for Sponsored InMail.
LeadGenerationMailInterestedClicks	Long	The count of InMail recipients showing interest.
Likes	Long	The count of likes.
OneClickLeadFormOpens	Long	The count of times a user opened the lead form for a One Click Lead Gen campaign.
OneClickLeads	Long	The count of leads generated through One Click Lead Gen.
Opens	Long	The count of opens of Sponsored InMail.
OtherEngagements	Long	The count of user interactions with the ad unit that do not fit into any other more specific category.
Shares	Long	The count of shares.
TextUrlClicks	Long	The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail.
TotalEngagements	Long	The count of all user interactions with the ad unit.
VideoCompletions	Long	The count of video ads that played 97-100% of the video.
VideoFirstQuartileCompletions	Long	The count of video ads that played through the first quartile of the video.
VideoMidpointCompletions	Long	The count of video ads that played through the midpoint of the video.
VideoStarts	Long	The count of video ads that were started by a user.
VideoThirdQuartileCompletions	Long	The count of video ads that played through the third quartile of the video.
VideoViews	Long	A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
ViralCardClicks	Long	The number of viralClicks for each card of a carousel ad.
ViralCardImpressions	Long	The number of viralImpressions shown for each card of a carousel ad.
ViralClicks	Long	The count of clicks on viral impressions.
ViralComments	Long	The count of comments from viral impressions for this activity.
ViralCompanyPageClicks	Long	The count of clicks to view the company page from viral impressions for this activity.
ViralExternalWebsiteConversions	Long	The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.
ViralExternalWebsitePostClickConversions	Long	The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.
ViralExternalWebsitePostViewConversions	Long	The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.
ViralFollows	Long	The count of follows from viral impressions for this activity.
ViralFullScreenPlays	Long	A user taps on the video, going into video view mode.
ViralImpressions	Long	The count of viral impressions for this activity.
ViralLandingPageClicks	Long	The count of clicks on viral impressions to take the user to the creative landing page.
ViralLikes	Long	The count of likes from viral impressions for this activity.
ViralOneClickLeadFormOpens	Long	The count of times a user opened the lead form for viral impressions from a Lead Gen campaign.
ViralOneClickLeads	Long	The count of leads generated through One Click Lead Gen from viral impressions for this activity.
ViralOtherEngagements	Long	The count of user interactions with viral impressions that do not fit into any other more specific category.
ViralShares	Long	The count of shares from viral impressions for this activity.
ViralTotalEngagements	Long	The count of all user interactions with a viral ad unit.
ViralVideoCompletions	Long	The count of viral video ads that played 97-100% of the video.
ViralVideoFirstQuartileCompletions	Long	The count of viral video ads that played through the first quartile of the video.
ViralVideoMidpointCompletions	Long	The count of viral video ads that played through the midpoint of the video.
ViralVideoStarts	Long	The count of viral video ads that were started by a user.
ViralVideoThirdQuartileCompletions	Long	The count of viral video ads that played through the third quartile of the video.
ViralVideoViews	Long	A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
AverageDailyReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (daily).
AverageDailyReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (daily).
AverageDailyReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily).
AveragePreviousSevenDayReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days).
AveragePreviousThirtyDayReachMetricsApproximateReach	Decimal	The average reach, or unique member accounts with at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateFrequency	Decimal	The average of impressions shown to each member account that received at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateCost	Decimal	The average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days).
ApproximateMemberReach	Long	The estimated number of unique member accounts with at least one impression. This metric is only available when the number of days in the date range is less than or equal to 92 days. It will be returned only if the following pivots/columns are specified in the query: Creative, Campaign, CampaignGroup, CampaignType and/or ServingLocation. Additionally, it will not be available for the current UTC day. The expected delay for current UTC day will be 24-48 hours. If the present day is specified in ReportEndTime, the date range will only return reach for days where data exists.
ValidWorkEmailLeads	Long	The count of leads with a valid work email that does not use an established free or personal email domain.
PostClickRegistrations	Decimal	The number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page.
PostViewRegistrations	Decimal	The number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page.
DownloadClicks	Long	The number of times users have indicated the intent to download the media in an ad by clicking the download icon.
QualifiedLeads	Long	The count of qualified leads shared by the advertiser. Qualified lead is a lead that has been deemed more likely to become a customer compared to other leads, based on their engagement and fit.
CostPerQualifiedLead	Decimal	How much money was spent per qualified lead. Ratio is costInLocalCurrency / qualifiedLeads.
MessagingAdvertSendCount	Long	The count of sends of Sponsored Messaging ads.
MessagingAdvertOpenCount	Long	The count of opens of Sponsored Messaging ads.

The Audience Count API allows advertisers to forecast the reach of targeting criteria.

Table Specific Information

Select

The AudienceCount view allows advertisers to forecast the reach of targeting criteria.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM AudienceCount WHERE AgeRanges = '(25,34)'

SELECT * FROM AudienceCount WHERE DegreesId = '1234'

SELECT * FROM AudienceCount WHERE FieldsOfStudyId = '1234'

SELECT * FROM AudienceCount WHERE Genders = 'MALE'

SELECT * FROM AudienceCount WHERE IndustriesId = '1234'

SELECT * FROM AudienceCount WHERE JobFunctionsId = '1234'

SELECT * FROM AudienceCount WHERE LocationsId = '1234'

SELECT * FROM AudienceCount WHERE ProfileLocationsId = '1234'

SELECT * FROM AudienceCount WHERE SenioritiesId = '1234'

SELECT * FROM AudienceCount WHERE SkillsId = '1234'

SELECT * FROM AudienceCount WHERE StaffCountRanges = '(11,50)'

SELECT * FROM AudienceCount WHERE TitlesId = '1234'

Select Rules

Audience count reports:

Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.

Columns

Name	Type	Description
ActiveAudience	Integer	Active audience count for the given targeting criteria.
TotalAudience	Integer	Total audience count for the given targeting criteria.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AgeRange	String	Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeId	String	Educational degrees attained to match against those of the member.
FieldOfStudyId	String	Fields of study to match against those listed by the member.
Gender	String	Genders to match against member. Supported values are: MALE, FEMALE
IndustryId	String	Industries to be targeted.
JobFunctionId	String	Top level groupings of supertitles to be targeted.
LocationId	String	Location to be targeted.
ProfileLocationId	String	The values are similar to
SeniorityId	String	Seniorities to be targeted.
SkillId	String	Skills to match against the member's listed skills.
StaffCountRange	String	Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleId	String	Job titles to match against the member's current title.
AudienceMatchingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerId	String	Employer ID to match against member's listed companies.
CompanyId	String	Company ID to match against member's listed companies.
InterfaceLocaleId	String	Locale ID to match against member's preferred locale settings.

The LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

Table Specific Information

Select

The BudgetPricing view provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM BudgetPricing WHERE AgeRanges = '(25,34)' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE DegreesId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE FieldsOfStudyId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE Genders = 'MALE' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE IndustriesId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE JobFunctionsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE LocationsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE ProfileLocationsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE SenioritiesId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE SkillsId = '1234' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE StaffCountRanges = '(11,50)' AND Account = '1234'

SELECT * FROM BudgetPricing WHERE TitlesId = '1234' AND Account = '1234'

Select Rules

Budget pricing reports:

Dimensions	Use 1 or more	AgeRanges, DegreesId, FieldsOfStudyId, Genders, IndustriesId, JobFunctionsId, LocationsId, ProfileLocationsId, SenioritiesId, SkillsId, StaffCountRanges, TitlesId Note: If no dimension is specified the default dimension will be Genders and will be set to both MALE and FEMALE as the default value.
Filter	Required	CampaignType, Account, BidType, MatchType Note: Only 1 dimension is allowed in the OR operation and 1 or more dimensions are allowed in the AND operation. The default value for CampaignType will be TEXT_AD. The default value for BidType will be CPM. The default value for MatchType will be EXACT. If there is no Account specified there will be records for every account that belongs to the user.

Columns

Name	Type	Description
SuggestedBidDefault	String	The suggested bid
SuggestedBidMin	String	Low end of suggested bid range
SuggestedBidMax	String	High end of suggested bid range
DailyBudgetLimitsDefault	String	Default daily budget
DailyBudgetLimitsMin	String	Minimum daily budget
DailyBudgetLimitsMax	String	Maximum daily budget
BidLimitsMax	String	The maximum bid allowed
BidLimitsMin	String	The minimum bid allowed, also known as the floor price
Account	String	Sponsored account URN.
CampaignType	String	The campaign type. The default value is TEXT_AD.
BidType	String	The bidding type. The default value is CPM.
MatchType	String	The matching type. The default value is EXACT.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
AgeRange	String	Age ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeId	String	Educational degrees attained to match against those of the member.
FieldOfStudyId	String	Fields of study to match against those listed by the member.
Gender	String	Genders to match against member. Supported values are: MALE, FEMALE
IndustryId	String	Industries to be targeted.
JobFunctionId	String	Top level groupings of supertitles to be targeted.
LocationId	String	Location to be targeted.
ProfileLocationId	String	The values are similar to
SeniorityId	String	Seniorities to be targeted.
SkillId	String	Skills to match against the member's listed skills.
StaffCountRange	String	Organization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleId	String	Job titles to match against the member's current title.
AudienceMatchingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentId	String	An Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerId	String	Employer ID to match against member's listed companies.
CompanyId	String	Company ID to match against member's listed companies.
InterfaceLocaleId	String	Locale ID to match against member's preferred locale settings.

The Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

Select

The CampaignGroups view returns a list of the campaign groups that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM CampaignGroups WHERE Status = 'ACTIVE'

Columns

Name	Type	Description
Id	String	Numerical identifier for the campaign group
Account	String	URN identifying the advertising account associated with the Campaign Group. This value is immutable once set
Name	String	The name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose
Status	String	Current Status of the campaign group
TotalBudgetAmount	Decimal	Maximum amount to spend over the life of the Campaign Group.
TotalBudgetCurrencyCode	String	ISO currency code. The currency code must match that of the parent account.
ScheduleStartTime	Datetime	Represents the inclusive (greater than or equal to) value in which to start the range.
ScheduleEndTime	Datetime	Scheduled date range to run associated objects.
Backfilled	Boolean	Flag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns.
AdAccountId	String	Id of the account

The Insights API offers analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

Table Specific Information

NOTE: This view is deprecated and will be removed in early 2025.

Select

The CampaignInsights view returns a list of the analysis of a campaign's budget utilization, and identifies modifications that can be made to a bid, daily budget, or total budget to maximize utilization or impressions.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM CampaignInsights WHERE Campaign = '123456'

Columns

Name	Type	Description
Campaign	String	The campaign to which this recommendation belongs.
AverageSpendAmount	String	The average spend of the entity.
AverageSpendCurrencyCode	String	The currency code of the average spend.
BidAmount	String	A prediction of how much additional impressions could be generated from a different bid.
BidCurrencyCode	String	The currency code of additional impressions.
RelativeImpressions	Decimal	A prediction of how much additional impressions could be generated from a different bid.
BudgetExhaustedAt	Timestamp	Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.
CampaignRelevanceScore	Long	A score between 0 and 10 (inclusive) indicating how relevant this campaign is compared to its competitors.
DailyBudgetUtilization	Decimal	The average daily budget utilization.
TotalBudgetUtilization	Decimal	The fraction of the total budget this ad entity has spent so far.

The Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.

Table Specific Information

Select

The Campaigns view returns a list of the campaigns that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Campaigns WHERE Status = 'ACTIVE'

Columns

Name	Type	Description
Id	String	Numerical identifier for the campaign
Account	String	URN identifying the advertising account associated with the Campaign.
CampaignGroup	String	Numerical identifier for the campaign group.
AssociatedEntity	String	An URN for a strongly associated object, with semantics varying based on the Campaign type.
AudienceExpansionEnabled	Boolean	Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria
CostType	String	CPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link
CreativeSelection	String	ROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance
DailyBudgetAmount	String	The amount of money as a real number string
DailyBudgetCurrency	String	ISO currency code
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.
Name	String	The name of the Campaign
OffsiteDeliveryEnabled	Boolean	Allow this campaign access to be served on the LinkedIn Advertising Network.
ScheduleStartTime	Datetime	Scheduled date range to run associated creatives.
ScheduleEndTime	Datetime	Scheduled date range to run associated creatives.
Status	String	Current Status of the campaign
Type	String	Type of campaign
UnitCostAmount	String	Amount to bid per click, impression, or other event depending on the pricing model.
UnitCostCurrency	String	Currency of the UnitCostAmount
ObjectiveType	String	The Campaign Objective type.
AdAccountId	String	Id of the account
ConnectedTelevisionOnly	Boolean	Flag showing whether this campaign is a Connected Television Only campaign. Allow advertisers to specify when they’re creating a CTV campaign. Not specifying the boolean can be considered false.
TimeSpanDuration	Integer	Represents the length of time.
TimeSpanUnit	String	Represents the unit of the duration of time
Frequency	Integer	The number of times the campaign is shown to a member.

Retrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.

Table Specific Information

Select

The Conversions view returns a list of the insights into post-click and view-through conversions of your LinkedIn ads campaigns, giving you the ability to measure the impact and ROI of your ads.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Conversions WHERE Account = '123456'

Columns

Name	Type	Description
Id	String	Numerical identifier for the Conversion.
Account	String	URN identifying the advertising account associated with the Conversion.
DomainId	String	The insightTagDomain key that this Conversion resides under.
Name	String	A short name for this rule, which will be shown in the UI and in reports.
Created	String	The timestamp when the Conversion was created.
LastModified	String	The timestamp when the Conversion was last modified.
LastCallbackAt	String	The timestamp of the last callback from the Conversion.
Amount	String	The amount of money as a real number string.
CurrencyCode	String	Identifying code for currency type. See currency codes for the valid codes.
Type	String	The type of the rule.
Enabled	String	Set to true or false to enable or disable this rule from matching on the advertiser's website.
ImagePixelTag	String	The HTML representation of the image pixel.
PostClickAttributionWindowSize	Integer	The HTML representation of the image pixel.
ViewThroughAttributionWindowSize	Integer	The HTML representation of the image pixel.

The Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.

Table Specific Information

Select

The Creatives view returns a list of the creatives that belong to the authenticated user so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Creatives WHERE Id = '179345687'

SELECT * FROM Creatives WHERE Account = '510013292'

SELECT * FROM Creatives WHERE Account IN ('510013292', '510013293')

SELECT * FROM Creatives WHERE Campaign = '198952936'

SELECT * FROM Creatives WHERE IntendedStatus = 'ACTIVE'

Columns

Name	Type	Description
Id	String	Numerical identifier for the creative.
Account	String	URN identifying the advertising account associated with the creative.
Campaign	String	URN identifying the campaign associated with the creative.
Content	String	Content sponsored in the creative.
CreatedAt	Datetime	Datetime when the creative was first created
CreatedBy	String	Entity that developed the creative.
IntendedStatus	String	Creative user intended status.
IsServing	Boolean	This indicates whether the creative is currently being served or not.
ServingHoldReasons	String	Array that contains all the reasons why the creative is not serving.
LastModifiedAt	Datetime	Datetime when the creative was last modified.
LastModifiedBy	String	Entity that modified the creative.
ReviewStatus	String	The current review status of the creative.
IsTest	Boolean	Flag showing whether this creative is a test creative, i.e., belongs to a test campaign.
AdAccountId	String	Id of the account
CallToActionLabel	String	Label for the CallToAction button. Present only if the campaign objective is LEAD_GENERATION.
CallToActionFormId	String	The Id of the corresponding form which the call to action redirects to. Present only if the campaign objective is LEAD_GENERATION.
RejectionReasons	String	A comma-seperated list of values with reasons explaining why the creative has been rejected.
Name	String	The name of the creative that can be set by advertiser; primarily used to make it easier to reference a Creative and to recall its purpose.

Degree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Degrees view returns a list of the degrees found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Degrees

Columns

Name	Type	Description
Id	String	Degree id
URN	String	Standardized degree URN
Name	String	Degree name in various locales. Represented as MultiLocaleString type.

Fields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The FieldsOfStudy view returns a list of the fields of study found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM FieldsOfStudy

Columns

Name	Type	Description
Id	String	Field of study id
URN	String	Standardized field of study URN
Name	String	Field of study name in various locales. Represented as MultiLocaleString type.

Query form data for the forms that belong to a specified owner (account).

Table Specific Information

The Account column must be specified in the criteria to use this view.

Select

For the Account 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 Forms WHERE Account = '512859024';
SELECT * FROM Forms WHERE Account IN ('512859024', '513009855');

When no criteria is specified as shown below:

SELECT * FROM Forms;

, we internally post-process the query to the following before executing:

SELECT * FROM Forms WHERE Account IN (SELECT Id FROM Accounts);

The rest of the query is processed client-side.

Columns

Name	Type	Description
Id [KEY]	String	Identifier for the form.
Account	String	Identifier for the owner of the form. This is the advertiser account.
Created	Timestamp	Timestamp for creation of the form.
LastModified	Timestamp	Timestamp for last modification of the form.
Description	String	Description of the form, visible to both the owner and the viewer.
Headline	String	Headline of the form, visible to both the owner and the viewer.
LandingPage	String	The landing page URL after the viewer clicks on submit.
LegalDisclaimer	String	Advertiser's legal disclaimer to accompany this form.
Name	String	Name of the form, visible to the owner of the form but not visible to the viewer.
PrivacyPolicy	String	The URL of the privacy policy that covers any data passed to the owner of the form.
Country	String	A lowercase two-letter language code as defined by ISO-639-1
Language	String	An uppercase two-letter country code as defined by ISO-3166.
ReviewStatus	String	The status of the review of the form.
ReviewedAt	Timestamp	Timestamp for when the form's review status was initiated/last updated.
Status	String	Indicates the state of review for the Lead Form. Can be one of the following: DRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED.
VersionTag	String	The number of times the form has been modified.

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

Table Specific Information

The Id column must be specified in the criteria to use this view.

Select

For The Id 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 GeoLocations WHERE Id = '123456';
SELECT * FROM GeoLocations WHERE Id IN ('123456', '234567');

The rest of the query is processed client-side.

Columns

Name	Type	Description
Id [KEY]	String	Identifier for the location.
Name	String	The name of the location.
LocaleCountry	String	An uppercase two-letter country code as defined by ISO-3166.
LocaleLanguage	String	A lowercase two-letter language code as defined by ISO-639.

Industry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Industries view returns a list of the industries found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Industries

Columns

Name	Type	Description
Id	String	Industry id
URN	String	Standardized industry URN
Name	String	Industry name in various locales. Represented as MultiLocaleString type.
ChildrenIndustries	String	The URNs of the children industries associated with this node.
ParentIndustries	String	The URNs of the parent industry associated with this node.

Job function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The JobFunctions view returns a list of the Job Functions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM JobFunctions

Columns

Name	Type	Description
Id	String	Job function id
URN	String	Standardized Job function URN
Name	String	Job function name in various locales. Represented as MultiLocaleString type.

Retrieve all posts for an organization.

Select

The OrganizationId column is required and must be specified in the criteria to use this view.

The Sync App will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• OrganizationId supports the '=' comparisons.

OrganizationID

You can obtain OrganizationId information from the LinkedIn dashboard. The syntax is:

"com.linkedin.common.CompanyAttributedEntity": { "company": "urn:li:organization:12345" }

Code Samples

The following queries are processed server side:

SELECT * FROM Posts WHERE OrganizationId = '123456789'

Columns

Name	Type	Description
Id [KEY]	String	Id of the post.
Author	String	Author of the post.
Commentary	String	The user generated commentary for the post.
Content	String	The posted content.
CreatedAt	Datetime	Datetime when the post was created.
IsReshareDisabledByAuthor	Boolean	Indicates whether resharing of the post has been disabled by the author.
LastModifiedAt	Datetime	Datetime when the post was lastly modified.
LifecycleState	String	Lifecycle state of the post.
PublishedAt	Datetime	Datetime at which the content was published.
Visibility	String	Visibility restrictions on content.
OrganizationId	String	Id of the organization who created the post.
ContentLandingPage	String	Web page that is opened when the member clicks on the associated content.
IsDirectSponsoredContent	Boolean	Whether or not this post is Direct Sponsored Content.
DirectSponsoredContentAdAccount	String	The Ad Account that created the Direct Sponsored Content.
DirectSponsoredContentAdType	String	The type of Direct Sponsored Content.
DirectSponsoredContentName	String	Plain text name of the Direct Sponsored Content post.
DirectSponsoredContentStatus	String	The status of the advertising company content.

Seniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Seniorities view returns a list of the seniority positions found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Seniorities

Columns

Name	Type	Description
Id	String	Seniority id
URN	String	Standardized Seniority URN
Name	String	Seniority name in various locales. Represented as MultiLocaleString type.

Skills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Skills view returns a list of the job skills found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Skills

Columns

Name	Type	Description
Id	String	skill id
Name	String	skill name in various locales. Represented as MultiLocaleString type.

The socialActions API allows access to both personal and organization social actions.

Select

The Sync App will use the LinkedIn Marketing Solutions API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• UGCPostId supports the '=, IN' comparisons.

For example, the following queries are processed server side:

SELECT * FROM SocialActions WHERE UGCPostId = 'urn:li:share:12345'

SELECT * FROM SocialActions WHERE UGCPostId IN ('urn:li:share:12345', 'urn:li:share:23456')

Columns

Name	Type	Description
TotalFirstLevelComments	Integer	Total number of first level comments.
AggregatedTotalComments	Integer	Total number of aggregated comments.
LikedByCurrentUser	Boolean	Indicator if the post is liked by current user.
TotalLikes	Integer	Total number of likes.
Target	String	Total number of likes.
UGCPostId	String	Id of UGC Post.

Use thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.

Table Specific Information

Select

The Forms view returns a list of the Third-party tracking tags through the ad creative they're associated with. The following request takes in an ad creative URN in the creative parameter to search for third-party tracking tags linked to that ad creative.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM ThirdPartyTracking WHERE Creative = '123456'

Columns

Name	Type	Description
Id	String	The campaign to which this recommendation belongs.
Creative	String	The campaign to which this recommendation belongs.
Account	String	The average spend of the entity.
Event	String	The currency code of the average spend.
Platform	String	A prediction of how much additional impressions could be generated from a different bid.
TrackingUrl	String	The currency code of additional impressions.
Created	Timestamp	A prediction of how much additional impressions could be generated from a different bid.
LastModified	Timestamp	Date at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.

Titles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Table Specific Information

Select

The Titles view returns a list of the job titles found accross LinkedIn so they can be used as dimensions in analytic requests.

The Sync App uses the LinkedIn Marketing Solutions API to process search criteria. The Sync App processes other filters client-side within the Sync App. For example, the following queries are processed server side.

SELECT * FROM Titles

Columns

Name	Type	Description
Id	String	Titles id
URN	String	Standardized Titles URN
Name	String	Titles name in various locales. Represented as MultiLocaleString type.

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.

OAuth

---

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Scope	A specific scope that the user requires the access token.

SSL

---

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

Firewall

---

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.

Proxy

---

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

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.

Schema

---

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 .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from LinkedIn Marketing Solutions, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

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 that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
Scope	A specific scope that the user requires the access token.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

A specific scope that the user requires the access token.

Remarks

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.

Remarks

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

This property can take the following forms:

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

If not specified, any certificate trusted by the machine is accepted.

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

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.

Remarks

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 Marketing Solutions. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to LinkedIn Marketing Solutions. 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 Marketing Solutions. 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.

Remarks

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.

Remarks

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.

Remarks

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.

Remarks

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	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) 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	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	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.

Remarks

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. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

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, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is 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.

Remarks

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Set this when the ProxyServer does not require authentication.

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.

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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 user name of a user registered with the proxy server.
DIGEST	The user name 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.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

The password associated with the user specified in the ProxyUser connection property.

Remarks

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.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

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.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

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

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

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.

Remarks

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

Remarks

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

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

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 .

Remarks

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 rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from LinkedIn Marketing Solutions, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

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

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

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

Specifies the maximum number of results to return from LinkedIn Marketing Solutions, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

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 default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

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.

Setting this property to 0 disables the timeout, allowing 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. 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 defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property 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 Analytics WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.