This integration is powered by Singer's LinkedIn Ads tap and certified by Stitch. Check out and contribute to the repo on GitHub.
For support, contact Stitch support.
LinkedIn Ads feature snapshot
A high-level look at Stitch's LinkedIn Ads (v2) integration, including release status, useful links, and the features supported in Stitch.
| STITCH | |||
| Release status |
Released on February 7, 2023 |
Supported by | |
| Stitch plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Supported |
| Select all |
Supported |
||
| TRANSPARENCY | |||
| Extraction Logs |
Supported |
Loading Reports |
Supported |
Connecting LinkedIn Ads
LinkedIn Ads setup requirements
To set up LinkedIn Ads in Stitch, you need:
-
Access to a LinkedIn Ads account. This is necessary to login to the Campaign Manager account.
-
Access to a LinkedIn Ads Campaign Manager account. Verify that you have access to use the Ad accounts you want to replicate data from. This is necessary to connect to Stitch.
Step 1: Retrieve your LinkedIn Ads account IDs
- Login to your LinkedIn account.
-
Click the Work menu, then Advertise:
-
In the Accounts table, locate the IDs for the accounts you want to replicate data from:
Step 2: Add LinkedIn Ads as a Stitch data source
- Sign into your Stitch account.
-
On the Stitch Dashboard page, click the Add Integration button.
-
Click the LinkedIn Ads icon.
-
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch LinkedIn Ads” would create a schema called
stitch_linkedin_adsin the destination. Note: Schema names cannot be changed after you save the integration. - In the Accounts field, enter a comma-separated list of the account IDs of the campaign accounts you want to replicate data from. These will be the account IDs you retrieved in Step 1. For example:
503123456,503234567, etc.
Step 3: Define the historical replication start date
The Sync Historical Data setting defines the starting date for your LinkedIn Ads integration. This means that data equal to or newer than this date will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond LinkedIn Ads’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
LinkedIn Ads integrations support the following replication scheduling methods:
-
Advanced Scheduling using Cron (Advanced or Premium plans only)
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set objects to replicate
The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.
Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.
For LinkedIn Ads integrations, you can select:
-
Individual tables and columns
-
All tables and columns
Click the tabs to view instructions for each selection method.
- In the integration’s Tables to Replicate tab, locate a table you want to replicate.
-
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
-
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
- Repeat this process for all the tables and columns you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- Click into the integration from the Stitch Dashboard page.
-
Click the Tables to Replicate tab.
- In the list of tables, click the box next to the Table Names column.
-
In the menu that displays, click Track all Tables and Fields:
- Click the Finalize Your Selections button at the bottom of the page to save your data selections.
Initial and historical replication jobs
After you finish setting up LinkedIn Ads, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
LinkedIn Ads replication
Every time Stitch runs a replication job for LinkedIn Ads, the last 7 days’ worth of data will be replicated for these tables:
-
ad_analytics_by_campaign -
ad_analytics_by_creative
Stitch replicates data in this way to account for updates made to existing records within the default attribution window of 7 days, thus ensuring you won’t make decisions based on stale (or false) data. As a result, you may see a higher number of replicated rows than what’s being generated in LinkedIn Ads.
Setting the Replication Frequency to a higher frequency - like 30 minutes - can result in re-replicating recent data and contribute to greater row usage. Replicating fewer tables or selecting a lower frequency can help keep your row count low.
Refer to the documentation for each of these tables in the next section for more info.
Attribution window examples
In the tabs below are examples of attribution windows behave during historical (initial) and ongoing replication jobs.
For historical and full re-replications of LinkedIn Ads data, Stitch will query for and extract data newer than or equal to the date defined in the Start Date field in the Integration Settings page.
The Start Date, in conjunction with the Attribution Window, defines the minimum date Stitch should query for when extracting historical data. This is calculated as:
Start Date - Attribution Window = Minimum Extraction Date
Example
During the initial set up, the Start Date field is set to 06/03/2017, or June 3, 2017.
To account for the Attribution Window, Stitch would calculate the Minimum Extraction Date value as: 2017-07-03 00:00:00 - 7 days = 2017-06-03 00:00:00
If you were to write a SQL query using this date for the ad_analytics_by_campaign table, it might look like this:
SELECT *
FROM linkedin_ads.ad_analytics_by_campaign
WHERE end_at >= '2017-06-03 00:00:00' /* Min. Extraction Date */
ORDER BY end_at
For ongoing replication jobs, Stitch will query for and extract data using the last saved maximum value in the table’s Replication Key column and the Attribution Window for the table.
Note: This applies to every replication job that takes place after the historical replication job.
Example
The last maximum saved Replication Key value for the ad_analytics_by_campaign table is 2017-10-01 00:00:00.
To account for the Attribution Window of 7 days, we’d subtract this from the last maximum saved Replication Key value:
2017-10-01 00:00:00 - 7 days = 2017-09-24 00:00:00
In this case, Stitch would query for and extract data that is newer than or equal to 2017-09-24 00:00:00 and older than or equal to 2017-10-01 00:00:00.
If this were a SQL query, it might look like this:
SELECT *
FROM ad_analytics_by_campaign
WHERE end_at >= '2017-09-24 00:00:00'
/* max Replication Key value - Attribution Window */
AND end_at <= '2017-10-01 00:00:00'
/* max Replication Key value from previous job */
ORDER BY end_at
LinkedIn Ads table reference
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 2 of this integration.
This is the latest version of the LinkedIn Ads integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.
accounts
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
last_modified_time |
Primary Key  :
|
id |
API endpoint : |
The accounts table contains info about your LinkedIn Ads ad accounts.
|
id
The internal account ID. Reference: |
||
|
last_modified_time
The time the account was last modified. |
||
|
change_audit_stamps
|
||
|
created_time
The time the account was created. |
||
|
currency
The ISO 4217 currency code. |
||
|
name
The account label. |
||
|
notified_on_campaign_optimization
Indicates if the campaign contact has been notified about an opportunity. |
||
|
notified_on_creative_approval
Indicates if the creative contact has been notified of approval. |
||
|
notified_on_creative_rejection
Indicates if the creative contact has been rejected. |
||
|
notified_on_end_of_campaign
Indicates if the campaign contact has been notified about the end of a campaign. |
||
|
notified_on_new_features_enabled
Indicates if the account owner is notified about new features. |
||
|
reference
The entity on whose behalf the account advertises. |
||
|
reference_organization_id
|
||
|
reference_person_id
|
||
|
serving_statuses
Details about the account’s system serving statuses.
|
||
|
status
The account’s active status. |
||
|
test
Indicates whether this account is a test account. |
||
|
total_budget
Details about the account’s budget.
|
||
|
total_budget_ends_at
|
||
|
type
The account type - business or enterprise. |
||
|
version
|
account_users
| Replication Method : |
Key-based Incremental |
Replication Key :
|
last_modified_time |
|
Primary Key :
|
account_id : user_person_id |
API endpoint : |
The account_users table contains info about the users who have permissions to an ad account.
|
account_id
The ID of the account associated with the user. Reference: |
||
|
user_person_id
The user’s person ID. Reference: |
||
|
last_modified_time
The time the user was last modified. |
||
|
account
The advertising account’s URN. |
||
|
campaign_contact
The list of emails registered to receive campaign-related events. |
||
|
change_audit_stamps
|
||
|
created_time
The time the user was las modified. |
||
|
role
The user’s role in the account. Possible values are:
|
||
|
user
The associated user’s URN. |
ad_analytics_by_campaign
| Replication Method : |
Key-based Incremental |
Replication Key :
|
end_at |
|
Primary Key :
|
campaign_id : start_at |
API endpoint : |
The ad_analytics_by_campaign table contains analytics data for ads, segmented by campaign.
Note: This table is replicated using an attribution window of 7 days. Refer to the Replication section for more info.
|
campaign_id
The campaign ID. Reference: |
||||||||
|
start_at
The start of the time range for the analytics. |
||||||||
|
end_at
The end of the time range for the analytics. |
||||||||
|
action_clicks
The count of clicks on the |
||||||||
|
ad_unit_clicks
The count of clicks on the ad unit alongside the Sponsored InMail. |
||||||||
|
approximate_unique_impressions
The approximate reach of the campaign. The number of unique member accounts with at least one impression. |
||||||||
|
campaign
|
||||||||
|
comments
The count of comments - Sponsored Updates only. |
||||||||
|
company_page_clicks
The count of clicks to view the company page. |
||||||||
|
conversion_value_in_local_currency
The value of the conversions in the account’s local currency. |
||||||||
|
cost_in_local_currency
The cost in the account’s local currency based on the pivot and |
||||||||
|
cost_in_usd
The cost in USD based on the pivot and |
||||||||
|
date_range
The date range of the report data point, specified in UTC. A start date is required.
|
||||||||
|
external_website_conversions
The count of conversions indicated by pixel loads on an external advertiser website. |
||||||||
|
external_website_post_click_conversions
The count of post-view conversions indicated by pixel loads on an external advertiser website. |
||||||||
|
external_website_post_view_conversions
The count of post-view conversions indicated by pixel loads on an external advertiser website. |
||||||||
|
follows
The follow count - Sponsored Updates only. |
||||||||
|
full_screen_plays
The tap counts on a video going into video view mode. |
||||||||
|
impressions
This is the count of |
||||||||
|
lead_generation_mail_contact_info_shares
The number of times users shared contact info through the One Click Lead Gen for Sponsored InMail - Sponsored InMail only. |
||||||||
|
lead_generation_mail_interest_clicks
The count of InMail recipients who clicked to demonstrate interest - Sponsored InMail only. |
||||||||
|
likes
The count of likes - Sponsored Updates only. |
||||||||
|
one_click_lead_form_opens
The count of times users opened the lead form for a One Click Lead Gen campaign. |
||||||||
|
one_click_leads
The count of leads generated through One Click Lead Gen. |
||||||||
|
opens
The count of opens of Sponsored InMail. |
||||||||
|
other_engagements
The count of user interactions with the ad unit that do not fit into any other more specific category. |
||||||||
|
pivot
|
||||||||
|
pivot_value
|
||||||||
|
pivot_values
The value of the pivots for a specific record returned. |
||||||||
|
shares
The count of sends of Sponsored InMail. |
||||||||
|
text_url_clicks
The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail. |
||||||||
|
total_engagements
The count of all user interactions with the ad unit. |
||||||||
|
video_completions
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 |
||||||||
|
video_first_quartile_completions
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 |
||||||||
|
video_midpoint_completions
|
||||||||
|
video_starts
|
||||||||
|
video_third_quartile_completions
|
||||||||
|
video_views
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 |
||||||||
|
viral_clicks
The count of clicks on viral impressions - Sponsored Updates only. |
||||||||
|
viral_comments
The count of comments from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_company_page_clicks
The count of clicks to view the company page from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_external_website_conversions
The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event. |
||||||||
|
viral_external_website_post_click_conversions
The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click. |
||||||||
|
viral_external_website_post_view_conversions
The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression. |
||||||||
|
viral_follows
The count of follows from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_full_screen_plays
The count of taps on the video, going into video view mode. |
||||||||
|
viral_impressions
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 - Sponsored Updates only. |
||||||||
|
viral_landing_page_clicks
The count of clicks on viral impressions to take the user to the creative landing page - Sponsored Updates only. |
||||||||
|
viral_likes
The count of likes from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_one_click_lead_form_opens
The count of times users opened the lead form for viral impressions from a Lead Gen campaign. |
||||||||
|
viral_one_click_leads
The count of leads generated through One Click Lead Gen from viral impressions for this activity. |
||||||||
|
viral_other_engagements
The count of user interactions with viral impressions that do not fit into any other more specific category - Sponsored Updates only. |
||||||||
|
viral_shares
The count of shares from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_total_engagements
The count of all user interactions with a viral ad unit - Sponsored Updates only. |
||||||||
|
viral_video_completions
The count of viral video ads that played 97-100% of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_first_quartile_completions
The count of viral video ads that played through the first quartile of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_midpoint_completions
The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_starts
The count of viral video ads that were started by users. Since viral videos are automatically played for |
||||||||
|
viral_video_third_quartile_completions
The count of viral video ads that played through the third quartile of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_views
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. |
||||||||
|
average_daily_reach_metrics
The reach metrics corresponding to the day relative to the date range.
|
||||||||
|
average_previous_seven_day_reach_metrics
The reach metrics corresponding to the last 7 days based on the date range.
|
||||||||
|
average_previous_thirty_day_reach_metrics
The reach metrics corresponding to the last 30 days based on the date range.
|
||||||||
|
document_completions
The number of times users reached 100% of the document’s length, including those that skipped to this point. |
||||||||
|
document_first_quartile_completions
The number of times users reached the first quartile of the document’s length, including those that skipped to this point. |
||||||||
|
document_midpoint_completions
The number of times users reached the second quartile of the document’s length, including those that skipped to this point. |
||||||||
|
document_third_quartile_completions
The number of times users reached the third quartile of the document’s length, including those that skipped to this point. |
||||||||
|
download_clicks
The number of times users have indicated the intent to download the media in an ad by clicking the download icon. |
||||||||
|
job_applications
The number of times a member completed a job application after viewing or clicking on an ad. |
||||||||
|
job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after viewing or clicking on an ad which has a LinkedIn job landing page. |
||||||||
|
post_click_job_applications
The number of times a member completed a job application after clicking on an ad. |
||||||||
|
post_click_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after clicking on an ad which has a LinkedIn job landing page. |
||||||||
|
post_click_registrations
The number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page. |
||||||||
|
post_view_job_applications
The number of times a member completed a job application after viewing an ad. |
||||||||
|
post_view_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after clicking an ad which has a LinkedIn job landing page. |
||||||||
|
post_view_registrations
The number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page. |
||||||||
|
registrations
The number of times a member has registered for an event or seminar after viewing or clicking on an ad which has a LinkedIn event landing page. |
||||||||
|
talent_leads
The number of leads captured through a talent media campaign. |
||||||||
|
viral_document_completions
The number of times users reached 100% of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_document_first_quartile_completions
The number of times users reached the first quartile of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_document_midpoint_completions
The number of times users reached the second quartile of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_document_third_quartile_completions
The number of times users reached the third quartile of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_download_clicks
The number of times users have indicated the intent to download the media in a viral ad by clicking the download icon. |
||||||||
|
viral_job_applications
The number of times a member completed a job application after viewing or clicking on a viral ad. |
||||||||
|
viral_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after viewing or clicking on a viral ad which has a LinkedIn job landing page during the date range. |
||||||||
|
viral_post_click_job_applications
The number of times a member completed a job application after clicking on a viral ad. |
||||||||
|
viral_post_click_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after clicking on a viral ad which has a LinkedIn job landing page. |
||||||||
|
viral_post_click_registrations
The number of times a member has registered for an event or seminar after clicking on a viral ad which has a LinkedIn landing page. |
||||||||
|
viral_post_view_job_applications
The number of times a member completed a job application after viewing a viral ad. |
||||||||
|
viral_post_view_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after viewing a viral ad which has a LinkedIn job landing page. |
||||||||
|
viral_post_view_registrations
The number of times a member has registered for an event or seminar after viewing a viral ad which has a LinkedIn event landing page. |
||||||||
|
viral_registrations
The number of times a member has registered for an event or seminar after viewing or clicking on a viral ad which has a LinkedIn event landing page. |
ad_analytics_by_creative
| Replication Method : |
Key-based Incremental |
Replication Key :
|
end_at |
|
Primary Key :
|
creative_id : start_at |
API endpoint : |
The ad_analytics_by_creative table contains info about ad analytics, segmented by creative.
Note: This table is replicated using an attribution window of 7 days. Refer to the Replication section for more info.
|
creative_id
The creative ID. Reference: |
||||||||
|
start_at
The start of the time range for the analytics. |
||||||||
|
end_at
The end of the time range for the analytics. |
||||||||
|
action_clicks
The count of clicks on the |
||||||||
|
ad_unit_clicks
The count of clicks on the ad unit alongside the Sponsored InMail. |
||||||||
|
approximate_unique_impressions
The approximate reach of the campaign. The number of unique member accounts with at least one impression. |
||||||||
|
comments
The count of comments - Sponsored Updates only. |
||||||||
|
company_page_clicks
The count of clicks to view the company page. |
||||||||
|
conversion_value_in_local_currency
The value of the conversions in the account’s local currency. |
||||||||
|
cost_in_local_currency
The cost in the account’s local currency based on the pivot and timeGranularity. |
||||||||
|
cost_in_usd
The cost in USD based on the pivot and timeGranularity. |
||||||||
|
creative
|
||||||||
|
date_range
The date range of the report data point, specified in UTC.
|
||||||||
|
external_website_conversions
The count of conversions indicated by pixel loads on an external advertiser website. |
||||||||
|
external_website_post_click_conversions
The count of post-view conversions indicated by pixel loads on an external advertiser website. |
||||||||
|
external_website_post_view_conversions
The count of post-view conversions indicated by pixel loads on an external advertiser website. |
||||||||
|
follows
The follow count - Sponsored Updates only. |
||||||||
|
full_screen_plays
The tap counts on a video going into video view mode. |
||||||||
|
impressions
This is the count of ‘impressions’ for Direct Ads and Sponsored Updates and ‘sends’ for InMails. |
||||||||
|
lead_generation_mail_contact_info_shares
|
||||||||
|
lead_generation_mail_interest_clicks
The number of times users shared contact info through the One Click Lead Gen for Sponsored InMail - Sponsored InMail only. |
||||||||
|
likes
The count of likes - Sponsored Updates only. |
||||||||
|
one_click_lead_form_opens
The count of times users opened the lead form for a One Click Lead Gen campaign. |
||||||||
|
one_click_leads
The count of leads generated through One Click Lead Gen. |
||||||||
|
opens
The count of opens of Sponsored InMail. |
||||||||
|
other_engagements
The count of user interactions with the ad unit that do not fit into any other more specific category. |
||||||||
|
pivot
|
||||||||
|
pivot_value
|
||||||||
|
pivot_values
The value of the pivots for a specific record returned. |
||||||||
|
shares
The count of sends of Sponsored InMail. |
||||||||
|
text_url_clicks
The count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail. |
||||||||
|
total_engagements
The count of all user interactions with the ad unit. |
||||||||
|
video_completions
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 |
||||||||
|
video_first_quartile_completions
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 |
||||||||
|
video_midpoint_completions
|
||||||||
|
video_starts
|
||||||||
|
video_third_quartile_completions
|
||||||||
|
video_views
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 |
||||||||
|
viral_clicks
The count of clicks on viral impressions - Sponsored Updates only. |
||||||||
|
viral_comments
The count of comments from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_company_page_clicks
The count of clicks to view the company page from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_external_website_conversions
The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event. |
||||||||
|
viral_external_website_post_click_conversions
The count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click. |
||||||||
|
viral_external_website_post_view_conversions
The count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression. |
||||||||
|
viral_follows
The count of follows from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_full_screen_plays
The count of taps on the video, going into video view mode. |
||||||||
|
viral_impressions
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 - Sponsored Updates only. |
||||||||
|
viral_landing_page_clicks
The count of clicks on viral impressions to take the user to the creative landing page - Sponsored Updates only. |
||||||||
|
viral_likes
The count of likes from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_one_click_lead_form_opens
The count of times users opened the lead form for viral impressions from a Lead Gen campaign. |
||||||||
|
viral_one_click_leads
The count of leads generated through One Click Lead Gen from viral impressions for this activity. |
||||||||
|
viral_other_engagements
The count of user interactions with viral impressions that do not fit into any other more specific category - Sponsored Updates only. |
||||||||
|
viral_shares
The count of shares from viral impressions for this activity - Sponsored Updates only. |
||||||||
|
viral_total_engagements
The count of all user interactions with a viral ad unit - Sponsored Updates only. |
||||||||
|
viral_video_completions
The count of viral video ads that played 97-100% of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_first_quartile_completions
The count of viral video ads that played through the first quartile of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_midpoint_completions
The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_starts
The count of viral video ads that were started by users. Since viral videos are automatically played for |
||||||||
|
viral_video_third_quartile_completions
The count of viral video ads that played through the third quartile of the video. This includes watches that skipped to this point. |
||||||||
|
viral_video_views
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. |
||||||||
|
average_daily_reach_metrics
The reach metrics corresponding to the day relative to the date range.
|
||||||||
|
average_previous_seven_day_reach_metrics
The reach metrics corresponding to the last 7 days based on the date range.
|
||||||||
|
average_previous_thirty_day_reach_metrics
The reach metrics corresponding to the last 30 days based on the date range.
|
||||||||
|
document_completions
The number of times users reached 100% of the document’s length, including those that skipped to this point. |
||||||||
|
document_first_quartile_completions
The number of times users reached the first quartile of the document’s length, including those that skipped to this point. |
||||||||
|
document_midpoint_completions
The number of times users reached the second quartile of the document’s length, including those that skipped to this point. |
||||||||
|
document_third_quartile_completions
The number of times users reached the third quartile of the document’s length, including those that skipped to this point. |
||||||||
|
download_clicks
The number of times users have indicated the intent to download the media in an ad by clicking the download icon. |
||||||||
|
job_applications
The number of times a member completed a job application after viewing or clicking on an ad. |
||||||||
|
job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after viewing or clicking on an ad which has a LinkedIn job landing page. |
||||||||
|
post_click_job_applications
The number of times a member completed a job application after clicking on an ad. |
||||||||
|
post_click_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after clicking on an ad which has a LinkedIn job landing page. |
||||||||
|
post_click_registrations
The number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page. |
||||||||
|
post_view_job_applications
The number of times a member completed a job application after viewing an ad. |
||||||||
|
post_view_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after clicking an ad which has a LinkedIn job landing page. |
||||||||
|
post_view_registrations
The number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page. |
||||||||
|
registrations
The number of times a member has registered for an event or seminar after viewing or clicking on an ad which has a LinkedIn event landing page. |
||||||||
|
talent_leads
The number of leads captured through a talent media campaign. |
||||||||
|
viral_document_completions
The number of times users reached 100% of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_document_first_quartile_completions
The number of times users reached the first quartile of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_document_midpoint_completions
The number of times users reached the second quartile of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_document_third_quartile_completions
The number of times users reached the third quartile of the document’s length on a viral post, including those that skipped to this point. |
||||||||
|
viral_download_clicks
The number of times users have indicated the intent to download the media in a viral ad by clicking the download icon. |
||||||||
|
viral_job_applications
The number of times a member completed a job application after viewing or clicking on a viral ad. |
||||||||
|
viral_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after viewing or clicking on a viral ad which has a LinkedIn job landing page during the date range. |
||||||||
|
viral_post_click_job_applications
The number of times a member completed a job application after clicking on a viral ad. |
||||||||
|
viral_post_click_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after clicking on a viral ad which has a LinkedIn job landing page. |
||||||||
|
viral_post_click_registrations
The number of times a member has registered for an event or seminar after clicking on a viral ad which has a LinkedIn landing page. |
||||||||
|
viral_post_view_job_applications
The number of times a member completed a job application after viewing a viral ad. |
||||||||
|
viral_post_view_job_apply_clicks
The number of times a member clicked on the job’s apply button on an LinkedIn jobs page after viewing a viral ad which has a LinkedIn job landing page. |
||||||||
|
viral_post_view_registrations
The number of times a member has registered for an event or seminar after viewing a viral ad which has a LinkedIn event landing page. |
||||||||
|
viral_registrations
The number of times a member has registered for an event or seminar after viewing or clicking on a viral ad which has a LinkedIn event landing page. |
campaigns
| Replication Method : |
Key-based Incremental |
Replication Key :
|
last_modified_time |
|
Primary Key :
|
id |
API endpoint : |
The campaigns table contains info about the campaigns in your LinkedIn Ads account.
|
id
The campaign ID. Reference: |
|||||
|
last_modified_time
The time the campaign was last modified. |
|||||
|
account
URN identifying the advertising account associated with the campaign. |
|||||
|
account_id
The ID of the account associated with the campaign. Reference: |
|||||
|
associated_entity
An URN identifying the intended beneficiary of the advertising campaign such as a specific company or member. |
|||||
|
associated_entity_organization_id
|
|||||
|
associated_entity_person_id
|
|||||
|
audience_expansion_enabled
Indicates if Audience Expansion is enabled for the campaign provides query expansion for certain targeting criteria. |
|||||
|
campaign_group
URN identifying the campaign group associated with the campaign. If the campaign group is not specified, the campaign is assigned to account’s default campaign group. |
|||||
|
campaign_group_id
The ID of the campaign group associated with the campaign. Reference: |
|||||
|
change_audit_stamps
|
|||||
|
cost_type
The cost type - |
|||||
|
created_time
|
|||||
|
creative_selection
The creative selection - |
|||||
|
daily_budget
Details about the budget for the campaign.
|
|||||
|
locale
Details about the campaign’s locale.
|
|||||
|
name
The name of the campaign. |
|||||
|
offsite_delivery_enabled
Indicates if offsite delivery is enabled for the campaign. |
|||||
|
optimization_target_type
Determines how this campaign is optimized for spending. If this is not set, there is no optimization. Refer to LinkedIn Ads’ documentation for more info. |
|||||
|
run_schedule
Details about the campaign’s run schedule.
|
|||||
|
serving_statuses
The serving status of the campaign. |
|||||
|
status
The status of the campaign. Possible values are:
|
|||||
|
targeting
Deprecated by LinkedIn Ads. Use
|
|||||
|
targeting_criteria
Specifies targeting criteria that the member should match. Refer to LinkedIn Ads’ documentation for more info.
|
|||||
|
type
The type of the campaign. Possible values are:
|
|||||
|
unit_cost
Amount to bid per click, impression, or other event depending on the pricing model.
|
|||||
|
version
Details about the campaign’s version.
|
|||||
|
total_budget
|
|||||
|
version_tag
The version tag associated with the entity. |
|||||
|
objective_type
The Campaign Objective type values. The value can be:
|
|||||
|
offsite_preferences
The offsite preferences that an advertiser specifies for this campaign.
|
|||||
|
test
Indicates whether this campaign is a test campaign. |
|||||
|
format
The ad format on campaign level. The value can be:
|
|||||
|
pacing_strategy
The pacing option used for the campaign. |
campaign_groups
| Replication Method : |
Key-based Incremental |
Replication Key :
|
last_modified_time |
|
Primary Key :
|
id |
API endpoint : |
The campaign_groups table contains info about the campaign groups in your LinkedIn Ads account.
|
id
The campaign group ID. Reference: |
||
|
last_modified_time
The time the campaign group was last modified. |
||
|
account
URN identifying the advertising account associated with the campaign. |
||
|
account_id
The ID of the account associated with the campaign group. Reference: |
||
|
backfilled
Indicates whether the campaign group was created organically or to backfill existing campaigns. |
||
|
change_audit_stamps
|
||
|
created_time
The time the campaign group was created. |
||
|
name
The name of the campaign group used to make it easier to reference a campaign group and recall its purpose. |
||
|
run_schedule
Details about the campaign group’s run schedule.
|
||
|
serving_statuses
Array of enums that determine whether or not campaigns within the campaign group may be served.
|
||
|
status
The status of campaign group. Possible values are:
|
||
|
total_budget
|
||
|
test
Indicates whether this campaign group is a test campaign group. |
||
|
allowed_campaign_types
Array of enums that indicates allowed campaign types within the specific campaign group.
|
creatives
| Replication Method : |
Key-based Incremental |
Replication Key :
|
last_modified_at |
|
Primary Key :
|
id |
Official docs : |
The Creatives API contains all the data and information for visually rendering an ad.
|
account
URN identifying the advertising account associated with the creative. |
|||||
|
account_id
ID identifying the advertising account associated with the creative. |
|||||
|
campaign
URN identifying the campaign associated with the creative |
|||||
|
campaign_id
ID identifying the campaign associated with the creative |
|||||
|
content
Content sponsored in the creative.
|
|||||
|
created_at
Creation time |
|||||
|
created_by
Entity (e.g., a person URN) that developed the creative |
|||||
|
id
Unique ID for a creative (e.g.,SponsoredCreativeUrn). |
|||||
|
intended_status
Creative user intended status. |
|||||
|
is_serving
This indicates whether the creative is currently being served or not. |
|||||
|
is_test
True returns creatives only under test accounts. False returns creatives only under non-test accounts. |
|||||
|
last_modified_at
Time at which the creative was last modified. |
|||||
|
last_modified_by
The entity (e.g., person URN) who modified the creative |
|||||
|
serving_hold_reasons
Array that contains all the reasons why the creative is not serving.
|
video_ads
| Replication Method : |
Key-based Incremental |
Replication Key :
|
last_modified_time |
|
Primary Key :
|
content_reference |
API endpoint : |
The video_ads table contains info about the video ads in your LinkedIn Ads account.
|
content_reference
The content URN. |
||
|
last_modified_time
The time the video ad was last modified. |
||
|
account
The ad account associated with the video ad. |
||
|
account_id
The ID of the account associated with the video ad. Reference: |
||
|
change_audit_stamps
|
||
|
content_reference_share_id
|
||
|
content_reference_ucg_post_id
|
||
|
created_time
The time the video ad was created. |
||
|
name
Name of the |
||
|
owner
The owner of the organization. |
||
|
owner_organization_id
|
||
|
type
This will be |
| Related | Troubleshooting |
Questions? Feedback?
Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.