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

Connecting to LinkedIn Marketing Solutions

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

Accessing Data from CData Cloud Services

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

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

Authenticating to LinkedIn Marketing Solutions (OAuth)

LinkedIn Marketing Solutions supports OAuth authentication only.

Creating a Custom OAuth Application

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

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

Custom OAuth applications are useful if you want to:

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

Procedure

To create a custom OAuth application for use with LinkedIn Marketing Solutions:

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

After the application is created:

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

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

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

Understanding Scopes

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

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

Required Scopes for LinkedIn Marketing Solutions

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

Entity	Statement Types	Minimal Required Scopes
Accounts	SELECT	r_ads
Accounts	INSERT UPDATE DELETE	rw_ads
AccountUsers	SELECT	r_ads
AccountUsers	INSERT UPDATE DELETE	rw_ads
BrandLiftTests	SELECT	r_ads
BrandLiftTests	INSERT	rw_ads
CampaignGroups	SELECT	r_ads
CampaignGroups	INSERT UPDATE DELETE	rw_ads
Campaigns	SELECT	r_ads
Campaigns	INSERT UPDATE DELETE	rw_ads
Conversions	SELECT	r_ads
Conversions	INSERT	rw_ads
Creatives	SELECT	r_ads
Creatives	INSERT UPDATE DELETE	rw_ads
DMPSegments	SELECT INSERT UPDATE DELETE	rw_dmp_segments
EngagementRules	SELECT	r_ads
Forms	SELECT	r_ads
Forms	INSERT UPDATE	rw_ads
Images	SELECT	r_organization_social
Images	UPDATE	w_organization_social
MessageCreatives	SELECT	r_ads
MessageCreatives	INSERT UPDATE	rw_ads
Posts	SELECT	r_ads
Posts	INSERT UPDATE DELETE	rw_ads
PublisherRestrictionFiles	SELECT	r_ads
PublisherRestrictionFiles	INSERT	rw_ads
ThirdPartyTracking	SELECT	r_ads
ThirdPartyTracking	INSERT DELETE	rw_ads
Videos	SELECT	r_organization_social
Videos	UPDATE	w_organization_social
AdFormResponses	SELECT	r_marketing_leadgen_automation
Analytics	SELECT	r_ads_reporting
AudienceCount	SELECT	-
BudgetPricing	SELECT	r_ads
ConversationCreativeActions	SELECT	r_ads
ConversationCreativeActions	INSERT UPDATE	rw_ads
ConversationCreatives	SELECT	r_ads
ConversationCreatives	INSERT	rw_ads
Degrees	SELECT	-
Documents	SELECT	r_organization_social
FieldsOfStudy	SELECT	-
GeoLocations	SELECT	-
IABCategories	SELECT	-
Industries	SELECT	-
JobFunctions	SELECT	-
OrganizationRoleAssignments	SELECT	r_organization_admin
SavedAudienceTemplates	SELECT	r_ads
SavedAudienceTemplates	INSERT UPDATE DELETE	rw_ads
Seniorities	SELECT	-
Skills	SELECT	-
SocialActions	SELECT	r_organization_social
TargetingEntities	SELECT	-
TargetingFacets	SELECT	-
Titles	SELECT	-
DownloadAsset	EXECUTE	r_organization_social
UploadDocument	EXECUTE	w_organization_social
UploadImage	EXECUTE	w_organization_social
UploadVideo	EXECUTE	w_organization_social
UploadVideoCaptions	EXECUTE	-
UploadVideoThumbnail	EXECUTE	-

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
linkedin.com	True	The main domain used for accessing the main LinkedIn API-s that the Cloud uses.
licdn.com	False	The domain used for downloading LinkedIn assets through its CDN such as Images or Videos (see DownloadAsset as well).

Customizing the SSL Configuration

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

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

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

Other Proxies

Set the following properties:

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

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

Tables

The CData Cloud models the data in Tables 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.

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

CData Cloud - LinkedIn Marketing Solutions Tables

Name	Description
Accounts	Retrieves all advertising accounts the authenticated user has access to, filtered by a specified status to help manage and monitor active or inactive accounts.
AccountUsers	Provides details about users associated with a specific LinkedIn Ads account, including their roles and permissions.
BrandLiftTests	Retrieves information on brand lift tests that measure how advertising impacts brand perception within your LinkedIn Ads account.
CampaignGroups	Lists all campaign groups available to the authenticated user, filtered by status, to help organize and manage related campaigns.
Campaigns	Retrieves campaigns in your LinkedIn Ads account by specified status, allowing performance tracking and campaign management.
ConversationCreativeActions	Provides data on user interactions with conversation ad creatives, including clicks and message-level engagement metrics.
ConversationCreatives	Returns details of conversation ad creatives used in your LinkedIn Ads account, including creative content and configuration.
Conversions	Lists conversion events that represent valuable actions taken by users, such as form submissions or purchases, linked to your ads.
Creatives	Retrieves ad creative details, including identifiers, campaign references, and statuses, to support creative management and optimization.
DMPSegments	Retrieve and manage LinkedIn Data Management Platform (DMP) segments for B2B audience targeting and custom audience creation across ad exchanges.
Forms	Retrieves forms owned by a specific account, including metadata and configuration details for LinkedIn Lead Gen Forms.
Images	Retrieves metadata for image assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information.
MessageCreatives	Provides details about message ad creatives in your LinkedIn Ads account, including content, delivery, and performance attributes.
Posts	Retrieves posts created for a LinkedIn organization, enabling content analysis and engagement tracking.
PublisherRestrictionFiles	Retrieves data about publisher restriction files that define which off-network sites are allowed or blocked for ad serving.
SavedAudienceTemplates	Read and write saved audience targeting templates in your ad-accounts.
ThirdPartyTracking	Retrieves existing third-party tracking tags used to monitor conversions and engagement across external platforms.
Videos	Retrieves metadata for video assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information.

Retrieves all advertising accounts the authenticated user has access to, filtered by a specified status to help manage and monitor active or inactive accounts.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Accounts WHERE Status = 'ACTIVE'

CUD Operations

Insert

To create a new account, use an INSERT statement. The Type column only accepts 'BUSINESS' value as you cannot create ENTERPRISE accounts through the API.

The following columns are required for insert operations: Name and Type. Currency, NotifiedOnCreativeRejection, NotifiedOnEndOfCampaign, Status, NotifiedOnCampaignOptimization, Reference, NotifiedOnCreativeApproval and IsTest are optional columns.

    INSERT INTO Accounts (Name, Currency, Type, NotifiedOnCreativeRejection, NotifiedOnEndOfCampaign, Status, NotifiedOnCampaignOptimization, Reference, NotifiedOnCreativeApproval, IsTest) VALUES ('Sample Business Account', 'USD', 'BUSINESS', TRUE, TRUE, 'ACTIVE', FALSE, 'urn:li:organization:12345', TRUE, FALSE);

Update

To modify an existing account, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns are the ones that are mutable after creation: Name, NotifiedOnCreativeRejection, NotifiedOnEndOfCampaign, Status, NotifiedOnCampaignOptimization, Reference, NotifiedOnCreativeApproval.

    UPDATE Accounts SET Name = 'Updated Account Name',NotifiedOnCreativeRejection = FALSE,NotifiedOnEndOfCampaign = TRUE,Status = 'DRAFT',NotifiedOnCampaignOptimization = TRUE,Reference = 'urn:li:organization:67890',NotifiedOnCreativeApproval = FALSE WHERE Id = 123456;

Delete

To remove an account, use a DELETE statement. Note that the Id column is required in the WHERE clause.

DELETE FROM Accounts WHERE Id = '123456'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier of the advertising account within LinkedIn Ads.
Name	String	False		Display name assigned to the account, typically used to identify it in reports and the Campaign Manager interface.
Currency	String	False		Currency code defined by ISO 4217 representing the currency used for billing and reporting in this account.
Type	String	False		Specifies the type of advertising account, such as a business or enterprise account. The allowed values are BUSINESS, ENTERPRISE.
NotifiedOnCreativeRejection	Boolean	False		Indicates whether the creative contact receives notifications when a creative is rejected due to policy or content issues.
NotifiedOnEndOfCampaign	Boolean	False		Indicates whether the campaign contact receives a notification when a campaign associated with the account has finished running.
Status	String	False		Current operational status of the account. The allowed values are ACTIVE, PENDING_DELETION, CANCELED, DRAFT, REMOVED.
NotifiedOnCampaignOptimization	Boolean	False		Indicates whether the campaign contact is notified about optimization recommendations or performance improvement opportunities.
Version	String	True		Represents the version or revision identifier for the account record, used to manage updates and concurrency.
Reference	String	False		Identifies the entity or organization on whose behalf the account runs advertisements.
NotifiedOnCreativeApproval	Boolean	False		Indicates whether the creative contact receives a notification when a creative has been reviewed and approved for use.
AuditStampsCreator	String	True		Name or identifier of the user who initially created the audit record for this account.
AuditStampsCreatedAt	Datetime	True		Date and time when the account's audit record was first created.
AuditStampsLastModifier	String	True		Name or identifier of the user who last modified the audit record for this account.
AuditStampsLastModifiedAt	Datetime	True		Date and time when the account's audit record was most recently updated.
IsTest	Boolean	False		If the value is 'true', the account is designated as a test account, which can only be set during account creation and cannot be changed later.
URN	String	True		Uniform Resource Name (URN) that uniquely identifies the account within LinkedIn's system.

Provides details about users associated with a specific LinkedIn Ads account, including their roles and permissions.

Table Specific Information

Select

For the AccountURN 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 AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939'
SELECT * FROM AccountUsers WHERE AccountURN IN ('urn:li:sponsoredAccount:515215939', 'urn:li:sponsoredAccount:515221250')
SELECT * FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:tOc1bFjxgJ'

The rest of the query is processed client-side.

Insert

To create a new account user, use an INSERT statement.

The following columns are required for this operation:

• AccountURN
• UserURN
• Role

INSERT INTO AccountUsers (AccountURN, UserURN, Role) VALUES ('urn:li:sponsoredAccount:515215939', 'urn:li:person:XXXXXXXXXX', 'CAMPAIGN_MANAGER')

Update

To modify an existing account user, use an UPDATE statement. Note that the AccountURN and UserURN columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Role

UPDATE AccountUsers SET Role = 'VIEWER' WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:XXXXXXXXXX'

Delete

To remove an account user, use a DELETE statement. Note that the AccountURN and UserURN columns are required in the WHERE clause.

DELETE FROM AccountUsers WHERE AccountURN = 'urn:li:sponsoredAccount:515215939' AND UserURN = 'urn:li:person:XXXXXXXXXX'

Columns

Name	Type	ReadOnly	References	Description
AccountURN [KEY]	String	False		Uniform Resource Name (URN) that uniquely identifies the advertising account to which the user is assigned.
UserURN [KEY]	String	False		URN that uniquely identifies the LinkedIn member associated with this account.
Role	String	False		Specifies the user's assigned role within the advertising account. The allowed values are VIEWER, CREATIVE_MANAGER, CAMPAIGN_MANAGER, ACCOUNT_MANAGER, ACCOUNT_BILLING_ADMIN.
CreatedAt	Datetime	True		Date and time when the user record was first added to the account.
UpdatedAt	Datetime	True		Date and time when the user record was last updated, reflecting any changes to role or access.

Retrieves information on brand lift tests that measure how advertising impacts brand perception within your LinkedIn Ads account.

Table Specific Information

Select

For the AccountURN 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 BrandLiftTests WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM BrandLiftTests WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

For the ExecutionState column, the = operator is fully supported server-side. Refer to the query example below:

