LinkedIn Ads Field Reference

Sample

 

https://connectors.windsor.ai/linkedin?api_key=[your API key]&date_preset=last_7d&fields=campaign,clicks,spend,impressions,date,source&_renderer=csv


Fields

IDTypeNameDescriptionReport
account_idTEXTAccount IDAdvertisement account IDAccount
account_nameTEXTAccount NameA label for the account.Account
account_typeTEXTAccount typeAccount typeAccount
accountidTEXTAccount ID (Duplicate)Advertisement account ID (Duplicate)Account
ad_form_descriptionTEXTForm DescriptionDescription of the form, visible to both the owner and the viewer.Form
ad_form_headlineTEXTForm HeadlineHeadline of the form, visible to both the owner and the viewer.Form
TEXTForm Legal DisclaimerAdvertiser's legal disclaimer to accompany this form. This is shown to the viewer in addition to a standard LinkedIn legal disclaimer. The max size is 2000 characters.Form
ad_form_nameTEXTForm NameName of the form, visible to the owner of the form but not visible to the viewer.Form
ad_form_statusTEXTForm StatusDRAFT, SUBMITTED, PAUSED, ARCHIVED, or CANCELED. Draft allows for editing. Submitted is servable if approved. Paused is stopped from serving by the advertiser. Archived is stopped from serving and should be separated from non-archived forms in any UI. Canceled forms cannot be used again, and all associated creatives will be canceled too.Form
ad_form_thank_you_messageTEXTForm Thank You MessageThe message displayed to a member after the form is submitted. The max size is 300 characters.Form
ad_form_thank_you_page_call_to_actionTEXTForm Thank You Page Call To ActionThe message displayed on the call-to-action button. It can be set to one of these values: LEARN_MORE, VIEW_NOW, DOWNLOAD_NOW, TRY_NOW, VISIT_COMPANY_WEBSITE (default). Note: This is just the text on the button. The URL is controlled by the landingUrl attribute.Form
ad_nameTEXT(Deprecated) Ad NameDeprecated field. Alias for sponsored_creative_content_title. Probably you are looking for 'Creative Ad Context DSC Name' (creative_content_data_share_ad_context_dsc_name)Creative
adnetwork_conversionsNUMERICAd Network ConversionsThe Ad Network Reported ConversionsAd Network
adnetwork_revenueNUMERICAd Network RevenueThe Ad Network Reported RevenueAd Network
answersTEXTAnswersAll answers on form responseForm
approximate_unique_impressionsNUMERICApproximate Unique ImpressionsThe approximate reach of the campaign. The number of unique member accounts with at least one impression.Performance
average_frequencyPERCENTAverage frequencyAverage number of impressions seen by each member account exposed to at least one impressionPerformance
campaignTEXTCampaignThe campaign nameCampaign
campaign_accountTEXTCampaign AccountAccount where campaign is runningCampaign
campaign_cost_typeTEXTCampaign Cost TypeCampaign cost typeCampaign
campaign_daily_budget_amountTEXTCampaign daily budget amountDaily Budget AmountCampaign
campaign_end_dateDATECampaign end dateCampaign End DateCampaign
campaign_group_backfilledBOOLEANCampaign Group BackfilledFlag that denotes whether the campaign group was created organically or to backfill existing campaigns. This is a read-only field set by the system.Campaign Group
campaign_group_idTEXTCampaign Group IDTumerical identifier for the campaign group. This is a read-only field set by the system.Campaign Group
campaign_group_nameTEXTCampaign Group NameThe name of the campaign group used to make it easier to reference a campaign group and recall its purpose. The value of this field cannot exceed 100 characters.Campaign Group
campaign_group_run_scedule_end_timeTIMESTAMPCampaign Group Run Scedule End TimeRepresents the exclusive (strictly less than) date when to stop running the associated campaigns under this campaign group. If this field is unset, it indicates an open range with no end date. This field is required if totalBudget is set.Campaign Group
campaign_group_run_scedule_start_timeTIMESTAMPCampaign Group Run Scedule Start TimeRepresents the inclusive (greater than or equal to) date when to start running the associated campaigns under this campaign group. This field is required.Campaign Group
campaign_group_statusTEXTCampaign Group StatusStatus of campaign group.Campaign Group
campaign_group_total_budgetNUMERICCampaign Group Total BudgetMaximum amount to spend across all associated campaigns and creatives for duration of the campaign group.Campaign Group
campaign_idTEXTCampaign IDThe campaign IDCampaign
campaign_start_dateDATECampaign Start DateCampaign Start DateCampaign
campaign_statusTEXTCampaign Group StatusStatus of campaign group.Campaign
campaign_total_budget_amountTEXTCampaign total budget amountTotal Budget AmountCampaign
campaign_typeTEXTCampaign TypeCampaign typeCampaign
card_clicksNUMERICCard ClicksThe number of clicks for each card of a carousel ad.Carousel Ad
card_clicks_viralNUMERICCard Clicks (Viral)The number of viralClicks for each card of a carousel ad.Carousel Ad
card_impressionsNUMERICCard ImpressionsThe number of impressions for each card of a carousel ad.Carousel Ad
card_impressions_viralNUMERICCard Impressions (Viral)The number of viralImpressions for each card of a carousel ad.Carousel Ad
card_indexTEXTCard IndexGroup results by conversion.Carousel Ad
clicksNUMERICClicksThe count of clicks.Performance
commentsNUMERICCommentsNumber of CommentsPerformance
completionsNUMERICCompletionsThe count of video ads that played 97-100% of the video.Video
conversion_attribution_typeTEXTConversion Attribution TypeThe model that describes how conversion actions are to be counted. Acceptable values are: LAST_TOUCH_BY_CAMPAIGN and LAST_TOUCH_BY_CONVERSIONConversion
conversion_createdDATEConversion Created DateConversion Created DateConversion
conversion_enabledBOOLEANConversion EnabledSet to true or false to enable or disable this rule from matching on the advertiser’s website. The initial state can be either, but only rules that are enabled will trigger conversion events.Conversion
conversion_idTEXTConversion IDConversion IDConversion
conversion_last_callback_atDATEConversion Last Callback At DateThe last time one or more of the URL match rules fired and called back to the server.Conversion
conversion_last_modifiedDATEConversion Last Modified DateA date corresponding to the last modification of this resource.Conversion
conversion_nameTEXTConversion NameA short name for this conversion.Conversion
conversion_pivotTEXTConversion PivotGroup results by conversion.Conversion
conversion_post_click_attribution_window_sizeTEXTConversion Post Click Attribution Window SizeSpecifies a user's settings on the post click attribution window in days.Conversion
conversion_typeTEXTConversion TypeThe type of the conversion.Conversion
conversion_view_through_attribution_window_sizeTEXTConversion View Through Attribution Window SizeSpecifies a user's settings on the view through (post view) attribution window in days.Conversion
conversionsNUMERICShare conversionsNumber of External Website Conversions after Post ViewCampaign
conversionvalueinlocalcurrencyNUMERICConversion Value (Local Currency)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.Performance
cost_in_usdNUMERICShare cost in USDCampaign Cost in USDCampaign
cost_per_externalwebsiteconversionsNUMERICCost Per External Website ConversionsCost in the account's local currency divided by the count of conversions indicated by pixel loads on an external advertiser website.Social Actions
cost_per_externalwebsitepostclickconversionsNUMERICCost Per External Website Post Click ConversionsCost in the account's local currency divided by the count of post-click conversions indicated by pixel loads.on an external advertiser website.Social Actions
cost_per_externalwebsitepostviewconversionsNUMERICCost Per External Website Post View ConversionsCost in the account's local currency divided by the count of post-view conversions indicated by pixel loads on an external advertiser website.Social Actions
cost_per_job_applicationNUMERICCost Per Job ApplicationCost in the account's local currency divided by the number of times a member completed a job applicationJob
country_codeCOUNTRYCountry CodeList of country codes of target locationsCountry
cpcNUMERICCPCCost-per-click (CPC)Performance
cpmNUMERICCPMCost per mille (CPM).It is the cost an advertiser pays for one thousand views or impressions of an advertisement (1000 * cost / impressions)Performance
creative_content_data_share_ad_context_ad_typeTEXTCreative Ad Context DSC Ad TypeThe type of DSC (e.g. VIDEO, STANDARD, CAROUSEL, etc.)Creative
creative_content_data_share_ad_context_dsc_nameTEXTCreative Ad Context DSC NamePlain text name of the DSC post.Creative
creative_content_data_share_ad_context_dsc_statusTEXTCreative Ad Context DSC StatusThe status of the advertising company content. Representing whether the content is usable from the advertiser's perspective as a DSCCreative
creative_creation_datetimeTIMESTAMPCreative Creation DatetimeCreative Creation Date and TimeCreative
creative_idTEXTCreative IDCreative IDCreative
creative_last_modified_datetimeTIMESTAMPCreative Last Modified DatetimeCreative Last Modified Date and TimeCreative
creative_statusTEXTCreative StatusCreative StatusCreative
ctrPERCENTCTRClick-through rate (CTR)Performance
currencyTEXTCurrencyAccount currency (default="USD")Account
dateDATEDateDates covered by the report data point. Date is specified in UTC.Time
engagement_ratePERCENTEngagement RateNumber of times members interacted with your ad (paid and free clicks divided by total impressions)Performance
engagementsNUMERICEngagementsThe total number of actions that people took on your Linkedin Ads.Performance
externalwebsiteconversionsNUMERICExternal Website ConversionsThe count of conversions indicated by pixel loads on an external advertiser website.Social Actions
externalwebsitepostclickconversionsNUMERICExternal Website Post Click ConversionsThe count of post-click conversions indicated by pixel loads on an external advertiser website.Social Actions
externalwebsitepostviewconversionsNUMERICExternal Website Post View ConversionsThe count of post-view conversions indicated by pixel loads on an external advertiser website.Social Actions
followsNUMERICFollowsThe count of follows. Sponsored Updates only.Social Actions
form_campaign_idTEXTForm Campaign IDCampaign id that this form response is connectedForm
form_creative_idTEXTForm Creative IDForm creative idForm
form_idTEXTResponse Form IDForm id of form responseForm
form_response_idTEXTForm Response idID of a Form response Form
full_screen_playsNUMERICShare full screen playsNumber of Full Screen PlaysSocial Actions
hidden_fieldsTEXTForm Hidden FieldsThe hidden fields which are not shown to viewers and only used by advertisers to track some key attributes of the form that generated the lead. Each form can have 0~20 hidden fields.Form
impression_device_typeTEXTImpression device typeGroup results by the device type the ad made an impression on. Reach metrics and conversion metrics will not be available when this pivot is used.Impression Device Type
impressionsNUMERICImpressionsThis is the count of "impressions" for Direct Ads and Sponsored Updates and "sends" for InMails.Performance
job_applicationsNUMERICJob ApplicationsThe number of times a member completed a job applicationafter viewing or clicking on an ad. Currently, this metric is broken down into postViewJobApplications (if the member applied after viewing the ad) and postClickJobApplications (if the member applied after clicking the ad).Job
job_apply_clicksNUMERICJob Apply ClicksThe 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. Currently, this metric is broken down into postViewJobApplyClicks (if the member performed the action after viewing the ad) and postClickJobApplyClicks (if the member performed the action after clicking the ad).Job
landing_pageTEXTLanding PageLanding PageCreative
landing_page_clicksNUMERICShare landing page clicksNumber of Clicks to the Landing PageCampaign
landingpageclicksNUMERICLanding Page ClicksThe count of clicks which take the user to the creative landing page.Performance
lead_typeTEXTLead type Form responseLead type of the Form responseForm
leadgenerationmailcontactinfosharesNUMERICLead Generation Mail Contact Info SharesThe number of times users shared contact info through the One Click Lead Gen for Sponsored InMail. Sponsored InMail only.Performance
likesNUMERICLikesThe count of likes. Sponsored Updates only.Performance
member_company_nameTEXTMember company nameCompany names of LinkedIn members engaged with campaignsMember Company Name
member_company_sizeTEXTMember company sizeApproximate company size of LinkedIn members engaged with campaignsMember Company Size
member_countryCOUNTRYMember countryCountries of LinkedIn members engaged with campaignsCountry
member_industryTEXTMember industryIndustry of LinkedIn members engaged with campaignsMember Industry
member_job_functionTEXTMember job functionJob functions of LinkedIn members engaged with campaignsMember Function
member_job_titleTEXTMember job titleJob titles of LinkedIn members engaged with campaignsDemographics
member_regionREGIONMember regionGeographic regions of LinkedIn members engaged with campaignsRegion
member_seniorityTEXTMember senioritySeniority of LinkedIn members engaged with campaignsMember Seniority
objective_typeTEXTObjective TypeCampaign Objective type values.Campaign
oneclickleadformopensNUMERICOne Click Lead Form OpensThe count of times users opened the lead form for a One Click Lead Gen campaign.Performance
oneclickleadsNUMERICOne Click LeadsThe count of leads generated through One Click Lead Gen.Performance
opensNUMERICOpensThe count of opens of Sponsored InMail. Sponsored InMail only.Performance
optimization_target_typeTEXTOptimization Target TypeDetermines how this campaign is optimized for spending. If this is not set, there is no optimization.Campaign
other_engagementsNUMERICShare other engagementsNumber of Other EngagementsCampaign
placement_nameTEXTPlacement NameGroup results by placement.Placement
quartile_1NUMERICVideo watches at 25%The count of video ads that played through the first quartile of the video.Video
quartile_2NUMERICVideo watches at 50%The count of video ads that played through the midpoint of the video.Video
quartile_3NUMERICVideo watches at 75%The count of video ads that played through the third quartile of the video.Video
reactionsNUMERICShare reactionsNumber of Reactions by CampaignCampaign
serving_locationTEXTService LocationGroup results by serving location, onsite or offsite.Serving Location
share_creation_datetimeTIMESTAMPShare creation datetimePost Creation Date and TimeCreative
share_idTEXTShare IDShare (Post) IDCreative
share_landing_pageTEXTShare landing pagePost landing pageCreative
share_last_modified_datetimeTIMESTAMPShare last modified datetimePost Last Modification Date and TimeCreative
share_textTEXTShare textPost TextCreative
share_titleTEXTShare titlePost TitleCreative
share_typeTEXTShare TypeShare/post media categoryCreative
sharesNUMERICSharesThis is the count of "shares" for sponsored Shares.Performance
spendNUMERICSpendCost in the account's local currencyPerformance
TEXTCreative DescriptionSponsored creative (ad) descriptionSponsored Creative
TEXTCreative Titlecreative (ad) titleSponsored Creative
submitted_atDATEForm Response submitted at timeForm response submitted time f: YYYY-MM-DDForm
targeting_exclude_agerangesOBJECTTargeting Exclude Age RangeA segment of members who will be excluded from the advertising campaign's targeting by organization.Campaign
targeting_exclude_employersOBJECTTargeting Exclude EmployersA segment of members who will be excluded from the advertising campaign's targeting by age rate.Campaign
targeting_exclude_groupsOBJECTTargeting Exclude GroupsA segment of members who will be excluded from the advertising campaign's targeting by groups.Campaign
targeting_exclude_industriesOBJECTTargeting Exclude IndustriesA segment of members who will be excluded from the advertising campaign's targeting by standardized industries.Campaign
targeting_exclude_interfacelocalesOBJECTTargeting Exclude Interface LocalesA segment of members who will be excluded from the advertising campaign's targeting by interface locales.Campaign
targeting_exclude_jobfunctionsOBJECTTargeting Exclude Job FunctionsA segment of members who will be excluded from the advertising campaign's targeting by standardized job functions.Campaign
targeting_exclude_locationsOBJECTTargeting Exclude LocationsA segment of members who will be excluded from the advertising campaign's targeting by locations.Campaign
targeting_exclude_senioritiesOBJECTTargeting Exclude SenioritiesA segment of members who will be excluded from the advertising campaign's targeting by standardized seniorities.Campaign
targeting_exclude_titlesOBJECTTargeting Exclude TitlesA segment of members who will be excluded from the advertising campaign's targeting by standardized titles.Campaign
targeting_include_agerangesOBJECTTargeting Include Age RangeA segment of members who will be included in the advertising campaign's targeting by organization.Campaign
targeting_include_employersOBJECTTargeting Include EmployersA segment of members who will be included in the advertising campaign's targeting by age rate.Campaign
targeting_include_groupsOBJECTTargeting Include GroupsA segment of members who will be included in the advertising campaign's targeting by groups.Campaign
targeting_include_industriesOBJECTTargeting Include IndustriesA segment of members who will be included in the advertising campaign's targeting by standardized industries.Campaign
targeting_include_interfacelocalesOBJECTTargeting Include Interface LocalesA segment of members who will be included in the advertising campaign's targeting by interface locales.Campaign
targeting_include_jobfunctionsOBJECTTargeting Include Job FunctionsA segment of members who will be included in the advertising campaign's targeting by standardized job functions.Campaign
targeting_include_locationsOBJECTTargeting Include LocationsA segment of members who will be included in the advertising campaign's targeting by locations.Campaign
targeting_include_senioritiesOBJECTTargeting Include SenioritiesA segment of members who will be included in the advertising campaign's targeting by standardized seniorities.Campaign
targeting_include_titlesOBJECTTargeting Include TitlesA segment of members who will be included in the advertising campaign's targeting by standardized titles.Campaign
test_leadBOOLEANIs this test lead?True/False is this test lead form responseForm
total_engagementsNUMERICShare total engagementsNumber of total EngagementsCampaign
totalcostNUMERICTotal CostCost in the account's local currency (Duplicate of Spend)Performance
transactionrevenueNUMERICTransaction Revenue (Local Currency)Conversion Value (Duplicate of Conversion Value (Local Currency))Performance
transactionsNUMERICTransactionsThe number of transactions (Duplicate of External Website Conversions)Social Actions
video_completionsNUMERICVideo CompletionsThe count of video ads that played 97-100% of the video.Video
video_startNUMERICVideo playsThe number of times a video starts to playVideo
video_startsNUMERICVideo plays (duplicate)The number of times a video starts to playVideo
video_viewed_25pcntNUMERICVideo watches at 25% (Duplicate)The count of video ads that played through the first quartile of the video. (Duplicate)Video
video_viewed_50pcntNUMERICVideo watches at 50% (Duplicate)The count of video ads that played through the midpoint of the video. (Duplicate)Video
video_viewed_75pcntNUMERICVideo watches at 75% (Duplicate)The count of video ads that played through the third quartile of the video. (Duplicate)Video
video_viewsNUMERICVideo views2 or more continuous seconds of playback while the video is at least 50% on screen, or a click on the CTA, whichever comes first.Video
viral_clicksNUMERICShare viral clicksNumber of Viral Clicks Aggregated by CampaignViral
viral_commentsNUMERICShare viral commentsNumber of Viral Comments by CampaignViral
viral_conversionsNUMERICViral External Website ConversionsThe count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.Campaign
viral_followsNUMERICShare viral followsNumber of Viral Follows by CampaignViral
viral_full_screen_playsNUMERICShare viral full screen playsNumber of Viral Full Screen PlaysViral
viral_impressionsNUMERICShare viral impressoinsNumber of Viral Impressions Aggregated by CampaignViral
viral_landing_page_clicksNUMERICShare viral landing page clicksNumber of Viral Clicks to the Landing PageCampaign
viral_likesNUMERICShare viral likesNumber of Viral Likes by CampaignViral
viral_reactionsNUMERICShare viral reactionsNumber of Viral Reactoins by CampaignViral
viral_sharesNUMERICShare viral sharesNumber of Viral Shares by ShareViral
viral_total_engagementsNUMERICShare viral total engagementsViral Total EngagementsViral
viral_video_completionsNUMERICShare viral video completionsNumber of Viral Video Views to 100%Viral
viral_video_startsNUMERICShare viral video startsNumber of Viral Video StartsViral
viral_video_viewed_25pcntNUMERICShare viral video viewed 25pcntNumber of Viral Video Views to 25%Viral
viral_video_viewed_50pcntNUMERICShare viral video viewed 50pcntNumber of Viral Video Views to 50%Viral
viral_video_viewed_75pcntNUMERICShare viral video viewed 75pcntNumber of Viral Video Views to 75%Viral
viral_video_viewsNUMERICShare viral video viewsNumber of Viral Video ViewsViral
viralexternalwebsiteconversionsNUMERICViral External Website Conversions (Duplicate)The count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.Viral
viralexternalwebsitepostclickconversionsNUMERICViral External Website Post Click ConversionsThe count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.Viral
viralexternalwebsitepostviewconversionsNUMERICViral External Website Post View ConversionsThe count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.Viral
viraloneclickleadsNUMERICViral One Click LeadsThe count of leads generated through One Click Lead Gen from viral impressions for this activity.Viral
todayDATETodayToday's date