Skip to main content
Skip table of contents

LinkedIn Ads

Overview

The LinkedIn Ads datasource allows you gather data related to your advertisements on LinkedIn.

Vendor/Partner

Linkedin

Version

202304

API Documentation

https://learn.microsoft.com/en-us/linkedin/marketing/versioning?view=li-lms-2023-03#version-cadence

LinkedIn adAnalytics API

https://www.linkedin.com/developers/apps/

Sunset Date

None as of 04.04.2024
Note: LinkedIn Marketing API Program will publish new versions monthly, and those versions will be supported for a minimum of one (1) year.

Channel(s)

Social

Refresh Time (CST)

6 am

Default backfill

Performance metrics are near real-time, while demographic metrics may be delayed by 12 to 24 hours.

Alli Data Library

(tick)

Before Getting Started

To get started with the LinkedIn Ads datasource, ensure you have the following:

  • A LinkedIn profile with at least Viewer access to a LinkedIn Ads account

  • A LinkedIn Ads account ID found in LinkedIn Campaign Manager

Required Authorization

Click the button to login to your LinkedIn account instance and provide Alli access to your ad accounts.

Additional Configurations

Account ID

Paste in your LinkedIn Ads account ID.

Report Type

Select the type of report, Campaign, Conversion, or Creative, that you like to gather data for.

Available Dimensions and Metrics

Dimensions

Name

Type

Description

Creative ID

string

Unique Alphanumerical ID of the campaign

Campaign Name

string

Unique name of the campaign

Campaign ID

string

Unique Alphanumerical ID of the campaign

Account ID

string

Unique Alphanumerical ID of the account

Date

date

The date of when the metrics were snapshot.

Metrics

Name

Type

Description

actionClicks

long

The count of clicks on the action button of the Sponsored InMail. Sponsored InMail only.

adUnitClicks

long

The count of clicks on the ad unit displayed alongside the Sponsored InMail. Sponsored InMail only.

cardClicks

long

The number of clicks for each card of a carousel ad. The first card click of the carousel ad results in an immediate cardClick and click, whereas scrolling to other cards and clicking will count as additional cardClick.

cardImpressions

long

The number of impressions shown for each card of a carousel ad. The first card of the carousel ad results in an immediate cardImpression and impression, whereas scrolling to other cards will count as additional cardImpressions.

clicks

long

The count of chargeable clicks. Despite not charging for clicks for CPM campaigns, this field still represents those clicks for which we would otherwise charge advertisers (for example, clicks to view the landing page or company page).

commentLikes

long

Analytics Finder only. The count of likes of a comment. Sponsored Updates only.

comments

long

The count of comments. Sponsored Updates only.

companyPageClicks

long

The count of clicks to view the company page.

conversionValueInLocalCurrency

BigDecimal

Value of the conversions in the account's local currency based on rules defined by the advertiser. Conversion value is set by the advertiser at a per conversion level, and aggregated across the query time range.

costInLocalCurrency

BigDecimal

Cost in the account's local currency based on the pivot and timeGranularity. For example, this would be spend by member company size per month if the pivot is MEMBER_COMPANY_SIZE and timeGranularity is MONTHLY.

costInUsd

BigDecimal

Cost in USD based on the pivot and timeGranularity. For example, this would be spend by campaign on a given day if the pivot is CAMPAIGN and timeGranularity is DAILY.

dateRange

DateRange

Date range covered by the report data point. Date is specified in UTC. Start and end date are inclusive. Start date is required. End date is optional and defaults to today.

externalWebsiteConversions

long, default="0"

The count of conversions indicated by pixel loads on an external advertiser website.

externalWebsitePostClickConversions

long, default="0"

The count of post-click conversions indicated by pixel loads on an external advertiser website.

externalWebsitePostViewConversions

long, default="0"

The count of post-view conversions indicated by pixel loads on an external advertiser website.

follows

long

The count of follows. Sponsored Updates only.

fullScreenPlays

long

Analytics Finder only. The count of taps on the video, going into video view mode.

impressions

long

This is the count of "impressions" for Direct Ads and Sponsored Updates and "sends" for InMails.

landingPageClicks

long

The count of clicks which take the user to the creative landing page.

leadGenerationMailContactInfoShares

long

The number of times users shared contact info through the One Click Lead Gen for Sponsored InMail. Sponsored InMail only.

leadGenerationMailInterestedClicks

long

The count of InMail recipients who clicked to demonstrate interest. Sponsored InMail only.

likes

long

The count of likes. Sponsored Updates only.

oneClickLeadFormOpens

long

The count of times users opened the lead form for a One Click Lead Gen campaign.

oneClickLeads

long

The count of leads generated through One Click Lead Gen.

opens

long

The count of opens of Sponsored InMail. Sponsored InMail only.

otherEngagements

long

The count of user interactions with the ad unit that do not fit into any other more specific category.

pivotValues

string[], default="[]"

The value of the pivots for a specific record returned. For example, supplying pivots of CREATIVE and CONVERSION results in a list of records, one for each creative/conversion combination. The pivotValues contain serialized URNs for the specific creative and conversion for a record.

sends

long