SELECT * FROM BrandLiftTests WHERE ExecutionState = 'CREATED';

When no criteria is specified as shown below:

SELECT * FROM BrandLiftTests;

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

SELECT * FROM BrandLiftTests WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Insert

To create a new brand lift test, use an INSERT statement.

The following columns are required for this operation:

• AccountURN
• Name
• BrandName
• BrandNameLocaleLanguage
• BrandNameLocaleCountry
• UserState
• StartTime
• EndTime

INSERT INTO BrandLiftTests(AccountURN, Name, BrandName, BrandNameLocaleLanguage, BrandNameLocaleCountry, UserState, StartTime, EndTime) VALUES('urn:li:sponsoredAccount:512859024', 'Lift Test 1', 'Test Brand 1', 'en', 'US', 'READY', '2025-08-01T00:00:00.000-04:00', '2025-10-01T00:00:00.000-04:00')

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier assigned to the brand lift test within LinkedIn Ads.
AccountURN	String	False		Uniform Resource Name (URN) that identifies the advertising account associated with the brand lift test.
Name	String	False		Name assigned to the brand lift test for tracking and reporting purposes.
Description	String	False		Detailed description of the brand lift test, outlining its purpose or scope.
CampaignGroupURN	String	False		URN that identifies the campaign group included in the brand lift test. When specified, only campaigns within this group are measured; otherwise, all campaigns under the ad account are analyzed.
BrandName	String	False		Name of the brand used when surveying LinkedIn members as part of the brand lift study.
BrandNameLocaleLanguage	String	False		Specifies the locale language of the brand name using a lowercase two-letter code as defined by ISO 639.
BrandNameLocaleCountry	String	False		Specifies the locale country of the brand name using an uppercase two-letter code as defined by ISO 3166.
UserState	String	False		Represents the advertiser-defined state used to manage or control the brand lift test. The allowed values are DRAFT, READY, CANCELED.
ExecutionState	String	True		Indicates the current execution state of the brand lift test, derived from both the UserState value and LinkedIn's internal test status. The allowed values are CREATED, SCHEDULED, STARTED, ENDED_RESUMABLE, ENDED.
StartTime	Datetime	False		Planned start date and time for the brand lift test.
EndTime	Datetime	False		Planned end date and time for the brand lift test.
EndedAt	Datetime	True		Actual date and time when the brand lift test concluded. LinkedIn may end the test earlier than the scheduled 'EndTime'.
EndReason	String	True		Describes the reason why the brand lift test ended. The allowed values are USER_CANCELED, END_DATE_REACHED, CAMPAIGN_GROUP_NOT_RECOVERABLE, ACCOUNT_NOT_RECOVERABLE.
ContentReviewVersion	Long	True		Version number indicating the specific content iteration reviewed for compliance with LinkedIn's advertising content policies.

Lists all campaign groups available to the authenticated user, filtered by status, to help organize and manage related campaigns.

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the Cloud.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM CampaignGroups WHERE Status = 'ACTIVE'

SELECT * FROM CampaignGroups WHERE AdAccountId = '510013292'

CUD Operations

Insert

To create a new campaign group there are some fields that are required in initial creation which are: Account, Name, ScheduleStartTime, AdAccountId.

While the following parameters are optional: Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleEndTime

Note: When specifying the status of the campaign group in creation it can only be ACTIVE or DRAFT.

    INSERT INTO CampaignGroups (Account, Name, Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleStartTime, ScheduleEndTime, AdAccountId ) VALUES ( 'urn:li:sponsoredAccount:12345', 'Sample Campaign Group', 'ACTIVE', 5000.00, 'USD', '2025-07-15 09:00:00', '2025-12-31 23:59:59', '123465798' );

Update

To modify an existing campaign group the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: Name, Status, TotalBudgetAmount, TotalBudgetCurrencyCode, ScheduleStartTime, ScheduleEndTime.

    UPDATE CampaignGroups SET Name = 'Updated Campaign Group Name', Status = 'PAUSED', TotalBudgetAmount = 7500.00, TotalBudgetCurrencyCode = 'USD', ScheduleStartTime = '2025-08-01 00:00:00', ScheduleEndTime = '2025-12-31 23:59:59' WHERE Id = 789 AND AdAccountId = '123456789';

Delete

To remove a campaign group the Id and AdAccountId columns are required in the WHERE clause.

    DELETE FROM CampaignGroups WHERE Id = 789 AND AdAccountId = '123456789';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique numerical identifier assigned to the campaign group.
Account	String	False		Uniform Resource Name (URN) that identifies the advertising account associated with the campaign group. This value cannot be changed after creation.
Name	String	False		Descriptive name of the campaign group, used to identify and manage related campaigns within the account.
Status	String	False		Indicates the current operational status of the campaign group. The allowed values are ACTIVE, PENDING_DELETION, REMOVED, PAUSED, ARCHIVED, DRAFT, CANCELED.
TotalBudgetAmount	Decimal	False		Specifies the maximum total budget allocated for all campaigns within the campaign group.
TotalBudgetCurrencyCode	String	False		Currency code defined by the ISO that specifies the currency for the total budget. It must match the parent account's currency.
ScheduleStartTime	Datetime	False		Start date and time for when the campaign group becomes active and eligible to run associated campaigns.
ScheduleEndTime	Datetime	False		End date and time defining when the campaign group stops running associated campaigns.
Backfilled	Boolean	True		If the value is 'true', the campaign group was created to backfill pre-existing campaigns rather than being created organically.
AdAccountId	String	False		Unique identifier of the advertising account linked to the campaign group.
URN	String	True		URN that uniquely identifies the campaign group within LinkedIn Ads.

Retrieves campaigns in your LinkedIn Ads account by specified status, allowing performance tracking and campaign management.

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the Cloud.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Campaigns WHERE Status = 'ACTIVE'

SELECT * FROM Campaigns WHERE AdAccountId = '510013292'

CUD Operations

Insert

To create a new campaign there are some fields that are required in initial creation which are: Account, CampaignGroup, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, Status, Type, UnitCostAmount, UnitCostCurrency, AdAccountId.

While the following parameters are optional: AssociatedEntity, AudienceExpansionEnabled, CostType, CreativeSelection, ScheduleEndTime, ObjectiveType, ConnectedTelevisionOnly, TimeSpanDuration, TimeSpanUnit, Frequency, OptimizationType, OptimizationTargetType, BlockedIABCategories, AllowedPublisherRestrictionFiles, BlockedPublisherRestrictionFiles, PoliticalIntent.

     "INSERT INTO Campaigns ( Id, Account, CampaignGroup, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, ScheduleEndTime, Status, Type, UnitCostAmount, UnitCostCurrency, AdAccountId ) VALUES ( 'camp789', 'urn:li:sponsoredAccount:515218099', 'urn:li:sponsoredCampaignGroup:756063323', '150.00', 'USD', 'US', 'en', 'Spring Lead Generation 4', FALSE, '2025-07-01 09:00:00', '2025-07-31 23:59:59', 'DRAFT', 'TEXT_AD', '2.50', 'USD', '515218099' );"
 

Update

To modify an existing campaign group, use an UPDATE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: CampaignGroup, AssociatedEntity, AudienceExpansionEnabled, CostType, CreativeSelection, DailyBudgetAmount, DailyBudgetCurrency, Country, Language, Name, OffsiteDeliveryEnabled, ScheduleStartTime, ScheduleEndTime, Status, UnitCostAmount, UnitCostCurrency, ObjectiveType, TimeSpanDuration, TimeSpanUnit, Frequency, OptimizationType, OptimizationTargetType, BlockedIABCategories, AllowedPublisherRestrictionFiles, BlockedPublisherRestrictionFiles, PoliticalIntent.

     "UPDATE Campaigns SET Account = 'urn:li:sponsoredAccount:515218099', CampaignGroup = 'urn:li:sponsoredCampaignGroup:756063323', AssociatedEntity = 'urn:li:organization:101877555', AudienceExpansionEnabled = TRUE, CostType = 'CPM', CreativeSelection = 'OPTIMIZED', DailyBudgetAmount = '250.00', DailyBudgetCurrency = 'USD', Country = 'GB', Language = 'en', Name = 'Updated Campaign Name', OffsiteDeliveryEnabled = FALSE, ScheduleStartTime = '2025-07-15 09:00:00', ScheduleEndTime = '2025-08-15 18:00:00', Status = 'PAUSED', Type = 'SPONSORED_UPDATES', UnitCostAmount = '2.75', UnitCostCurrency = 'USD', ConnectedTelevisionOnly = TRUE, TimeSpanDuration = 7, TimeSpanUnit = 'DAY', Frequency = 3, OptimizationType = 'MAX_FREQUENCY', BlockedIABCategories = 'urn:li:iabCategory:IAB4-2,urn:li:iabCategory:IAB17-31', AllowedPublisherRestrictionFiles = 'urn:li:adPublisherFile:1359990,urn:li:adPublisherFile:1360990', BlockedPublisherRestrictionFiles = 'urn:li:adPublisherFile:1359991,urn:li:adPublisherFile:1361990' WHERE Id = '403469283' and AdAccountId = '515218099'"
 

Delete

To remove a campaign, use a DELETE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

 DELETE FROM Campaigns WHERE Id = 123456789 AND AdAccountId = '123456789';
 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique numerical identifier assigned to the campaign.
Account	String	False		Uniform Resource Name (URN) that identifies the advertising account associated with the campaign.
CampaignGroup	String	False		Numerical identifier of the campaign group that the campaign belongs to.
AssociatedEntity	String	False		URN that identifies a related object, with the specific meaning depending on the campaign type (for example, a creative or targeting entity).
AudienceExpansionEnabled	Boolean	False		Identifies whether or not Audience Expansion is enabled, allowing LinkedIn to broaden targeting by including members with similar attributes to the defined audience.
CostType	String	False		Specifies the campaign's pricing model: cost-per-click (CPC) or cost-per-impression (CPM). The allowed values are CPM, CPC, CPV.
CreativeSelection	String	False		Determines how creatives are rotated or prioritized. ROUND_ROBIN evenly rotates creatives, while OPTIMIZED favors those expected to perform better.
DailyBudgetAmount	String	False		Specifies the campaign's daily spending limit as a real number string.
DailyBudgetCurrency	String	False		Currency code defined by the ISO that specifies the currency for the daily budget.
Country	String	False		Specifies the country where the campaign is served, using an uppercase two-letter code defined by ISO 3166.
Language	String	False		Specifies the campaign language using a lowercase two-letter code defined by '.
Name	String	False		Name assigned to the campaign, used to identify it in reports and within the account.
OffsiteDeliveryEnabled	Boolean	False		Identifies whether or not the campaign is allowed to serve ads on the LinkedIn Audience Network beyond the LinkedIn platform.
ScheduleStartTime	Datetime	False		Start date and time when the campaign becomes active and eligible to serve ads.
ScheduleEndTime	Datetime	False		End date and time when the campaign is scheduled to stop serving ads.
Status	String	False		Indicates the current operational status of the campaign. The allowed values are ACTIVE, ARCHIVED, COMPLETED, CANCELED, DRAFT, PAUSED, PENDING_DELETION, REMOVED.
Type	String	False		Specifies the campaign type. The allowed values are TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC.
UnitCostAmount	String	False		Specifies the bid amount per click, impression, or other event, depending on the campaign's pricing model.
UnitCostCurrency	String	False		Specifies the currency used for the bid amount, matching the account's currency settings.
ObjectiveType	String	False		Defines the primary objective of the campaign. The allowed values are BRAND_AWARENESS, ENGAGEMENT, JOB_APPLICANTS, LEAD_GENERATION, WEBSITE_CONVERSIONS, WEBSITE_VISITS, VIDEO_VIEWS.
AdAccountId	String	False		Unique identifier of the advertising account linked to the campaign.
ConnectedTelevisionOnly	Boolean	False		Identifies whether or not the campaign is designated as a Connected Television (CTV)–only campaign, meaning ads are shown exclusively on connected TV devices.
TimeSpanDuration	Integer	False		Specifies the numerical duration value for the campaign's time span.
TimeSpanUnit	String	False		Specifies the time unit associated with the campaign's duration, such as days or weeks.
Frequency	Integer	False		Defines how many times a campaign's ad is shown to the same member within a given period.
OptimizationType	String	False		Specifies the optimization strategy applied to control ad frequency and performance.
OptimizationTargetType	String	False		Defines how the campaign is optimized for spending or outcomes. If not set, no optimization strategy is applied. The allowed values are NONE, ENHANCED_CONVERSION, TARGET_COST_PER_CLICK, TARGET_COST_PER_IMPRESSION, TARGET_COST_PER_VIDEO_VIEW, CAP_COST_AND_MAXIMIZE_CLICKS, CAP_COST_AND_MAXIMIZE_IMPRESSIONS, CAP_COST_AND_MAXIMIZE_VIDEO_VIEWS, MAX_REACH, MAX_LEAD, MAX_VIDEO_VIEW, MAX_CONVERSION, MAX_CLICK, MAX_IMPRESSION.
BlockedIABCategories	String	False		Lists Interactive Advertising Bureau (IAB) mobile application categories that are blocked from serving this campaign's ads off-network.
AllowedPublisherRestrictionFiles	String	False		Lists publisher restriction files that define which off-network sites are approved to serve the campaign's ads.
BlockedPublisherRestrictionFiles	String	False		Lists publisher restriction files that define which off-network sites are prohibited from serving the campaign's ads.
PoliticalIntent	String	False		The political intent of the campaign. The allowed values are NOT_DECLARED, NOT_POLITICAL, POLITICAL. The default value is NOT_DECLARED.

Provides data on user interactions with conversation ad creatives, including clicks and message-level engagement metrics.

Table Specific Information

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

Select

For the ConversationCreativeURN 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 ConversationCreativeActions WHERE ConversationCreativeURN = 'urn:li:sponsoredConversation:7069897';
SELECT * FROM ConversationCreativeActions WHERE ConversationCreativeURN IN ('urn:li:sponsoredConversation:7069897', 'urn:li:sponsoredConversation:5833860');

The rest of the query is processed client-side.

Insert

To insert a new conversation creative action, specify the ConversationCreativeURN along with the BodyContent and NextActions columns.

INSERT INTO ConversationCreativeActions (ConversationCreativeURN, BodyContent, NextActions) 
VALUES ('urn:li:sponsoredConversation:7932433', '{
     "text": "test conversation message"
  }', '{
    "options":[
      {
        "replyType": "SIMPLE_REPLY",
        "optionText": "Simple reply"
      }
    ]
  }');

Update

To modify an existing conversation creative action, use an UPDATE statement. Note that both the ConversationCreativeURN and URN columns are required in the WHERE clause.

UPDATE ConversationCreativeActions SET BodyContent = '{
   "text": "Updated text"
  }' 
WHERE ConversationCreativeURN = 'urn:li:sponsoredConversation:8584906' AND URN = 'urn:li:sponsoredMessageContent:(urn:li:sponsoredConversation:8584906,12219786)';

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		Uniform Resource Name (URN) that uniquely identifies the conversation creative action.
ConversationCreativeURN	String	False	ConversationCreatives.URN	URN that identifies the conversation creative associated with this action.
BodyContent	String	False		Contains the message content or body text of the conversation creative action, represented in JSON format.
NextActions	String	False		Specifies the next possible user actions that follow the current interaction, represented in JSON format.

Returns details of conversation ad creatives used in your LinkedIn Ads account, including creative content and configuration.

Table Specific Information

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

Select

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 ConversationCreatives WHERE URN = 'urn:li:sponsoredConversation:7069897';
SELECT * FROM ConversationCreatives WHERE URN IN ('urn:li:sponsoredConversation:5833860', 'urn:li:sponsoredConversation:7069897');

The rest of the query is processed client-side.

Insert

To create a new conversation creative, use an INSERT statement.

INSERT INTO ConversationCreatives (AccountURN, Headline) VALUES ('urn:li:sponsoredAccount:515215939', 'Test conversation')

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		Uniform Resource Name (URN) that uniquely identifies the conversation creative.
Headline	String	False		Headline text displayed in the conversation creative, typically introducing the message or offer.
FirstActionURN	String	True	ConversationCreativeActions.URN	URN that identifies the first action available to the target audience within the conversation creative.
AccountURN	String	False		URN that identifies the advertising account associated with this conversation creative.

Lists conversion events that represent valuable actions taken by users, such as form submissions or purchases, linked to your ads.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Conversions WHERE Account = '123456'

Insert

To create a new conversion tracking rule there are some fields that are required in initial creation which are: Account, Name, Type.

While the following parameters are optional: Amount, CurrencyCode, Enabled, PostClickAttributionWindowSize, ViewThroughAttributionWindowSize, AutoAssociationType.

    INSERT INTO Conversions ( Account, Name, Amount, CurrencyCode, Type, Enabled, PostClickAttributionWindowSize, ViewThroughAttributionWindowSize, AutoAssociationType ) VALUES ( 'urn:li:sponsoredAccount:12345', 'Lead Generation Form Submission', '50.00', 'USD', 'SUBMIT_APPLICATION', TRUE, 7, 7, 'OBJECTIVE_BASED' )

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique numerical identifier assigned to the conversion.
Account	String	False		Uniform Resource Name (URN) that identifies the advertising account associated with the conversion.
Name	String	False		Short, descriptive name for the conversion rule, displayed in the user interface and in reports.
Created	Datetime	True		Date and time when the conversion rule was originally created.
LastModified	Datetime	True		Date and time when the conversion rule was most recently updated.
LastCallbackAt	Datetime	True		Date and time when the most recent conversion callback event was received.
Amount	String	False		Specifies the monetary value associated with the conversion as a real number string.
CurrencyCode	String	False		Currency code representing the currency type used for the conversion value.
Type	String	False		Defines the type of conversion rule. The allowed values are ADD_TO_CART, DOWNLOAD, INSTALL, KEY_PAGE_VIEW, LEAD, PURCHASE, SIGN_UP, OTHER, SAVE, START_CHECKOUT, SCHEDULE, VIEW_CONTENT, VIEW_VIDEO, ADD_BILLING_INFO, BOOK_APPOINTMENT, REQUEST_QUOTE, SEARCH, SUBSCRIBE, AD_CLICK, AD_VIEW, COMPLETE_SIGNUP, SUBMIT_APPLICATION, PHONE_CALL, INVITE, LOGIN, SHARE, DONATE, ADD_TO_LIST, START_TRIAL, OUTBOUND_CLICK, CONTACT, QUALIFIED_LEAD.
Enabled	Boolean	False		If the value is 'true', the conversion rule is active and tracks conversions on the advertiser's website. If 'false', it is disabled.
ImagePixelTag	String	True		HTML code snippet representing the image pixel used to track conversion activity on the advertiser's website.
PostClickAttributionWindowSize	Integer	False		Specifies the time window, in days, during which a conversion is attributed to a user who clicked the ad.
ViewThroughAttributionWindowSize	Integer	False		Specifies the time window, in days, during which a conversion is attributed to a user who viewed (but did not click) the ad.
AutoAssociationType	String	False		Defines how campaigns are automatically associated with the conversion rule based on configuration settings. The allowed values are ALL_CAMPAIGNS, OBJECTIVE_BASED.

Retrieves ad creative details, including identifiers, campaign references, and statuses, to support creative management and optimization.

Table Specific Information

NOTE: The Account column is deprecated and will be removed in the next major version of the Cloud.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Id, Account, Campaign, and IntendedStatus columns. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Creatives WHERE Id = '179345687'

SELECT * FROM Creatives WHERE AdAccountId = '510013292'

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

SELECT * FROM Creatives WHERE Campaign = '198952936'

SELECT * FROM Creatives WHERE IntendedStatus = 'ACTIVE'

CUD Operations

Insert

To create a new advertising creative there are some fields that are required in initial creation which are: Campaign, Content, IntendedStatus, AdAccountId.

While the following parameters are optional: CallToActionLabel, CallToActionFormId, Name.

    INSERT INTO Creatives ( Campaign, Content, IntendedStatus, Name, AdAccountId ) VALUES ( 'urn:li:sponsoredCampaign:403027733', ' { \"reference\": \"urn:li:share:7346473724906237952\" }', 'DRAFT', 'Summer Campaign Main Creative', '515218099' );

Update

To modify an existing creative, use an UPDATE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

The following columns are the ones that are mutable after creation: Content, IntendedStatus, CallToActionLabel, CallToActionFormId, Name.

    UPDATE Creatives SET Campaign = 'urn:li:sponsoredCampaign:403027733', Name = 'Updated Summer Campaign Creative' WHERE Id = 'urn:li:sponsoredCreative:722532663' and AdAccountId = '515218099';

Delete

To remove a creative, use a DELETE statement. Note that the Id and AdAccountId columns are required in the WHERE clause.

    DELETE FROM Creatives WHERE Id = 'urn:li:sponsoredCreative:722492693' and AdAccountId = '515218099';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique numerical identifier assigned to the creative.
Account	String	True		Uniform Resource Name (URN) that identifies the advertising account associated with the creative.
Campaign	String	False		URN that identifies the campaign under which the creative is managed.
Content	String	False		Specifies the content promoted in the creative, such as text, image, or video assets.
CreatedAt	Datetime	True		Date and time when the creative was first created.
CreatedBy	String	True		Entity or user who originally developed and uploaded the creative.
IntendedStatus	String	False		Represents the user-defined intended status of the creative. The allowed values are ACTIVE, REMOVED, PENDING_DELETION, CANCELED, ARCHIVED, DRAFT, PAUSED.
IsServing	Boolean	True		If the value is 'true', the creative is currently being served in active campaigns; if 'false', it is not being delivered.
ServingHoldReasons	String	True		Lists all reasons why the creative is currently on hold and not serving, such as policy violations or budget constraints.
LastModifiedAt	Datetime	True		Date and time when the creative was last modified.
LastModifiedBy	String	True		Entity or user who last updated the creative.
ReviewStatus	String	True		Indicates the current moderation status of the creative, such as approved, rejected, or pending review.
IsTest	Boolean	True		If the value is 'true', the creative is designated as a test creative that belongs to a test campaign.
AdAccountId	String	False		Unique identifier of the advertising account linked to the creative.
CallToActionLabel	String	False		Text label displayed on the call-to-action (CTA) button, available only when the campaign objective is lead generation. The allowed values are APPLY, DOWNLOAD, VIEW_QUOTE, LEARN_MORE, SIGN_UP, SUBSCRIBE, REGISTER, REQUEST_DEMO, JOIN, ATTEND, UNLOCK_FULL_DOCUMENT.
CallToActionFormId	String	False	Forms.Id	Identifier of the lead generation form associated with the CTA button, available only for lead generation campaigns.
RejectionReasons	String	True		Comma-separated list of reasons explaining why the creative was rejected during the review process.
Name	String	False		Name assigned to the creative by the advertiser, used for easy identification and organization.

Retrieve and manage LinkedIn Data Management Platform (DMP) segments for B2B audience targeting and custom audience creation across ad exchanges.

Table Specific Information

Select

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

SELECT * FROM DMPSegments WHERE Id = '43318048';