The count of sends of Sponsored InMail. Sponsored InMail only.

shares

long

The count of shares. Sponsored Updates only.

textUrlClicks

long

The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail. Sponsored InMail only.

totalEngagements

long

The count of all user interactions with the ad unit.

videoCompletions

long

Analytics Finder only. The count of video ads that played 97-100% of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

videoFirstQuartileCompletions

long

Analytics Finder only. The count of video ads that played through the first quartile of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

videoMidpointCompletions

long

Analytics Finder only. The count of video ads that played through the midpoint of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

videoStarts

long

Analytics Finder only. The count of video ads that were started by users.

videoThirdQuartileCompletions

long

Analytics Finder only. The count of video ads that played through the third quartile of the video. This includes watches that skipped to this point if the serving location is ON_SITE.

videoViews

long

Analytics Finder only. A video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. An interaction with the video (like going to fullscreen mode) does not count as a view.

viralCardClicks

long

The number of viralClicks for each card of a carousel ad. The first viralCardClick of the carousel ad results in an immediate viralCardClick and viralClick, whereas scrolling to other cards and clicking will count as additional viralCardClick.

viralCardImpressions

long

The number of viralImpressions shown for each card of a carousel ad. The first card of the carousel ad results in an immediate viralCardImpression and viralImpression, whereas scrolling to other cards will count as additional viralCardImpressions.

viralClicks

long

The count of clicks on viral impressions. See viral impressions definition. Sponsored Updates only.

viralCommentLikes

long

The count of likes on comments from viral impressions for this activity. See viral impressions definition. Sponsored Updates only.

viralComments

long

The count of comments from viral impressions for this activity. See viral impressions definition. Sponsored Updates only.

viralCompanyPageClicks

long

The count of clicks to view the company page from viral impressions for this activity. See viral impressions definition. Sponsored Updates only.

viralExternalWebsiteConversions

long

The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event. See viral impressions definition.

viralExternalWebsitePostClickConversions

long

The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click. See viral impressions definition.

viralExternalWebsitePostViewConversions

long

The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression. See viral impressions definition.

viralFollows

long

The count of follows from viral impressions for this activity. See viral impressions definition. Sponsored Updates only.

viralFullScreenPlays

long

Analytics Finder only. The count of taps on the video, going into video view mode. See viralImpressions definition.

viralImpressions

long

The count of viral impressions for this activity. Viral impressions are those resulting from users sharing a sponsored update to their own network of connections. Viral impressions are not counted as regular impressions. Sponsored Updates only.

viralLandingPageClicks

long

The count of clicks on viral impressions to take the user to the creative landing page. See viral impressions definition. Sponsored Updates only.

viralLikes

long

The count of likes from viral impressions for this activity. See viral impressions definition. Sponsored Updates only.

viralOneClickLeadFormOpens

long

The count of times users opened the lead form for viral impressions from a Lead Gen campaign. See viral impressions definition.

viralOneClickLeads

long

The count of leads generated through One Click Lead Gen from viral impressions for this activity. See viral impressions definition.

viralOtherEngagements

long

The count of user interactions with viral impressions that do not fit into any other more specific category. See viral impressions definition. Sponsored Updates only.

viralShares

long

The count of shares from viral impressions for this activity. See viral impressions definition. Sponsored Updates only.

viralTotalEngagements

long

The count of all user interactions with a viral ad unit. See viral impressions definition. Sponsored Updates only.

viralVideoCompletions

long

Analytics Finder only. The count of viral video ads that played 97-100% of the video. This includes watches that skipped to this point. See viralImpressions definition.

viralVideoFirstQuartileCompletions

long

Analytics Finder only. The count of viral video ads that played through the first quartile of the video. This includes watches that skipped to this point. See viralImpressions definition.

viralVideoMidpointCompletions

long

Analytics Finder only. The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point. See viralImpressions definition.

viralVideoStarts

long

Analytics Finder only. The count of viral video ads that were started by users. See viralImpressions definition. Since viral videos are automatically played for ON_SITE, this will be the same as viralImpressions if the servingLocation is ON_SITE.

viralVideoThirdQuartileCompletions

long

Analytics Finder only. The count of viral video ads that played through the third quartile of the video. This includes watches that skipped to this point. See viralImpressions definition

viralVideoViews

long

Analytics Finder only. A viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first. An interaction with the video (like going to full screen mode) does not count as a view. See viralImpressions definition.

Frequently Ask Questions

Why did my datasource stop loading data?

This could be for a number of different reasons, however it’s often related to the authorization. We suggest trying to refresh your authorization if it has been over a year.

Why does it seem like my data is changing?

To protect LinkedIn member privacy, demographic metrics are approximate. To learn more about this approximation, see here.

Because metrics are approximate, you may observe minor inconsistencies when comparing:

  • Similar time ranges, for example, reporting on results over 7 days vs. 8 days

  • The sum of daily metrics to the full corresponding time period

  • Reporting levels, for example, adding campaign level data and comparing it to account-level data

To minimize the effect of this approximation, select:

  • A full-time period instead of adding up daily metrics for that time period

  • The highest reporting level you want to view, for example, selecting account-level data instead of adding up campaign level data

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.