SELECT * FROM DMPSegments WHERE AccountURN = 'urn:li:sponsoredAccount:518270328';

CUD Operations

Insert

To insert a new DMP segment, specify the Name, SourcePlatform, AccountURN, Type, and Destinations columns.

INSERT INTO DMPSegments (Name, SourcePlatform, AccountURN, Type, Destinations) 
VALUES ('DMP Segment Name', 'VIDEO_ADS', 'urn:li:sponsoredAccount:518270328', 'USER', '[
      {
         "destination":"LINKEDIN"
      }
   ]');

Update

To modify an existing DMP segment, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns can be updated: Name, Description, and SourceSegmentId.

UPDATE DMPSegments SET Name = 'DMPSegment Update', Description = 'Desc', SourceSegmentId = '159753' WHERE Id = '43318048';

Delete

To remove a DMP segment, use a DELETE statement. Note that the Id column is required in the WHERE clause.

DELETE FROM DMPSegments WHERE Id = 43333010;

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The DMP segment id.
AccountURN	String	False	Accounts.URN	The AccountURN of the DMP segment.
Name	String	False		The name of the DMP segment.
Description	String	False		The description of the DMP segment.
Type	String	False		The type of the DMP segment.
Destinations	Object	False		The destinations of the DMP segment.
SourcePlatform	String	False		The source platform of the DMP segment.
SourceSegmentId	String	False		The foreign key on the source platform. This is an optional field that will be indexed and can be used by the source platform to find their segments.

Retrieves forms owned by a specific account, including metadata and configuration details for LinkedIn Lead Gen Forms.

Table Specific Information

To use this view, the Account column must be specified in the criteria.

Select

For the Account column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. For example:

SELECT * FROM Forms WHERE Account = '512859024';
SELECT * FROM Forms WHERE Account IN ('512859024', '513009855');

When no criteria is specified, such as in this example:

SELECT * FROM Forms;

... we internally post-process the query as follows:

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

The rest of the query is processed client-side.

Insert

To create a new form, the following fields are required: Account, Headline, LandingPage, Message, Questions, Name, Country, Language, Status.

The following fields are optional: Description, PrivacyPolicy, LegalDisclaimer, HiddenFields.

    INSERT INTO Forms (
       Account,
       Description,
       Headline,
       LandingPage,
       LegalDisclaimer,
       Name,
       PrivacyPolicy,
       Country,
       Language,
       Status,
       Message,
       Questions ) VALUES (
       'urn:li:sponsoredAccount:512859024',
       'This is a sample form used for collecting leads.',
       'Join our newsletter!',
       'https://example.com/thank-you',
       'You agree to our terms and conditions.',
       'Sample Form Name',
       'https://example.com/privacy-policy',
       'us',
       'EN',
       'ARCHIVED',
       'This is a sample message.',
       '[
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"First Name\"
                       }
                   },
                   \"name\": \"firstName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"FIRST_NAME\"
               },
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"Last Name\"
                       }
                   },
                   \"name\": \"lastName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"LAST_NAME\"
               }
           ]' );

Update

To modify an existing form, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns are mutable after creation: Description, Headline, LandingPage, Message, LegalDisclaimer, Questions, Name, PrivacyPolicy, Country, Language, Status, HiddenFields.

    UPDATE Forms
    SET
       Description = 'New campaign form description.',
       Headline = 'Try our newest product!',
       LandingPage = 'https://example.com/new-landing',
       Message = 'Thank you for your interest! We will contact you soon.',
       LegalDisclaimer = 'By submitting this form you agree to our updated policies.',
       Questions = '[
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"First Name\"
                       }
                   },
                   \"name\": \"firstName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"FIRST_NAME\"
               },
               {
                   \"question\": {
                       \"localized\": {
                           \"en_US\": \"Last Name\"
                       }
                   },
                   \"name\": \"lastName\",
                   \"questionDetails\": {
                       \"textQuestionDetails\": {
                       }
                   },
                   \"predefinedField\": \"LAST_NAME\"
               }
           ]',
       Name = 'June 2025 LeadGen Form',
       PrivacyPolicy = 'https://example.com/privacy',
       Country = 'us',
       Language = 'EN',
       Status = 'DRAFT'
    WHERE
       Id = '13420673';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier assigned to the lead form.
Account	String	False	Accounts.Id	Identifier of the advertiser account that owns the lead form.
Created	Timestamp	True		Date and time when the form was initially created.
LastModified	Timestamp	True		Date and time when the form was last modified.
Description	String	False		Descriptive text explaining the purpose or content of the form, visible to both the owner and the viewer.
Headline	String	False		Headline text displayed at the top of the form, visible to both the owner and the viewer.
LandingPage	String	False		URL of the landing page where the viewer is redirected after submitting the form.
Message	String	False		Confirmation message shown to the member after the lead form is successfully submitted.
LegalDisclaimer	String	False		Advertiser-provided legal disclaimer displayed alongside the form to inform users about data use or consent.
Questions	String	False		List of questions used to collect information from the viewer. At least one question must be defined.
Name	String	False		Internal name of the form, visible only to the owner for identification and management purposes.
PrivacyPolicy	String	False		URL of the advertiser's privacy policy covering the handling of data collected through the form.
Country	String	False		Two-letter lowercase language code defined by ISO-639-1 representing the form's language setting.
Language	String	False		Two-letter uppercase country code defined by ISO 3166 representing the form's regional context.
ReviewStatus	String	True		Indicates the current review status of the lead form. The allowed values are AUTO_REJECTED, NEEDS_REVIEW, AUTO_APPROVED, PREAPPROVED, REJECTED, APPROVED, PENDING.
ReviewedAt	Timestamp	True		Date and time when the form's review status was last updated or initiated.
Status	String	False		Specifies the overall state of the lead form. Possible values are DRAFT, PUBLISHED, or ARCHIVED.
VersionTag	String	True		Indicates the version or number of times the form has been modified.
HiddenFields	String	False		Defines hidden fields used to track key form attributes, represented in JSON format for additional metadata storage.

Retrieves metadata for image assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information.

Table Specific Information

Select

For the AccountURN 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 AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM Images WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

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

For the two queries above, the values for the AccountURN, MediaLibraryName, and MediaLibraryStatus columns are not returned (always null).

When no criteria is specified as shown below:

SELECT * FROM Images;

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

SELECT * FROM Images WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Update

To modify an existing image, use an UPDATE statement. Note that the URN column and the AccountURN column are required in the WHERE clause.

The following columns are the ones that are changeable after creation:

• MediaLibraryName
• MediaLibraryStatus

UPDATE Images SET MediaLibraryName = 'My Test Image', MediaLibraryStatus = 'ARCHIVED' WHERE AccountURN = 'urn:li:sponsoredAccount:513009855' AND URN = 'urn:li:image:D4D10AQHqn3iVssgwvA'

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		Uniform Resource Name (URN) that uniquely identifies the image asset within LinkedIn.
AccountURN	String	True		URN that identifies the advertising account associated with the image asset.
MediaLibraryName	String	False		Display name of the image asset as it appears in the media library.
MediaLibraryStatus	String	False		Indicates the current status of the image asset in the media library, such as active or archived. The allowed values are ACTIVE, ARCHIVED.
OwnerURN	String	True		URN that identifies the entity or account that owns the image asset.
DownloadURL	String	True		URL used to download the image file from LinkedIn's asset library.
DownloadURLExpiresAt	Datetime	True		Date and time when the download URL for the image asset expires and is no longer valid.
Status	String	True		Represents the current processing or availability status of the image asset. The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

Provides details about message ad creatives in your LinkedIn Ads account, including content, delivery, and performance attributes.

Table Specific Information

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

Select

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 MessageCreatives WHERE URN = 'urn:li:adInMailContent:147611443';
SELECT * FROM MessageCreatives WHERE URN IN ('urn:li:adInMailContent:147611443', 'urn:li:adInMailContent:147551513', 'urn:li:adInMailContent:147581293');

The rest of the query is processed client-side.

Insert

To create a new message creative, use an INSERT statement.

The following columns are required for this operation:

• Name
• Subject
• BodyContent
• SubContent
• SenderURN
• AccountURN

INSERT INTO MessageCreatives (Name, Subject, BodyContent, FooterContent, SubContent, SenderURN, AccountURN) VALUES ('Message Ad 1', 'This is Message Ad 1', 'Message advertisement.', 'Terms and Conditions for Message Ad 1', '{"regular":{"rightRailAdPicture":"urn:li:image:D4D10AQGyoJMKvxNVFA","callToActionLandingPageUrl":"https://test.com","callToActionText":"Learn More"}}', 'urn:li:person:5a_yNKOQQe', 'urn:li:sponsoredAccount:512859024')

Update

To modify an existing message creative, use an UPDATE statement. Note that the URN column is required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Name
• Subject
• BodyContent
• FooterContent
• SubContent
• SenderURN

UPDATE MessageCreatives SET SenderURN = 'urn:li:person:0P8ph3huTC', Subject = 'My Message Ad 1', BodyContent = 'My Message Ad 1 body content.', SubContent = '{"regular":{"callToActionLandingPageUrl":"https://cloud.google.com/apigee?hl=en","callToActionText":"Learn More Here"}}', Name = 'My Message Ad 1', FooterContent = 'My Message Ad 1 footer content.' WHERE URN = 'urn:li:adInMailContent:148081693'

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		Uniform Resource Name (URN) that uniquely identifies the message creative.
Name	String	False		Display name of the message creative, used to identify it in the advertiser's account.
Subject	String	False		Subject line of the message creative, displayed to recipients in their LinkedIn inbox.
BodyContent	String	False		Main body of the message creative, formatted in HTML to include text, links, and visual elements.
FooterContent	String	False		Footer section of the message creative containing terms, conditions, or disclaimers displayed at the bottom of the message.
SubContent	String	False		Additional sub-content associated with the message creative, which varies depending on the advertiser's objective. It is represented in JSON format.
SenderURN	String	False		URN that identifies the LinkedIn member profile used as the sender of the message creative.
AccountURN	String	False		URN that identifies the advertising account associated with the message creative.
CreatedAt	Datetime	True		Date and time when the message creative was created.
UpdatedAt	Datetime	True		Date and time when the message creative was last updated.

Retrieves posts created for a LinkedIn organization, enabling content analysis and engagement tracking.

Table Specific Information

Select

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

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

• OrganizationId supports the '=' comparisons.

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

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

The following queries are processed server side:

SELECT * FROM Posts WHERE OrganizationId = '123456789'

Insert

To create a new post, the following fields are required: Author, Commentary, LifecycleState, Visibility, FeedDistribution.

The following fields are optional: Content, IsReshareDisabledByAuthor, ContentLandingPage, DirectSponsoredContentName, DirectSponsoredContentStatus.

    INSERT INTO Posts ( Author, Commentary, Content, IsReshareDisabledByAuthor, LifecycleState, Visibility, ContentLandingPage, DirectSponsoredContentName, DirectSponsoredContentStatus, FeedDistribution ) VALUES ( 'urn:li:organization:12345', 'This is a sample post commentary with important updates.', 'Sample content for the post', FALSE, 'DRAFT', 'PUBLIC', 'https://example.com/landing-page', 'Sample DSC Name', 'ACTIVE', 'MAIN_FEED' );

Update

To modify an existing post, use an UPDATE statement. Note that the Id column is required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Commentary
• LifecycleState
• DirectSponsoredContentName
• DirectSponsoredContentStatus

    UPDATE Posts SET Commentary = 'Updated post commentary with new information.' WHERE Id = 'post123456';

Delete

DELETE FROM Posts WHERE Id = 'post123456';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier assigned to the post.
Author	String	False		Identifier of the author who created the post, which can represent either a LinkedIn member or organization.
Commentary	String	False		User-generated commentary or text content included in the post.
Content	String	False		Main content of the post, which may include text, images, videos, or links.
CreatedAt	Datetime	True		Date and time when the post was originally created.
IsReshareDisabledByAuthor	Boolean	False		If the value is 'true', the post cannot be reshared because the author has disabled resharing.
LastModifiedAt	Datetime	True		Date and time when the post was last modified.
LifecycleState	String	False		Indicates the current lifecycle state of the post. The allowed values are DRAFT, PUBLISHED, PUBLISH_REQUESTED, PUBLISH_FAILED.
PublishedAt	Datetime	True		Date and time when the post was published and made visible to its audience.
Visibility	String	False		Defines the visibility settings of the post. The allowed values are CONNECTIONS, PUBLIC, LOGGED_IN, CONTAINER.
OrganizationId	String	True		Identifier of the organization that created or owns the post.
ContentLandingPage	String	False		URL of the landing page opened when a member clicks on the content associated with the post.
IsDirectSponsoredContent	Boolean	True		If the value is 'true', the post is classified as Direct Sponsored Content created for advertising purposes.
DirectSponsoredContentAdAccount	String	True		Identifier of the advertising account that created the Direct Sponsored Content.
DirectSponsoredContentAdType	String	True		Specifies the type of Direct Sponsored Content. The allowed values are VIDEO, STANDARD, CAROUSEL, JOB_POSTING, NATIVE_DOCUMENT, EVENT.
DirectSponsoredContentName	String	False		Plain-text name assigned to the Direct Sponsored Content post for identification purposes.
DirectSponsoredContentStatus	String	False		Indicates the current status of the Direct Sponsored Content. The allowed values are ACTIVE, ARCHIVED.
FeedDistribution	String	False		Specifies how the post is distributed, including whether it appears on LinkedIn feeds or external partner networks. The allowed values are MAIN_FEED, NONE.

Retrieves data about publisher restriction files that define which off-network sites are allowed or blocked for ad serving.

Table Specific Information

Select

For the AccountURN 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 PublisherRestrictionFiles WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM PublisherRestrictionFiles WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

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 PublisherRestrictionFiles WHERE Id = '1323992';
SELECT * FROM PublisherRestrictionFiles WHERE Id IN ('1323992', '1324991');

When no criteria is specified as shown below:

SELECT * FROM PublisherRestrictionFiles;

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

SELECT * FROM PublisherRestrictionFiles WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Insert

To create a new publisher restriction file, use an INSERT statement.

The following columns are required for this operation:

• Name
• RestrictionType
• MediaURN
• AccountURN

INSERT INTO PublisherRestrictionFiles (Name, RestrictionType, MediaURN, AccountURN) VALUES ('Test Blocklist 1', 'BLOCKLIST', 'urn:li:media:/AAYAAgDxAAQAAQAAAAAAAP1BmZKAq-knSwOe7fuAwqPpug.csv', 'urn:li:sponsoredAccount:512859024')

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier assigned to the publisher restriction file.
URN	String	True		Uniform Resource Name (URN) that uniquely identifies the publisher restriction file within LinkedIn.
Name	String	False		Name of the publisher restriction file, used for identification and reference.
RestrictionType	String	False		Specifies the type of restriction defined in the file. The allowed values are BLOCKLIST, ALLOWLIST.
MediaURN	String	False		URN that identifies the media asset containing the uploaded restriction file and its storage location.
Status	String	True		Indicates the current status of the restriction file, such as active, processing, or archived.
AccountURN	String	False		URN that identifies the advertising account in which the restriction file resides.
CreatedAt	Datetime	True		Date and time when the restriction file was created.
UpdatedAt	Datetime	True		Date and time when the restriction file was last updated.

Read and write saved audience targeting templates in your ad-accounts.

Table Specific Information

To learn more about the format of the JSON object in the TargetingCriteria column, refer to LinkedIn's API documentation.

Select

For the AccountURN 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 SavedAudienceTemplates WHERE AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM SavedAudienceTemplates WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

When no criteria are specified, as in the statement below:

SELECT * FROM SavedAudienceTemplates;

We internally post-process the query to the following before executing:

SELECT * FROM SavedAudienceTemplates WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Insert

To create a new record, use an INSERT statement.

The following columns are required for this operation:

• AccountURN
• Name
• TargetingCriteria

INSERT INTO SavedAudienceTemplates (AccountURN, Name, Description, TargetingCriteria) 
VALUES ('urn:li:sponsoredAccount:515565126', 'Saved Template 1', 'Saved Template 1', 
'{
  "include": {
    "and": [
      {
        "or": {
          "urn:li:adTargetingFacet:locations": [
            "urn:li:geo:90000034",
            "urn:li:geo:104079912"
          ]
        }
      },
      {
        "or": {
          "urn:li:adTargetingFacet:titles": [
            "urn:li:title:1",
            "urn:li:title:107"
          ]
        }
      }
    ]
  },
  "exclude": {
    "or": {
      "urn:li:adTargetingFacet:degrees": [
        "urn:li:degree:1000",
        "urn:li:degree:1100"
      ]
    }
  }
}');

Update

To modify a record, use an UPDATE statement. The Id column is required in the WHERE clause.

The following columns are the ones that are mutable after creation:

• Name
• Description
• TargetingCriteria

UPDATE SavedAudienceTemplates
SET Name = 'My Audience Template 1', Description = 'My Audience Template 1', TargetingCriteria = 
'{
  "include": {
    "and": [
      {
        "or": {
          "urn:li:adTargetingFacet:locations": [
            "urn:li:geo:90000033",
            "urn:li:geo:104079911"
          ]
        }
      },
      {
        "or": {
          "urn:li:adTargetingFacet:titles": [
            "urn:li:title:2",
            "urn:li:title:106"
          ]
        }
      }
    ]
  },
  "exclude": {
    "or": {
      "urn:li:adTargetingFacet:degrees": [
        "urn:li:degree:1000",
        "urn:li:degree:1100"
      ]
    }
  }
}' WHERE Id = '42481729';

Delete

To delete a record, use a DELETE statement. The Id column is required in the WHERE clause.

DELETE FROM SavedAudienceTemplates WHERE Id = '42481729'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The unique template identifier.
Name	String	False		The template name, max 100 characters.
Description	String	False		The template description, max 500 characters.
ApproximateReach	Long	True		The estimated number of targetable LinkedIn members.
TargetingCriteria	String	False		The targeting facets criteria matching the targeted audience. Represented in JSON format.
AccountURN	String	False		The URN of the associated ad-account in which the targeting template is saved at.
CreatedAt	Datetime	True		The timestamp when the template was created.
UpdatedAt	Datetime	True		The timestamp when the template was last modified.

Retrieves existing third-party tracking tags used to monitor conversions and engagement across external platforms.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria that refer to the Status column. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM ThirdPartyTracking WHERE Creative = '123456'

Insert

To create a new third-party tracking tag there are some fields that are required in initial creation which are: Creative, Event, Platform, TrackingUrl.

    INSERT INTO ThirdPartyTracking ( Creative, Event, Platform, TrackingUrl ) VALUES ( 'urn:li:sponsoredCreative:722479053', 'IMPRESSION', 'DOUBLECLICK', 'https://serverside.doubleclick.net/ddm/trackimp/N8480.281152LINKEDINUS/B20690748.213458830;dc_trk_aid=512607074;dc_trk_cid=107409144;ord=[timestamp];dc_lat=;dc_rdid=;tag_for_child_directed_treatment=?' );

Delete

To remove a third-party tracking tag from a creative, use a DELETE statement. Note that the Id column is required in the WHERE clause.

DELETE FROM ThirdPartyTracking WHERE Id = '722492693';

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Unique identifier assigned to the third-party tracking tag configuration.
Creative	String	False		Identifier of the ad creative associated with the third-party tracking tag.
Account	String	True		Uniform Resource Name (URN) that identifies the advertising account linked to the third-party tracking tag.
Event	String	False		Specifies the event being tracked. The allowed values are IMPRESSION, CLICK.
Platform	String	False		Indicates the third-party tracking platform or provider used for analytics and attribution. The allowed values are DOUBLECLICK.
TrackingUrl	String	False		URL endpoint used to track activity for the specified event through the third-party tracking system.
Created	Timestamp	True		Date and time when the third-party tracking tag configuration was created.
LastModified	Timestamp	True		Date and time when the third-party tracking tag configuration was last updated.

Retrieves metadata for video assets in your LinkedIn Ads account, including identifiers, upload details, and ownership information.

Table Specific Information

Select

For the AccountURN 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 AccountURN = 'urn:li:sponsoredAccount:512859024';
SELECT * FROM Videos WHERE AccountURN IN ('urn:li:sponsoredAccount:512859024', 'urn:li:sponsoredAccount:513009855')

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

For the two queries above, the values for the AccountURN, MediaLibraryName, and MediaLibraryStatus columns are not returned (always null).

When no criteria is specified as shown below:

SELECT * FROM Videos;

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

SELECT * FROM Videos WHERE AccountURN IN (SELECT URN FROM Accounts);

The rest of the query is processed client-side.

Update

To modify an existing image, use an UPDATE statement. Note that the URN column and the AccountURN column are required in the WHERE clause.

The following columns are the ones that are changeable after creation:

• MediaLibraryName
• MediaLibraryStatus

UPDATE Videos SET MediaLibraryName = 'My Test Video', MediaLibraryStatus = 'ARCHIVED' WHERE AccountURN = 'urn:li:sponsoredAccount:515278483' AND URN = 'urn:li:video:D4D10AQGLvWblHowYUw'

Columns

Name	Type	ReadOnly	References	Description
URN [KEY]	String	True		Uniform Resource Name (URN) that uniquely identifies the video asset within LinkedIn.
AccountURN	String	True		URN that identifies the advertising account associated with the video asset.
MediaLibraryName	String	False		Display name of the video asset as it appears in the media library.
MediaLibraryStatus	String	False		Indicates the current status of the video asset in the media library, such as active, processing, or archived. The allowed values are ACTIVE, ARCHIVED.
OwnerURN	String	True		URN that identifies the entity or organization that owns the video asset.
DownloadURL	String	True		URL used to download the video file from LinkedIn's media library.
DownloadURLExpiresAt	Datetime	True		Date and time when the download URL for the video asset expires and is no longer valid.
Status	String	True		Represents the current processing or availability status of the video asset. The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.
AspectRatioHeight	Decimal	True		Specifies the height component of the video's aspect ratio, used to maintain proper display proportions.
AspectRatioWidth	Decimal	True		Specifies the width component of the video's aspect ratio, used to maintain proper display proportions.
Duration	Long	True		Total duration of the video in milliseconds.
ThumbnailDownloadURL	String	True		URL used to download the thumbnail image associated with the video asset.
CaptionsDownloadURL	String	True		URL used to download caption files associated with the video asset.

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

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

CData Cloud - LinkedIn Marketing Solutions Views

Name	Description
AdFormResponses	Returns lead data collected through LinkedIn Lead Gen Forms, allowing you to analyze responses from forms owned by your organization.
Analytics	Delivers performance insights at the account, campaign, and creative levels, including metrics such as impressions, clicks, and engagement.
AudienceCount	Estimates the potential reach of your LinkedIn Ads campaigns based on defined targeting criteria, helping advertisers forecast audience size.
BudgetPricing	Provides bid and budget recommendations for campaigns, including minimum, maximum, and suggested bids based on your targeting parameters.
Degrees	Provides standardized degree data using LinkedIn's degree taxonomy to ensure consistency across educational targeting and reporting.
Documents	Retrieves metadata for document assets uploaded to your account, including identifiers, names, and ownership details.
EngagementRules	Manage LinkedIn engagement retargeting rules linking DMP segments to member engagements on specific content sources within a defined time frame.
FieldsOfStudy	Provides standardized field of study data using LinkedIn's taxonomy to maintain consistency across education-related targeting.
GeoLocations	Returns display names and related information for geographic identifiers (geo IDs) used in location-based targeting.
IABCategories	Provides access to standardized Interactive Advertising Bureau (IAB) categories used for audience and content classification.
Industries	Provides standardized industry data using LinkedIn's taxonomy to enable consistent targeting and analytics across campaigns.
JobFunctions	Retrieves standardized job function data through LinkedIn's taxonomy, ensuring consistent segmentation and targeting by function.
OrganizationRoleAssignments	Returns role-based access information for organizations the user is associated with, supporting permissions and governance.
Seniorities	Provides standardized seniority data using LinkedIn's taxonomy to maintain consistency across audience targeting segments.
Skills	Returns standardized skill data from LinkedIn's taxonomy, supporting targeting and reporting based on member skills.
SocialActions	Provides access to engagement data, including likes, comments, and shares, for both personal and organizational posts.
TargetingEntities	Returns details about available LinkedIn Ads targeting entities, such as companies, job titles, and industries.
TargetingFacets	Provides metadata about LinkedIn Ads targeting facets, defining the dimensions available for building audience segments.
Titles	Provides standardized job title data through LinkedIn's taxonomy to support accurate audience targeting and reporting.

Returns lead data collected through LinkedIn Lead Gen Forms, allowing you to analyze responses from forms owned by your organization.

Table Specific Information

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');

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');

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	References	Description
Id [KEY]	String		Unique identifier assigned to each submitted form response.
Account	String	Accounts.Id	Identifier of the advertiser account that owns the lead form associated with this response.
Campaign	String		Uniform Resource Name (URN) that identifies the campaign connected to the form response, linking the lead data to its campaign source.
Creative	String		URN that identifies the ad creative associated with the form response, indicating which ad generated the lead.
Form	String		URN that identifies the specific lead form to which this response belongs.
SubmitedAt	Datetime		Date and time when the form response was submitted by the user.
LeadType	String		Specifies the type of lead, indicating whether it was collected from sponsored content or through organic sharing. The default value is 'SPONSORED'.
TestLead	Boolean		Identifies whether or not the lead represents a test submission used for validation or form setup purposes.
ConsentResponses	String		Stores consent-related details as a JSON object, capturing responses to consent questions.
Answers	String		Stores the respondent's answers and corresponding questions in a JSON object for lead data analysis.

Delivers performance insights at the account, campaign, and creative levels, including metrics such as impressions, clicks, and engagement.

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

Dimensions

Analytics reports provide performance metrics that help evaluate and optimize campaigns. They also require certain mandatory dimensions to be defined. At a minimum, you must specify:

• ReportStartTime
• Granularity

Additionally, there are optional dimensions that can be included to refine the report. For example:

• ReportEndTime
• CampaignType

The dimensions available depend on the value of FinderMethod, which can be either Analytics or Statistics. This setting defines which dimensions are required, which optional dimensions are available, and how filters and metrics can be combined in the query.

• If FinderMethod = Analytics (default), then you may select up to 1 dimension (default: Campaign) from the following options: Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, CardIndex, MemberCompanySize, MemberIndustry, MemberSeniority, MemberJobTitle, MemberJobFunction, MemberCountry, MemberRegion, or MemberCompany.
• If FinderMethod = Statistics, then you may select up to 2 dimensions (default: Campaign) from the following options: Company, Account, Share, Campaign, CampaignGroup, Creative, Conversion, ServingLocation, or CardIndex.

Metrics

Analytics reports need at least one metric specified, such as Engagement or Conversions, to track campaign performance.

The metrics include:

Impression & Reach Metrics

• Impressions, CardImpressions, ApproximateMemberReach, AverageDailyReachMetricsApproximateReach, AverageDailyReachMetricsApproximateFrequency, AverageDailyReachMetricsApproximateCost, AveragePreviousSevenDayReachMetricsApproximateReach, AveragePreviousSevenDayReachMetricsApproximateFrequency, AveragePreviousSevenDayReachMetricsApproximateCost,
  AveragePreviousThirtyDayReachMetricsApproximateReach, AveragePreviousThirtyDayReachMetricsApproximateFrequency, AveragePreviousThirtyDayReachMetricsApproximateCost

Click Metrics

• Clicks, ActionClicks, AdUnitClicks, LandingPageClicks, CardClicks, TextUrlClicks, DownloadClicks

Engagement Metrics

• Likes, Shares, Comments, CommentLikes, Follows, Opens, TotalEngagements, OtherEngagements, CompanyPageClicks

Video Metrics

• VideoStats, VideoViews, VideoCompletions, VideoFirstQuartileCompletions, VideoMidpointCompletions, VideoThirdQuartileCompletions, FullScreenPlays

Viral Metrics

• ViralClicks, ViralImpressions, ViralLikes, ViralShares, ViralComments, ViralTotalEngagements, ViralCompanyPageClicks, ViralLandingPageClicks, ViralOtherEngagements, ViralFullScreenPlays, ViralVideoStarts, ViralVideoViews, ViralVideoCompletions, ViralVideoFirstQuartileCompletions, ViralVideoMidpointCompletions, ViralVideoThirdQuartileCompletions, ViralExternalWebsiteConversions, ViralExternalWebsitePostClickConversions, ViralExternalWebsitePostViewConversions, ViralFollows, ViralOneClickLeadFormOpens, ViralOneClickLeads, ViralCardClicks, ViralCardImpressions

Conversion & Lead Metrics

• ExternalWebsiteConversions, ExternalWebsitePostClickConversions, ExternalWebsitePostViewConversions, PostClickRegistrations, PostViewRegistrations, OneClickLeadFormOpens, OneClickLeads, QualifiedLeads, ValidWorkEmailLeads, LeadGenerationMailContactInfoShares, LeadGenerationMailInterestedClicks, ConversionValueInLocalCurrency

Cost Metrics

• CostInLocalCurrency, CostInUsd, CostPerQualifiedLead

Other Metrics

• MessagingAdvertSendCount, MessagingAdvertOpenCount, DocumentCompletions, AudiencePenetration, AverageDwellTime

Filters

Filters refine which data is returned in the report and must be valid. If no explicit filters are specified, the report will filter on all the accounts that belong to the user.

The valid filters include:

• Account
• Campaign
• Creative

The Analytics table requires a query structure based on the FinderMethod and the selected Dimensions, Filters, and Metrics. For example:

If FinderMethod = Analytics (only required dimensions + 1 filter + 1 metric):

SELECT ReportStartTime, Granularity, Clicks
FROM Analytics
WHERE FinderMethod = 'Analytics'
  AND ReportStartTime = '2024-08-01'
  AND Granularity = 'MONTHLY'
  AND Account = '123456789';

If FinderMethod = Analytics (required + optional dimensions + multiple metrics and filters):

SELECT ReportStartTime, ReportEndTime, Granularity, CampaignType, Clicks, Impressions, TotalEngagements
FROM Analytics
WHERE FinderMethod = 'Analytics'
  AND ReportStartTime = '2024-08-01'
  AND ReportEndTime = '2024-08-31'
  AND Granularity = 'MONTHLY'
  AND CampaignType = 'SponsoredContent'
  AND Campaign = '987654321';

If FinderMethod = Statistics (required + 2 optional dimensions + multiple metrics):

SELECT ReportStartTime, Granularity, Campaign, Creative, Impressions, Follows
FROM Analytics
WHERE FinderMethod = 'Statistics'
  AND ReportStartTime = '2024-08-01'
  AND Granularity = 'MONTHLY'
  AND Campaign = '987654321'
  AND Creative = '555888999';

Columns

Name	Type	References	Description
Company	String		Groups the analytics results by the advertiser company associated with the campaign data.
Account	String		Groups the analytics results by the advertising account.
Share	String		Groups the analytics results by the sponsored share that generated engagement.
Campaign	String		Groups the analytics results by campaign to enable campaign-level performance analysis.
Creative	String		Groups the analytics results by creative asset to measure individual ad performance.
CampaignGroup	String		Groups the analytics results by campaign group for aggregated reporting.
Conversion	String		Groups the analytics results by conversion type to analyze performance by conversion action.
ServingLocation	String		Groups the analytics results by the ad's serving location, such as LinkedIn feed or partner network.
CardIndex	String		Groups the analytics results by the index of each carousel card to measure engagement by card.
MemberCompanySize	String		Groups the analytics results by the company size of the engaged member.
MemberIndustry	String		Groups the analytics results by the member's industry, based on LinkedIn profile data.
MemberSeniority	String		Groups the analytics results by the seniority level of the engaged member.
MemberJobTitle	String		Groups the analytics results by the job title of the engaged member.
MemberJobFunction	String		Groups the analytics results by the job function of the engaged member.
MemberCountry	String		Groups the analytics results by the member's country.
MemberRegion	String		Groups the analytics results by the member's region.
MemberCounty	String		Groups the analytics results by the member's county.
MemberCompany	String		Groups the analytics results by the company where the engaged member works.
PlacementName	String		Groups the analytics results by placement name, representing where the ad appeared.
ImpressionDeviceType	String		Groups the analytics results by the device type used to view the ad.
CampaignType	String		Groups the analytics results by campaign type for comparative performance insights. The allowed values are TEXT_AD, SPONSORED_UPDATES, SPONSORED_INMAILS, DYNAMIC.
Granularity	String		Specifies the time granularity of results. The allowed values are DAILY, MONTHLY, YEARLY, ALL. The default value is MONTHLY.
FinderMethod	String		Identifies the query method used to retrieve analytics data. Supported values are 'analytics' and 'statistics'. The allowed values are analytics, statistics. The default value is analytics.
ReportStartTime	String		Specifies the start date and time for the reporting period.
ReportEndTime	String		Specifies the end date and time for the reporting period.
EventStage	String		Groups results by stage of a live event to analyze engagement throughout the event lifecycle.
ActionClicks	Long		Number of clicks on the action button within Sponsored InMail messages.
AdUnitClicks	Long		Number of clicks on the ad unit displayed alongside a Sponsored InMail message.
CardClicks	Long		Number of clicks received by individual cards within a carousel ad.
CardImpressions	Long		Number of impressions shown for each card in a carousel ad.
Clicks	Long		Total number of chargeable clicks recorded for the ad.
CommentLikes	Long		Number of likes on comments associated with the ad.
Comments	Long		Number of comments posted in response to the ad.
CompanyPageClicks	Long		Number of clicks to view the advertiser's LinkedIn company page.
ConversionValueInLocalCurrency	Decimal		Total conversion value in the account's local currency, calculated according to advertiser-defined rules.
CostInLocalCurrency	Decimal		Total advertising cost in the account's local currency, aggregated by pivot and time granularity.
CostInUsd	Decimal		Total advertising cost in USD, aggregated by pivot and time granularity.
UsageStartTime	String		Start date for the period covered by the data point.
UsageEndTime	String		End date for the period covered by the data point.
ExternalWebsiteConversions	Long		Number of conversions recorded on an external advertiser website through pixel tracking.
ExternalWebsitePostClickConversions	Long		Number of post-click conversions recorded on an external advertiser website through pixel tracking.
ExternalWebsitePostViewConversions	Long		Number of post-view conversions recorded on an external advertiser website through pixel tracking.
Follows	Long		Number of new followers gained through sponsored content.
FullScreenPlays	Long		Number of times a user tapped a video to enter full-screen viewing mode.
Impressions	Long		Total number of impressions for Direct Ads and Sponsored Updates, or 'sends' for InMail campaigns.
LandingPageClicks	Long		Number of clicks that directed users to the creative's landing page.
LeadGenerationMailContactInfoShares	Long		Number of times a user shared their contact information through a one-click Lead Gen form in Sponsored InMail.
LeadGenerationMailInterestedClicks	Long		Number of clicks indicating user interest in a Sponsored InMail lead generation message.
Likes	Long		Total number of likes received on the ad.
OneClickLeadFormOpens	Long		Number of times users opened a one-click Lead Gen form during a campaign.
OneClickLeads	Long		Number of leads generated through one-click Lead Gen submissions.
Opens	Long		Number of times Sponsored InMail messages were opened by recipients.
OtherEngagements	Long		Number of user interactions with the ad that do not fall into other defined engagement types.
Shares	Long		Number of times the ad was shared by users.
TextUrlClicks	Long		Number of clicks on text links included within the body of Sponsored InMail messages.
TotalEngagements	Long		Total number of user interactions with the ad unit across all engagement types.
VideoCompletions	Long		Number of video ads that played at least 97–100% of their duration.
VideoFirstQuartileCompletions	Long		Number of video ads that played through the first 25% of their duration.
VideoMidpointCompletions	Long		Number of video ads that played through 50% of their duration.
VideoStarts	Long		Number of times users started playing a video ad.
VideoThirdQuartileCompletions	Long		Number of video ads that played through 75% of their duration.
VideoViews	Long		Number of video ads viewed for at least two continuous seconds while 50% visible, or when a call-to-action (CTA) click occurs first.
ViralCardClicks	Long		Number of clicks on viral carousel cards that spread through organic sharing.
ViralCardImpressions	Long		Number of viral impressions shown for each card in a carousel ad.
ViralClicks	Long		Number of clicks on viral impressions generated by organic distribution.
ViralComments	Long		Number of comments originating from viral impressions of this ad.
ViralCompanyPageClicks	Long		Number of clicks to view the advertiser's company page from viral impressions.
ViralExternalWebsiteConversions	Long		Number of conversions on external websites driven by viral impressions.
ViralExternalWebsitePostClickConversions	Long		Number of post-click conversions on external websites driven by viral engagement.
ViralExternalWebsitePostViewConversions	Long		Number of post-view conversions on external websites driven by viral engagement.
ViralFollows	Long		Number of followers gained through viral impressions.
ViralFullScreenPlays	Long		Number of times users opened a viral video in full-screen mode.
ViralImpressions	Long		Total number of viral impressions generated by organic sharing.
ViralLandingPageClicks	Long		Number of clicks on viral impressions that led users to the ad's landing page.
ViralLikes	Long		Number of likes generated from viral impressions.
ViralOneClickLeadFormOpens	Long		Number of times users opened a lead form through viral impressions in a Lead Gen campaign.
ViralOneClickLeads	Long		Number of leads generated through one-click Lead Gen submissions from viral impressions.
ViralOtherEngagements	Long		Number of user interactions with viral impressions not categorized elsewhere.
ViralShares	Long		Number of shares generated from viral impressions.
ViralTotalEngagements	Long		Total number of user interactions recorded for viral ad units.
ViralVideoCompletions	Long		Number of viral video ads that played at least 97–100% of their duration.
ViralVideoFirstQuartileCompletions	Long		Number of viral video ads that played through the first 25% of their duration.
ViralVideoMidpointCompletions	Long		Number of viral video ads that played through 50% of their duration.
ViralVideoStarts	Long		Number of times users started playing a viral video ad.
ViralVideoThirdQuartileCompletions	Long		Number of viral video ads that played through 75% of their duration.
ViralVideoViews	Long		Number of viral video ads viewed for at least two continuous seconds while 50% visible, or when a CTA click occurs first.
AverageDailyReachMetricsApproximateReach	Decimal		Average daily reach, representing unique member accounts with at least one impression per day.
AverageDailyReachMetricsApproximateFrequency	Decimal		Average number of impressions shown per member account reached per day.
AverageDailyReachMetricsApproximateCost	Decimal		Average daily advertising spend per 1,000 member accounts reached.
AveragePreviousSevenDayReachMetricsApproximateReach	Decimal		Average reach for the previous 7 days, representing unique member accounts with at least one impression.
AveragePreviousSevenDayReachMetricsApproximateFrequency	Decimal		Average number of impressions shown per member account reached over the last 7 days.
AveragePreviousSevenDayReachMetricsApproximateCost	Decimal		Average advertising spend per 1,000 member accounts reached during the last 7 days.
AveragePreviousThirtyDayReachMetricsApproximateReach	Decimal		Average reach for the previous 30 days, representing unique member accounts with at least one impression.
AveragePreviousThirtyDayReachMetricsApproximateFrequency	Decimal		Average number of impressions shown per member account reached over the last 30 days.
AveragePreviousThirtyDayReachMetricsApproximateCost	Decimal		Average advertising spend per 1,000 member accounts reached during the last 30 days.
ApproximateMemberReach	Long		Estimated number of unique member accounts with at least one impression, available for reporting periods up to 92 days and excluding the current UTC day.
ValidWorkEmailLeads	Long		Number of leads containing a valid work email address that does not belong to a free or personal domain.
PostClickRegistrations	Decimal		Number of event or seminar registrations completed after a user clicked an ad with a LinkedIn landing page.
PostViewRegistrations	Decimal		Number of event or seminar registrations completed after a user viewed an ad with a LinkedIn event landing page.
DownloadClicks	Long		Number of times users clicked the download icon in an ad to indicate intent to download media or content.
QualifiedLeads	Long		Number of qualified leads determined by the advertiser as having a higher likelihood of becoming customers based on engagement and fit.
CostPerQualifiedLead	Decimal		Average cost spent per qualified lead, calculated as cost in local currency divided by number of qualified leads.
MessagingAdvertSendCount	Long		Number of Sponsored Messaging ads sent to recipients.
MessagingAdvertOpenCount	Long		Number of Sponsored Messaging ads opened by recipients.
AudiencePenetration	Decimal		Ratio of unique members reached to the total target audience size. Available only for date ranges up to 92 days and supported for the 'CAMPAIGN' pivot with 'MONTHLY' granularity excluded.
AverageDwellTime	Long		Average time in seconds that more than 50% of an ad's pixels remained visible on screen, indicating user attention duration.
DocumentCompletions	Long		Number of times users viewed 100% of a document's length, including those who skipped directly to the end.

Estimates the potential reach of your LinkedIn Ads campaigns based on defined targeting criteria, helping advertisers forecast audience size.

Table Specific Information

Select

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

The Cloud uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Cloud processes other filters client-side within the Cloud. 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	References	Description
ActiveAudience	Integer		Represents the count of active LinkedIn members matching the specified targeting criteria.
TotalAudience	Integer		Represents the total number of LinkedIn members that meet the defined targeting parameters, regardless of recent activity.

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		Specifies the age ranges used to match against members. Supported values: (18, 24), (25, 34), (35, 54), (55, 2147483647).
DegreeId	String		Specifies the educational degrees attained by members to use for targeting.
FieldOfStudyId	String		Specifies the fields of study to target, matched against those listed in members' profiles.
Gender	String		Defines the gender-based targeting criteria. Supported values: MALE, FEMALE.
IndustryId	String		Specifies the industries to target, based on members' current or past roles.
JobFunctionId	String		Defines the top-level job functions to target, representing groupings of related job titles.
LocationId	String		Specifies the geographic locations to include in audience targeting.
ProfileLocationId	String		Specifies member profile locations for targeting, similar to LocationId but based on a member's listed profile location.
SeniorityId	String		Defines the seniority levels to target, such as entry-level, manager, or director.
SkillId	String		Specifies the skills to target, matched against those listed on members' profiles.
StaffCountRange	String		Defines the organization size range to target. Supported values: (1, 1), (2, 10), (11, 50), (51, 200), (201, 500), (501, 1000), (1001, 5000), (5001, 10000), (10001, 2147483647).
TitleId	String		Specifies the job titles to target, matched against members' current titles.
AudienceMatchingSegmentId	String		Identifies an ad segment composed of specific entities, such as members or companies. It is used for audience matching.
RetargetingSegmentId	String		Identifies an ad segment composed of entities previously engaged with your ads. It is used for retargeting campaigns.
EmployerId	String		Specifies the employer identifier to match against companies listed in members' profiles.
CompanyId	String		Specifies the company identifier to target, matched against companies listed in members' profiles.
InterfaceLocaleId	String		Specifies the locale identifier to target, matched against members' preferred language or regional settings.

Provides bid and budget recommendations for campaigns, including minimum, maximum, and suggested bids based on your targeting parameters.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. You can combine the following filters also in a single search. The Cloud processes other filters client-side within the Cloud. 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	References	Description
SuggestedBidDefault	String		Represents the suggested bid amount recommended for a given campaign setup.
SuggestedBidMin	String		Indicates the lower end of the suggested bid range for the selected targeting criteria.
SuggestedBidMax	String		Indicates the upper end of the suggested bid range for the selected targeting criteria.
DailyBudgetLimitsDefault	String		Specifies the default daily budget amount recommended by LinkedIn Ads.
DailyBudgetLimitsMin	String		Specifies the minimum allowable daily budget for the campaign.
DailyBudgetLimitsMax	String		Specifies the maximum allowable daily budget for the campaign.
BidLimitsMax	String		Defines the maximum bid amount permitted for the selected campaign type or bidding strategy.
BidLimitsMin	String		Defines the minimum bid amount allowed, also referred to as the floor price.
Account	String		Uniform Resource Name (URN) that identifies the advertising account associated with the budget or pricing configuration.
CampaignType	String		Specifies the type of campaign. The allowed values are TEXT_AD, SPONSORED_UPDATES. The default value is TEXT_AD.
BidType	String		Defines the bidding method used for the campaign. The allowed values are CPM, CPC, CPV. The default value is CPM.
MatchType	String		Specifies the targeting match type used to determine how closely audience attributes must align with defined criteria. The allowed values are EXACT, AUDIENCE_EXPANDED. 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		Defines the age ranges used for audience targeting. Supported values: (18, 24), (25, 34), (35, 54), (55, 2147483647).
DegreeId	String		Specifies the educational degrees attained by members for use in audience targeting.
FieldOfStudyId	String		Defines the academic fields of study to target, based on members' profile information.
Gender	String		Specifies gender-based audience targeting criteria. Supported values: MALE, FEMALE.
IndustryId	String		Defines the industries to target based on members' professional backgrounds.
JobFunctionId	String		Specifies the job functions to target, representing broad categories of professional roles.
LocationId	String		Defines the geographic locations to include in audience targeting.
ProfileLocationId	String		Specifies member profile locations for targeting, similar to LocationId but based on a member's listed profile location.
SeniorityId	String		Specifies the seniority levels to target, such as entry-level, manager, or executive.
SkillId	String		Defines the professional skills to target, matched against those listed in members' profiles.
StaffCountRange	String		Defines the organization size range to target. Supported values: (1, 1), (2, 10), (11, 50), (51, 200), (201, 500), (501, 1000), (1001, 5000), (5001, 10000), (10001, 2147483647).
TitleId	String		Specifies the job titles to target, matched against members' current titles.
AudienceMatchingSegmentId	String		Identifies an ad segment consisting of specific entities, such as members or companies, used for audience matching.
RetargetingSegmentId	String		Identifies an ad segment composed of entities previously engaged with your ads, used for retargeting campaigns.
EmployerId	String		Specifies the employer identifier to match against companies listed in members' profiles.
CompanyId	String		Specifies the company identifier to target, matched against companies listed in members' profiles.
InterfaceLocaleId	String		Defines the locale identifier to target, matched against members' preferred language or regional settings.

Provides standardized degree data using LinkedIn's degree taxonomy to ensure consistency across educational targeting and reporting.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Degrees

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized degree entry.
URN	String		Uniform Resource Name (URN) that uniquely identifies the standardized degree within LinkedIn's taxonomy.
Name	String		Localized display name of the degree, represented as a MultiLocaleString type supporting multiple languages.

Retrieves metadata for document assets uploaded to your account, including identifiers, names, and ownership details.

Table Specific Information

Select

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

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

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

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
URN [KEY]	String		Uniform Resource Name (URN) that uniquely identifies the document asset within LinkedIn.
OwnerURN	String		URN that identifies the entity or account that owns the document asset.
DownloadURL	String		URL that provides access to download the document file.
DownloadURLExpiresAt	Datetime		Date and time when the document's download URL expires and becomes inaccessible.
Status	String		Indicates the current processing or availability status of the document asset. The allowed values are PROCESSING, PROCESSING_FAILED, AVAILABLE, WAITING_UPLOAD.

Manage LinkedIn engagement retargeting rules linking DMP segments to member engagements on specific content sources within a defined time frame.

Table Specific Information

Select

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

SELECT * FROM EngagementRules WHERE Id = '12345';

SELECT * FROM EngagementRules WHERE DMPSegmentId = '43318048';

Columns

Name	Type	References	Description
Id [KEY]	Long		The engagement rule id.
DMPSegmentId	Long	DMPSegments.Id	The DMP segment id that this engagement retargeting rule belongs.
EngagementSource	String		The content URN that members are engaging with.
EngagementTrigger	String		The action that users can take on the source.
TimeFrame	Object		The time frame members engaged with the specified source URN with the specified engagement trigger.
CreatedAt	Datetime		Date and time when the engagement rule was first created.
UpdatedAt	Datetime		Date and time when the engagement rule was last modified.

Provides standardized field of study data using LinkedIn's taxonomy to maintain consistency across education-related targeting.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM FieldsOfStudy

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized field of study entry.
URN	String		Uniform Resource Name (URN) that uniquely identifies the standardized field of study within LinkedIn's taxonomy.
Name	String		Localized display name of the field of study, represented as a MultiLocaleString type supporting multiple languages.

Returns display names and related information for geographic identifiers (geo IDs) used in location-based targeting.

Table Specific Information

To use this view, the Id column must be specified in the criteria.

Select

For The Id column, the = operator is fully supported server-side. The IN operator is partially supported server-side and partially client-side. For example:

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	References	Description
Id [KEY]	String		Unique identifier assigned to the geographic location.
Name	String		Display name of the location as shown within LinkedIn Ads targeting options.
LocaleCountry	String		Two-letter uppercase country code defined by ISO 3166 representing the country of the location.
LocaleLanguage	String		Two-letter lowercase language code defined by ISO 639 representing the language associated with the location.

Provides access to standardized Interactive Advertising Bureau (IAB) categories used for audience and content classification.

Table Specific Information

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 IABCategories WHERE Id = 'IAB9-30';
SELECT * FROM IABCategories WHERE Id IN ('IAB9-30', 'IAB17-21');

The rest of the query is processed client-side.

Columns

Name	Type	References	Description
Id [KEY]	String		Unique identifier assigned to the IAB category.
URN	String		Uniform Resource Name (URN) that uniquely identifies the IAB category within LinkedIn's taxonomy.
Name	String		Display name of the IAB category in the 'en_US' locale.
IABName	String		Original name of the IAB category as defined in the Open Real-Time Bidding (OpenRTB) 2.3 specification.
ParentId	String	IABCategories.Id	Unique identifier of the parent IAB category, used to establish category hierarchy.

Provides standardized industry data using LinkedIn's taxonomy to enable consistent targeting and analytics across campaigns.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Industries

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized industry entry.
URN	String		Uniform Resource Name (URN) that uniquely identifies the standardized industry within LinkedIn's taxonomy.
Name	String		Localized display name of the industry, represented as a MultiLocaleString type supporting multiple languages.
ChildrenIndustries	String		List of URNs representing child industries related to this industry node within the hierarchy.
ParentIndustries	String		List of URNs representing parent industries associated with this industry node within the hierarchy.

Retrieves standardized job function data through LinkedIn's taxonomy, ensuring consistent segmentation and targeting by function.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM JobFunctions

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized job function entry.
URN	String		Uniform Resource Name (URN) that uniquely identifies the standardized job function within LinkedIn's taxonomy.
Name	String		Localized display name of the job function, represented as a MultiLocaleString type supporting multiple languages.

Returns role-based access information for organizations the user is associated with, supporting permissions and governance.

Columns

Name	Type	References	Description
OrganizationURN [KEY]	String		Uniform Resource Name (URN) that uniquely identifies the organization within LinkedIn.
MemberURN [KEY]	String		URN that uniquely identifies the LinkedIn member assigned a specific organizational role.
Role [KEY]	String		Specifies the role granted to the member for managing or administering the organization. The allowed values are ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, RECRUITING_POSTER, LEAD_CAPTURE_ADMINISTRATOR, LEAD_GEN_FORMS_MANAGER, ANALYST, CURATOR, CONTENT_ADMINISTRATOR.
State	String		Indicates the current state of the role assignment. The allowed values are APPROVED, REJECTED, REQUESTED, REVOKED.

Provides standardized seniority data using LinkedIn's taxonomy to maintain consistency across audience targeting segments.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Seniorities

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized seniority entry.
URN	String		Uniform Resource Name (URN) that uniquely identifies the standardized seniority within LinkedIn's taxonomy.
Name	String		Localized display name of the seniority level, represented as a MultiLocaleString type supporting multiple languages.

Returns standardized skill data from LinkedIn's taxonomy, supporting targeting and reporting based on member skills.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Skills

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized skill entry.
Name	String		Localized display name of the skill, represented as a MultiLocaleString type supporting multiple languages.

Provides access to engagement data, including likes, comments, and shares, for both personal and organizational posts.

Select

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

• 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	References	Description
TotalFirstLevelComments	Integer		Total number of first-level comments directly made on the post.
AggregatedTotalComments	Integer		Total number of comments on the post, including both first-level and nested replies.
LikedByCurrentUser	Boolean		If the value is 'true', the current user has liked the post; if 'false', they have not.
TotalLikes	Integer		Total number of likes the post has received from all users.
Target	String		Identifier of the post, article, or entity on which the social action was performed.
UGCPostId	String	Posts.Id	Unique identifier of the user-generated content (UGC) post associated with the social action data.

Returns details about available LinkedIn Ads targeting entities, such as companies, job titles, and industries.

Table Specific Information

Select

To read data from this view, some conditions must be specified in the criteria of the statement, depending on your use case.

1. Read all ad-targeting entities in a specific ad-targeting facet by using the AD_TARGETING_FACET finder:

SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:titles';
SELECT * FROM TargetingEntities WHERE FacetURN IN ('urn:li:adTargetingFacet:titles', 'urn:li:adTargetingFacet:seniorities');

2. Read all ad-targeting entities which contain the specified characters in their name (and optionally specify the entity type), by using the the TYPEAHEAD finder:

SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:locations' AND TypeaheadCriteria = 'Denv';
SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:locations' AND TypeaheadEntityType = 'REGION' AND TypeaheadCriteria = 'Denv';

3. Read all ad-targeting entities which are similar to another ad-targeting entity, by using the SIMILAR_ENTITIES finder:

SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:titles' AND SimilarEntityURN = 'urn:li:title:25194';
SELECT * FROM TargetingEntities WHERE FacetURN = 'urn:li:adTargetingFacet:titles' AND SimilarEntityURN IN ('urn:li:title:25194', 'urn:li:title:21544');

NOTE: Some of the use cases above might not apply for specific facets. To learn which finders are applicable to each facet, query the TargetingFacets view.

4. Read all ad-targeting entities with the specified URN-s:

SELECT * FROM TargetingEntities WHERE URN = 'urn:li:title:10738';
SELECT * FROM TargetingEntities WHERE URN IN ('urn:li:title:10738', 'urn:li:title:19179');

Columns

Name	Type	References	Description
URN [KEY]	String		Uniform Resource Name (URN) that uniquely identifies the ad-targeting entity within LinkedIn Ads.
Name	String		Display name of the ad-targeting entity used in audience selection or campaign setup.
FacetURN	String	TargetingFacets.URN	URN that identifies the ad-targeting facet used when searching for entities within a specific targeting category.
TypeaheadEntityType	String		Specifies the type of entity to search for using the TYPEAHEAD finder, such as company or skill.
TypeaheadCriteria	String		Defines the text or name input used to search for entities through the TYPEAHEAD finder.

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
SimilarEntityURN	String		URN of an entity used with the SIMILAR_ENTITIES finder to identify related or similar entities for targeting.

Provides metadata about LinkedIn Ads targeting facets, defining the dimensions available for building audience segments.

Columns

Name	Type	References	Description
URN [KEY]	String		Uniform Resource Name (URN) that uniquely identifies the targeting facet within LinkedIn Ads.
Name	String		Display name of the targeting facet used to define a specific audience attribute, such as industry or company size.
EntityTypes	String		Lists the types of entities associated with this facet, which determine what can be targeted through it.
EntityFinders	String		Specifies the available entity finders for this facet, used to search or retrieve related targeting entities.

Provides standardized job title data through LinkedIn's taxonomy to support accurate audience targeting and reporting.

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 Cloud uses the LinkedIn Marketing Solutions API to process search criteria. The Cloud processes other filters client-side within the Cloud. For example, the following queries are processed server side.

SELECT * FROM Titles

Columns

Name	Type	References	Description
Id	String		Unique identifier assigned to the standardized job title entry.
URN	String		Uniform Resource Name (URN) that uniquely identifies the standardized job title within LinkedIn's taxonomy.
Name	String		Localized display name of the job title, represented as a MultiLocaleString type supporting multiple languages.
Function	String		URN that identifies the job function associated with this title within the LinkedIn taxonomy.
SuperTitle	String		URN that identifies the broader or parent title category (super title) to which this title belongs.

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

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

CData Cloud - LinkedIn Marketing Solutions Stored Procedures

Name	Description

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

Schema Tables

The following tables return database metadata for LinkedIn Marketing Solutions:

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

Data Source Tables

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

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

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

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

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

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

Describes the columns of the available tables and views.

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

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

Columns

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

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

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

Describes stored procedure parameters.

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

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

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

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

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native LinkedIn Marketing Solutions procedure.

Pseudo-Columns

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

Describes the primary and foreign keys.

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

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

Columns

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

Describes the foreign keys.

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

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

Describes the primary keys.

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

         SELECT * FROM sys_primarykeys
          

Columns

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

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

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

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

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

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

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns

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

Returns information about attempted modifications.

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

         SELECT * FROM sys_identity
          

Columns

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

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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

Logging

---

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

Schema

---

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

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn Marketing Solutions.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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

---

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

A specific scope that the user requires the access token.

Data Type

string

Default Value

"r_basicprofile,r_emailaddress,r_organization_social,w_organization_social,rw_ads,r_ads,r_ads_reporting,r_marketing_leadgen_automation,r_organization_admin"

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.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

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

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

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

---

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

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

Data Type

string

Default Value

"1"

Remarks

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

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

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

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

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.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from LinkedIn Marketing Solutions.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
ThrowsKeyNotFound	Specifies whether or not throws an exception if there is no rows updated.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.