LinkedIn Ads Connector Objects

NameDescription
AccountsThe Account status finder returns all accounts in a specified status that the authenticated user has access to.
AccountUsersRead data on your ad-account users.
AdFormResponsesQuery the response data for leads that filled out a Lead Form. Collecting Lead Form responses requires the user to be the owner of the Lead Form.
AnalyticsThe Analytics API provides account, campaign, and creative level insights on click intelligence numbers.
AudienceCountThe Audience Count API allows advertisers to forecast the reach of targeting criteria.
BrandLiftTestsRead data on brand lift tests in your LinkedIn ad-account.
BudgetPricingThe LinkedIn Budget Pricing API provides developers with key insights on pricing metrics (e.g. minimum, maximum and suggested bids) based on targeting criteria.
CampaignGroupsThe Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
CampaignsThe Ad Campaign status finder returns all campaigns in a specified status that the authenticated user has access to.
ConversationCreativeActionsRead data on actions in the conversation creatives in your LinkedIn ad-account.
ConversationCreativesRead data on conversation creatives in your LinkedIn ad-account.
ConversionsRetrieves a list of Conversions. Conversions are actions a member makes that are valuable to your business.
CreativesThe Ad Creatives search finder allows you to search for creatives by id, campaign URN, status, or reference URN.
DegreesDegree taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
DocumentsRead the metadata of the document assets in your accounts.
FieldsOfStudyFields of study taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
FormsQuery form data for the forms that belong to a specified owner (account).
GeoLocationsProvides the display name for a given geo Id, or a set of geo Ids.
IABCategoriesRead data on Interactive Advertising Bureau (IAB) categories.
ImagesRead the metadata of the image assets in your accounts.
IndustriesIndustry taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
JobFunctionsJob function taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
MessageCreativesRead data on message creatives in your LinkedIn ad-account.
OrganizationRoleAssignmentsRead access control information for the organizations in which you are a member.
PostsRetrieve all posts for an organization.
PublisherRestrictionFilesRead data on publisher restriction files used for restricting the sites which serve your ads off-network.
SenioritiesSeniority taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
SkillsSkills taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
SocialActionsThe socialActions API allows access to both personal and organization social actions.
TargetingEntitiesRead data on LinkedIn ad-targeting entities.
TargetingFacetsRead data on LinkedIn ad-targeting facets.
ThirdPartyTrackingUse thirdPartyTrackingTags to retrieve a previously created third-party tracking tag.
TitlesTitles taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.
VideosRead the metadata of the video assets in your accounts.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the account
NameStringFalseNoA label for the account
CurrencyStringFalseNoThe account's ISO-4217currency code.
TypeStringFalseNoThe type of account.
NotifiedOnCreativeRejectionBooleanFalseNoIndicates if creative contact is notified when a creative has been rejected due to content.
NotifiedOnEndOfCampaignBooleanFalseNoIndicates if campaign contact is notified when an associated campaign has been completed.
StatusStringFalseNoStatus of the account
NotifiedOnCampaignOptimizationBooleanFalseNoIndicates if campaign contact is notified about campaign optimization opportunities.
VersionStringTrueNoVersion of the account
ReferenceStringFalseNoThe entity on whose behalf the account advertises.
NotifiedOnCreativeApprovalBooleanFalseNoIndicates if creative contact is notified when a creative has been reviewed and approved.
AuditStampsCreatorStringTrueNoThe person who created audit stamps for the first time
AuditStampsCreatedAtDatetimeTrueNoThe datetime in which the audit stamp was created first
AuditStampsLastModifierStringTrueNoLast modifier of the Audit stamps
AuditStampsLastModifiedAtDatetimeTrueNoLast modified datetime of the audit stamps
IsTestBooleanFalseNoFlag showing whether this account is marked as a test account. An account can be marked as test only during creation. This is an immutable field.
URNStringTrueNoThe URN of the account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountURN [KEY]StringFalseNoThe unique identifier of the account in which the user belongs.
UserURN [KEY]StringFalseNoThe unique identifier of the user's LinkedIn profile.
RoleStringFalseNoThe user's role.
CreatedAtDatetimeTrueNoThe time when the user was created.
UpdatedAtDatetimeTrueNoThe time when the user was last modified.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoIdentifier for the form response.
AccountStringTrueAccounts.IdNoIdentifier for the owner of the form. This is the advertiser account.
CampaignStringTrueNoURN identifying the campaign to which the form response is responding.
CreativeStringTrueNoURN identifying the creative to which the form response is responding.
FormStringTrueNoURN identifying which form this response responds to.
SubmitedAtDatetimeTrueNoTimestamp for when the form response was submitted.
LeadTypeStringTrueNoType of the lead. This field indicates whether the lead is collected from sponsored content or viral share. Defaults to SPONSORED.
TestLeadBooleanTrueNoWhether the lead is a test lead.
ConsentResponsesStringTrueNoA JSON object containing all the consent responses.
AnswersStringTrueNoA JSON object containing all the answers and the respective questions.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CompanyStringTrueNoPivot value which groups the result by advertiser's company.
AccountStringTrueNoPivot value which groups the result by account.
ShareStringTrueNoPivot value which groups the result by sponsored share.
CampaignStringTrueNoPivot value which groups the result by campaign.
CreativeStringTrueNoPivot value which groups the result by creative.
CampaignGroupStringTrueNoPivot value which groups the result by campaign group.
ConversionStringTrueNoPivot value which groups the result by conversion.
ServingLocationStringTrueNoPivot value which groups the result by serving location.
CardIndexStringTrueNoPivot value which groups the result by card index.
MemberCompanySizeStringTrueNoPivot value which groups the result by member company size.
MemberIndustryStringTrueNoPivot value which groups the result by member industry.
MemberSeniorityStringTrueNoPivot value which groups the result by member seniority.
MemberJobTitleStringTrueNoPivot value which groups the result by member job title.
MemberJobFunctionStringTrueNoPivot value which groups the result by member job function.
MemberCountryStringTrueNoPivot value which groups the result by member country.
MemberRegionStringTrueNoPivot value which groups the result by member region.
MemberCountyStringTrueNoPivot value which groups the result by member county.
MemberCompanyStringTrueNoPivot value which groups the result by member company.
PlacementNameStringTrueNoPivot value which groups the result by member company.
ImpressionDeviceTypeStringTrueNoPivot value which groups the result by member company.
CampaignTypeStringTrueNoMatch result by campaign type.
GranularityStringTrueNoTime granularity of results.
FinderMethodStringTrueNoDesignates the query finder. The only allowed values are analytics or statistics.
ReportStartTimeStringTrueNoThe start time of the period.
ReportEndTimeStringTrueNoThe end time of the period.
EventStageStringTrueNoOrganize results based on the stage of the live event.
ActionClicksLongTrueNoThe count of clicks on the action button of the Sponsored InMail.
AdUnitClicksLongTrueNoThe count of clicks on the ad unit displayed alongside the Sponsored InMail.
CardClicksLongTrueNoThe number of clicks for each card of a carousel ad.
CardImpressionsLongTrueNoThe number of impressions shown for each card of a carousel ad.
ClicksLongTrueNoThe count of chargeable clicks.
CommentLikesLongTrueNoThe count of likes of a comment.
CommentsLongTrueNoThe count of comments. Sponsored.
CompanyPageClicksLongTrueNoThe count of clicks to view the company page.
ConversionValueInLocalCurrencyDecimalTrueNoValue of the conversions in the account's local currency based on rules defined by the advertiser.
CostInLocalCurrencyDecimalTrueNoCost in the account's local currency based on the pivot and timeGranularity.
CostInUsdDecimalTrueNoCost in USD based on the pivot and timeGranularity.
UsageStartTimeStringTrueNoDate start covered by the report data point.
UsageEndTimeStringTrueNoDate end covered by the report data point.
ExternalWebsiteConversionsLongTrueNoThe count of conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostClickConversionsLongTrueNoThe count of post-click conversions indicated by pixel loads on an external advertiser website.
ExternalWebsitePostViewConversionsLongTrueNoThe count of post-view conversions indicated by pixel loads on an external advertiser website.
FollowsLongTrueNoThe count of follows. Sponsored.
FullScreenPlaysLongTrueNoA user taps on the video, going into video view mode.
ImpressionsLongTrueNoThis is the count of 'impressions' for Direct Ads and Sponsored Updates and 'sends' for InMails.
LandingPageClicksLongTrueNoThe count of clicks which take the user to the creative landing page.
LeadGenerationMailContactInfoSharesLongTrueNoThe number of times a user shared contact info through the One Click Lead Gen for Sponsored InMail.
LeadGenerationMailInterestedClicksLongTrueNoThe count of InMail recipients showing interest.
LikesLongTrueNoThe count of likes.
OneClickLeadFormOpensLongTrueNoThe count of times a user opened the lead form for a One Click Lead Gen campaign.
OneClickLeadsLongTrueNoThe count of leads generated through One Click Lead Gen.
OpensLongTrueNoThe count of opens of Sponsored InMail.
OtherEngagementsLongTrueNoThe count of user interactions with the ad unit that do not fit into any other more specific category.
SharesLongTrueNoThe count of shares.
TextUrlClicksLongTrueNoThe count of clicks on any links (anchor tags) that were included in the body of the Sponsored InMail.
TotalEngagementsLongTrueNoThe count of all user interactions with the ad unit.
VideoCompletionsLongTrueNoThe count of video ads that played 97-100% of the video.
VideoFirstQuartileCompletionsLongTrueNoThe count of video ads that played through the first quartile of the video.
VideoMidpointCompletionsLongTrueNoThe count of video ads that played through the midpoint of the video.
VideoStartsLongTrueNoThe count of video ads that were started by a user.
VideoThirdQuartileCompletionsLongTrueNoThe count of video ads that played through the third quartile of the video.
VideoViewsLongTrueNoA video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
ViralCardClicksLongTrueNoThe number of viralClicks for each card of a carousel ad.
ViralCardImpressionsLongTrueNoThe number of viralImpressions shown for each card of a carousel ad.
ViralClicksLongTrueNoThe count of clicks on viral impressions.
ViralCommentsLongTrueNoThe count of comments from viral impressions for this activity.
ViralCompanyPageClicksLongTrueNoThe count of clicks to view the company page from viral impressions for this activity.
ViralExternalWebsiteConversionsLongTrueNoThe count of conversions indicated by pixel loads on an external advertiser website driven by a viral event.
ViralExternalWebsitePostClickConversionsLongTrueNoThe count of post-click conversions indicated by pixel loads on an external advertiser website driven by a viral click.
ViralExternalWebsitePostViewConversionsLongTrueNoThe count of post-view conversions indicated by pixel loads on an external advertiser website driven by a viral impression.
ViralFollowsLongTrueNoThe count of follows from viral impressions for this activity.
ViralFullScreenPlaysLongTrueNoA user taps on the video, going into video view mode.
ViralImpressionsLongTrueNoThe count of viral impressions for this activity.
ViralLandingPageClicksLongTrueNoThe count of clicks on viral impressions to take the user to the creative landing page.
ViralLikesLongTrueNoThe count of likes from viral impressions for this activity.
ViralOneClickLeadFormOpensLongTrueNoThe count of times a user opened the lead form for viral impressions from a Lead Gen campaign.
ViralOneClickLeadsLongTrueNoThe count of leads generated through One Click Lead Gen from viral impressions for this activity.
ViralOtherEngagementsLongTrueNoThe count of user interactions with viral impressions that do not fit into any other more specific category.
ViralSharesLongTrueNoThe count of shares from viral impressions for this activity.
ViralTotalEngagementsLongTrueNoThe count of all user interactions with a viral ad unit.
ViralVideoCompletionsLongTrueNoThe count of viral video ads that played 97-100% of the video.
ViralVideoFirstQuartileCompletionsLongTrueNoThe count of viral video ads that played through the first quartile of the video.
ViralVideoMidpointCompletionsLongTrueNoThe count of viral video ads that played through the midpoint of the video.
ViralVideoStartsLongTrueNoThe count of viral video ads that were started by a user.
ViralVideoThirdQuartileCompletionsLongTrueNoThe count of viral video ads that played through the third quartile of the video.
ViralVideoViewsLongTrueNoA viral video ad playing for at least 2 continuous seconds 50% in-view, or a click on the CTA, whichever comes first.
AverageDailyReachMetricsApproximateReachDecimalTrueNoThe average reach, or unique member accounts with at least one impression (daily).
AverageDailyReachMetricsApproximateFrequencyDecimalTrueNoThe average of impressions shown to each member account that received at least one impression (daily).
AverageDailyReachMetricsApproximateCostDecimalTrueNoThe average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (daily).
AveragePreviousSevenDayReachMetricsApproximateReachDecimalTrueNoThe average reach, or unique member accounts with at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateFrequencyDecimalTrueNoThe average of impressions shown to each member account that received at least one impression (last 7 days).
AveragePreviousSevenDayReachMetricsApproximateCostDecimalTrueNoThe average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 7 days).
AveragePreviousThirtyDayReachMetricsApproximateReachDecimalTrueNoThe average reach, or unique member accounts with at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateFrequencyDecimalTrueNoThe average of impressions shown to each member account that received at least one impression (last 30 days).
AveragePreviousThirtyDayReachMetricsApproximateCostDecimalTrueNoThe average of spend on your ads, divided by member accounts reached, multiplied by 1,000 (last 30 days).
ApproximateMemberReachLongTrueNoThe estimated number of unique member accounts with at least one impression. This metric is only available when the number of days in the date range is less than or equal to 92 days. It will be returned only if the following pivots/columns are specified in the query: Creative, Campaign, CampaignGroup, CampaignType and/or ServingLocation. Additionally, it will not be available for the current UTC day. The expected delay for current UTC day will be 24-48 hours. If the present day is specified in ReportEndTime, the date range will only return reach for days where data exists.
ValidWorkEmailLeadsLongTrueNoThe count of leads with a valid work email that does not use an established free or personal email domain.
PostClickRegistrationsDecimalTrueNoThe number of times a member has registered for an event or seminar after clicking on an ad which has a LinkedIn landing page.
PostViewRegistrationsDecimalTrueNoThe number of times a member has registered for an event or seminar after viewing an ad which has a LinkedIn event landing page.
DownloadClicksLongTrueNoThe number of times users have indicated the intent to download the media in an ad by clicking the download icon.
QualifiedLeadsLongTrueNoThe count of qualified leads shared by the advertiser. Qualified lead is a lead that has been deemed more likely to become a customer compared to other leads, based on their engagement and fit.
CostPerQualifiedLeadDecimalTrueNoHow much money was spent per qualified lead. Ratio is costInLocalCurrency / qualifiedLeads.
MessagingAdvertSendCountLongTrueNoThe count of sends of Sponsored Messaging ads.
MessagingAdvertOpenCountLongTrueNoThe count of opens of Sponsored Messaging ads.
AudiencePenetrationDecimalTrueNoThe approximate number of unique members reached by the advertiser divided by the approximate total target audience size. The field will be null if the date range has more than 92 days. This metric only supports the 'CAMPAIGN' pivot. This metric is not returned when using 'MONTHLY' granularity.
AverageDwellTimeLongTrueNoAverage user dwell time (in seconds). It measures the duration for which more than 50% of the ad's pixels remain visible in the viewport.
DocumentCompletionsLongTrueNoThe number of times users reached 100% of the document’s length, including those that skipped to this point.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ActiveAudienceIntegerTrueNoActive audience count for the given targeting criteria.
TotalAudienceIntegerTrueNoTotal audience count for the given targeting criteria.
AgeRangeStringFalseYesAge ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeIdStringFalseYesEducational degrees attained to match against those of the member.
FieldOfStudyIdStringFalseYesFields of study to match against those listed by the member.
GenderStringFalseYesGenders to match against member. Supported values are: MALE, FEMALE
IndustryIdStringFalseYesIndustries to be targeted.
JobFunctionIdStringFalseYesTop level groupings of supertitles to be targeted.
LocationIdStringFalseYesLocation to be targeted.
ProfileLocationIdStringFalseYesThe values are similar to
SeniorityIdStringFalseYesSeniorities to be targeted.
SkillIdStringFalseYesSkills to match against the member's listed skills.
StaffCountRangeStringFalseYesOrganization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleIdStringFalseYesJob titles to match against the member's current title.
AudienceMatchingSegmentIdStringFalseYesAn Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentIdStringFalseYesAn Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerIdStringFalseYesEmployer ID to match against member's listed companies.
CompanyIdStringFalseYesCompany ID to match against member's listed companies.
InterfaceLocaleIdStringFalseYesLocale ID to match against member's preferred locale settings.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identifier of the brand lift test.
AccountURNStringFalseNoThe URN of the ad-account to which this brand lift test belongs.
NameStringFalseNoThe name of the brand lift test.
DescriptionStringFalseNoThe brand lift test's description.
CampaignGroupURNStringFalseNoThe URN of the campaign group to include in the brand lift test. When specified, only campaigns within this group will be measured. Otherwise, the test will analyze all campaigns across the entire ad account.
BrandNameStringFalseNoThe brand name used when surveying LinkedIn users with this brand lift test.
BrandNameLocaleLanguageStringFalseNoThe locale language of the brand name. A lowercase two-letter language code as defined by ISO-639.
BrandNameLocaleCountryStringFalseNoThe locale country of the brand name. An uppercase two-letter country code as defined by ISO-3166.
UserStateStringFalseNoThe state used by the advertiser to control the brand lift test.
ExecutionStateStringTrueNoThe execution state of the brand lift test derived from the 'UserState' column and internal state of the LinkedIn platform.
StartTimeDatetimeFalseNoThe scheduled start time of the brand lift test.
EndTimeDatetimeFalseNoThe scheduled end time of the brand lift test.
EndedAtDatetimeTrueNoThe actual end time of the brand lift test. LinkedIn may terminate the brand lift test before the time specified in the 'EndTime' column.
EndReasonStringTrueNoThe reason why the brand lift test ended.
ContentReviewVersionLongTrueNoA long value representing the content version that was reviewed in accordance to LinkedIn content policies.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
SuggestedBidDefaultStringTrueNoThe suggested bid
SuggestedBidMinStringTrueNoLow end of suggested bid range
SuggestedBidMaxStringTrueNoHigh end of suggested bid range
DailyBudgetLimitsDefaultStringTrueNoDefault daily budget
DailyBudgetLimitsMinStringTrueNoMinimum daily budget
DailyBudgetLimitsMaxStringTrueNoMaximum daily budget
BidLimitsMaxStringTrueNoThe maximum bid allowed
BidLimitsMinStringTrueNoThe minimum bid allowed, also known as the floor price
AccountStringTrueNoSponsored account URN.
CampaignTypeStringTrueNoThe campaign type.
BidTypeStringTrueNoThe bidding type.
MatchTypeStringTrueNoThe matching type.
AgeRangeStringFalseYesAge ranges to match against member. Supported values are: (18,24), (25,34), (35,54), (55,2147483647)
DegreeIdStringFalseYesEducational degrees attained to match against those of the member.
FieldOfStudyIdStringFalseYesFields of study to match against those listed by the member.
GenderStringFalseYesGenders to match against member. Supported values are: MALE, FEMALE
IndustryIdStringFalseYesIndustries to be targeted.
JobFunctionIdStringFalseYesTop level groupings of supertitles to be targeted.
LocationIdStringFalseYesLocation to be targeted.
ProfileLocationIdStringFalseYesThe values are similar to
SeniorityIdStringFalseYesSeniorities to be targeted.
SkillIdStringFalseYesSkills to match against the member's listed skills.
StaffCountRangeStringFalseYesOrganization sizes to be targeted. Supported values are: (1,1), (2,10), (11,50), (51,200), (201,500), (501,1000), (1001,5000), (5001,10000), (10001,2147483647)
TitleIdStringFalseYesJob titles to match against the member's current title.
AudienceMatchingSegmentIdStringFalseYesAn Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
RetargetingSegmentIdStringFalseYesAn Ad segment is a collection of entities (such as members or companies) to which ads can be targeted.
EmployerIdStringFalseYesEmployer ID to match against member's listed companies.
CompanyIdStringFalseYesCompany ID to match against member's listed companies.
InterfaceLocaleIdStringFalseYesLocale ID to match against member's preferred locale settings.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoNumerical identifier for the campaign group
AccountStringFalseNoURN identifying the advertising account associated with the Campaign Group. This value is immutable once set
NameStringFalseNoThe name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose
StatusStringFalseNoCurrent Status of the campaign group
TotalBudgetAmountDecimalFalseNoMaximum amount to spend over the life of the Campaign Group.
TotalBudgetCurrencyCodeStringFalseNoISO currency code. The currency code must match that of the parent account.
ScheduleStartTimeDatetimeFalseNoRepresents the inclusive (greater than or equal to) value in which to start the range.
ScheduleEndTimeDatetimeFalseNoScheduled date range to run associated objects.
BackfilledBooleanTrueNoFlag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns.
AdAccountIdStringFalseNoId of the account
URNStringTrueNoThe URN of the campaign group.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoNumerical identifier for the campaign
AccountStringFalseNoURN identifying the advertising account associated with the Campaign.
CampaignGroupStringFalseNoNumerical identifier for the campaign group.
AssociatedEntityStringFalseNoAn URN for a strongly associated object, with semantics varying based on the Campaign type.
AudienceExpansionEnabledBooleanFalseNoEnable Audience Expansion for the campaign provides query expansion for certain targeting criteria
CostTypeStringFalseNoCPM - Cost per thousand advertising impressions. CPC - Cost per individual click on the associated link
CreativeSelectionStringFalseNoROUND_ROBIN - Rotate through available creatives to serve them as easily as possible. OPTIMIZED - Bias selection taking into account such things as expected performance
DailyBudgetAmountStringFalseNoThe amount of money as a real number string
DailyBudgetCurrencyStringFalseNoISO currency code
CountryStringFalseNoAn uppercase two-letter country code as defined by ISO-3166.
LanguageStringFalseNoA lowercase two-letter language code as defined by ISO-639.
NameStringFalseNoThe name of the Campaign
OffsiteDeliveryEnabledBooleanFalseNoAllow this campaign access to be served on the LinkedIn Advertising Network.
ScheduleStartTimeDatetimeFalseNoScheduled date range to run associated creatives.
ScheduleEndTimeDatetimeFalseNoScheduled date range to run associated creatives.
StatusStringFalseNoCurrent Status of the campaign
TypeStringFalseNoType of campaign
UnitCostAmountStringFalseNoAmount to bid per click, impression, or other event depending on the pricing model.
UnitCostCurrencyStringFalseNoCurrency of the UnitCostAmount
ObjectiveTypeStringFalseNoThe Campaign Objective type.
AdAccountIdStringFalseNoId of the account
ConnectedTelevisionOnlyBooleanFalseNoFlag showing whether this campaign is a Connected Television Only campaign. Allow advertisers to specify when they’re creating a CTV campaign. Not specifying the boolean can be considered false.
TimeSpanDurationIntegerFalseNoRepresents the length of time.
TimeSpanUnitStringFalseNoRepresents the unit of the duration of time
FrequencyIntegerFalseNoThe number of times the campaign is shown to a member.
OptimizationTypeStringFalseNoType of the frequency optimization strategy.
OptimizationTargetTypeStringFalseNoDetermines how this campaign is optimized for spending. If this is not set, there is no optimization.
BlockedIABCategoriesStringFalseNoThe list of mobile application IAB (Interactive Advertising Bureau) categories that are prohibited from serving the campaign's advertisements off-network.
AllowedPublisherRestrictionFilesStringFalseNoThe list of publisher restriction files containing the sites allowed to serve the campaign's advertisements off-network.
BlockedPublisherRestrictionFilesStringFalseNoThe list of publisher restriction files containing the sites prohibited from serving the campaign's advertisements off-network.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe URN of the action.
ConversationCreativeURNStringTrueConversationCreatives.URNNoThe URN of the conversation creative to which the action belongs.
BodyContentStringTrueNoThe content of the conversation creative action. Represented in JSON format.
NextActionsStringTrueNoThe next actions that can be taken after the user chooses the current action. Represented in JSON format.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe URN of the conversation creative.
HeadlineStringTrueNoThe headline of the conversation creative.
FirstActionURNStringTrueConversationCreativeActions.URNNoThe URN of the first action in the conversation creative that can be taken by the target audience.
AccountURNStringTrueNoThe URN of the ad-account to which this conversation creative belongs.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoNumerical identifier for the Conversion.
AccountStringFalseNoURN identifying the advertising account associated with the Conversion.
NameStringFalseNoA short name for this rule, which will be shown in the UI and in reports.
CreatedDatetimeTrueNoThe timestamp when the Conversion was created.
LastModifiedDatetimeTrueNoThe timestamp when the Conversion was last modified.
LastCallbackAtDatetimeTrueNoThe timestamp of the last callback from the Conversion.
AmountStringFalseNoThe amount of money as a real number string.
CurrencyCodeStringFalseNoIdentifying code for currency type. See currency codes for the valid codes.
TypeStringFalseNoThe type of the rule.
EnabledBooleanFalseNoSet to true or false to enable or disable this rule from matching on the advertiser's website.
ImagePixelTagStringTrueNoThe HTML representation of the image pixel.
PostClickAttributionWindowSizeIntegerFalseNoThe HTML representation of the image pixel.
ViewThroughAttributionWindowSizeIntegerFalseNoThe HTML representation of the image pixel.
AutoAssociationTypeStringFalseNoA type enum that defines how campaigns should be associated with the conversion rule.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoNumerical identifier for the creative.
AccountStringTrueNoURN identifying the advertising account associated with the creative.
CampaignStringFalseNoURN identifying the campaign associated with the creative.
ContentStringFalseNoContent sponsored in the creative.
CreatedAtDatetimeTrueNoDatetime when the creative was first created
CreatedByStringTrueNoEntity that developed the creative.
IntendedStatusStringFalseNoCreative user intended status.
IsServingBooleanTrueNoThis indicates whether the creative is currently being served or not.
ServingHoldReasonsStringTrueNoArray that contains all the reasons why the creative is not serving.
LastModifiedAtDatetimeTrueNoDatetime when the creative was last modified.
LastModifiedByStringTrueNoEntity that modified the creative.
ReviewStatusStringTrueNoThe current review status of the creative.
IsTestBooleanTrueNoFlag showing whether this creative is a test creative, i.e., belongs to a test campaign.
AdAccountIdStringFalseNoId of the account.
CallToActionLabelStringFalseNoLabel for the CallToAction button. Present only if the campaign objective is LEAD_GENERATION.
CallToActionFormIdStringFalseForms.IdNoThe Id of the corresponding form which the call to action redirects to. Present only if the campaign objective is LEAD_GENERATION.
RejectionReasonsStringTrueNoA comma-seperated list of values with reasons explaining why the creative has been rejected.
NameStringFalseNoThe name of the creative that can be set by advertiser; primarily used to make it easier to reference a Creative and to recall its purpose.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoDegree id
URNStringTrueNoStandardized degree URN
NameStringTrueNoDegree name in various locales. Represented as MultiLocaleString type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe URN of the document.
OwnerURNStringTrueNoThe URN of the entity who owns the document.
DownloadURLStringTrueNoThe URL for downloading the document.
DownloadURLExpiresAtDatetimeTrueNoThe time when the URL for downloading the document expires.
StatusStringTrueNoThe status of the document.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoField of study id
URNStringTrueNoStandardized field of study URN
NameStringTrueNoField of study name in various locales. Represented as MultiLocaleString type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoIdentifier for the form.
AccountStringFalseAccounts.IdNoIdentifier for the owner of the form. This is the advertiser account.
CreatedTimestampTrueNoTimestamp for creation of the form.
LastModifiedTimestampTrueNoTimestamp for last modification of the form.
DescriptionStringFalseNoDescription of the form, visible to both the owner and the viewer.
HeadlineStringFalseNoHeadline of the form, visible to both the owner and the viewer.
LandingPageStringFalseNoThe landing page URL after the viewer clicks on submit.
MessageStringFalseNoThe message displayed to a member after the Lead Form is submitted.
LegalDisclaimerStringFalseNoAdvertiser's legal disclaimer to accompany this form.
QuestionsStringFalseNoQuestions to request information from the viewer. At least one question should be present.
NameStringFalseNoName of the form, visible to the owner of the form but not visible to the viewer.
PrivacyPolicyStringFalseNoThe URL of the privacy policy that covers any data passed to the owner of the form.
CountryStringFalseNoA lowercase two-letter language code as defined by ISO-639-1
LanguageStringFalseNoAn uppercase two-letter country code as defined by ISO-3166.
ReviewStatusStringTrueNoThe status of the review of the form.
ReviewedAtTimestampTrueNoTimestamp for when the form's review status was initiated/last updated.
StatusStringFalseNoIndicates the state of review for the Lead Form. Can be one of the following: DRAFT, PUBLISHED, or ARCHIVED.
VersionTagStringTrueNoThe number of times the form has been modified.
HiddenFieldsStringFalseNoHidden fields used by marketers to track key attributes of the form that generated the lead. Represented in JSON format.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoIdentifier for the location.
NameStringTrueNoThe name of the location.
LocaleCountryStringTrueNoAn uppercase two-letter country code as defined by ISO-3166.
LocaleLanguageStringTrueNoA lowercase two-letter language code as defined by ISO-639.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identifier of the IAB category.
URNStringTrueNoThe URN of the IAB category.
NameStringTrueNoThe name of the IAB category in 'en_US' locale.
IABNameStringTrueNoThe original name of the IAB category, as described in the OpenRTB 2.3 specification.
ParentIdStringTrueIABCategories.IdNoThe unique identifier of the parent IAB category.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe URN of the image.
AccountURNStringTrueNoThe URN of the ad-account to which this image belongs.
MediaLibraryNameStringFalseNoThe name of the image asset in the media library.
MediaLibraryStatusStringFalseNoThe status of the image asset in the media library.
OwnerURNStringTrueNoThe URN of the entity who owns the image.
DownloadURLStringTrueNoThe URL for downloading the image.
DownloadURLExpiresAtDatetimeTrueNoThe time when the URL for downloading the image expires.
StatusStringTrueNoThe status of the image.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoIndustry id
URNStringTrueNoStandardized industry URN
NameStringTrueNoIndustry name in various locales. Represented as MultiLocaleString type.
ChildrenIndustriesStringTrueNoThe URNs of the children industries associated with this node.
ParentIndustriesStringTrueNoThe URNs of the parent industry associated with this node.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoJob function id
URNStringTrueNoStandardized Job function URN
NameStringTrueNoJob function name in various locales. Represented as MultiLocaleString type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe URN of the message creative.
NameStringFalseNoThe name of the message creative.
SubjectStringFalseNoThe subject of the message creative.
BodyContentStringFalseNoThe HTML content of the message creative.
FooterContentStringFalseNoThe terms and conditions of the message creative, located at the bottom of the message.
SubContentStringFalseNoThe sub-content of the message creative. This can vary depending on the advertiser's goal. Represented in JSON format.
SenderURNStringFalseNoThe URN of the LinkedIn user which will be used to send the message creative to the targeted audience.
AccountURNStringFalseNoThe URN of the ad-account to which this message creative belongs.
CreatedAtDatetimeTrueNoThe time when the message creative was created.
UpdatedAtDatetimeTrueNoThe time when the message creative was last modified.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OrganizationURN [KEY]StringTrueNoThe unique identifier of the organization.
MemberURN [KEY]StringTrueNoThe unique profile identifier of the member to which the role has been assigned to.
Role [KEY]StringTrueNoThe role assigned to the member for managing the organization.
StateStringTrueNoThe state of the role assignment.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the post.
AuthorStringFalseNoAuthor of the post.
CommentaryStringFalseNoThe user generated commentary for the post.
ContentStringFalseNoThe posted content.
CreatedAtDatetimeTrueNoDatetime when the post was created.
IsReshareDisabledByAuthorBooleanFalseNoIndicates whether resharing of the post has been disabled by the author.
LastModifiedAtDatetimeTrueNoDatetime when the post was lastly modified.
LifecycleStateStringFalseNoLifecycle state of the post.
PublishedAtDatetimeTrueNoDatetime at which the content was published.
VisibilityStringFalseNoVisibility restrictions on content.
OrganizationIdStringTrueNoId of the organization who created the post.
ContentLandingPageStringFalseNoWeb page that is opened when the member clicks on the associated content.
IsDirectSponsoredContentBooleanTrueNoWhether or not this post is Direct Sponsored Content.
DirectSponsoredContentAdAccountStringTrueNoThe Ad Account that created the Direct Sponsored Content.
DirectSponsoredContentAdTypeStringTrueNoThe type of Direct Sponsored Content.
DirectSponsoredContentNameStringFalseNoPlain text name of the Direct Sponsored Content post.
DirectSponsoredContentStatusStringFalseNoThe status of the advertising company content.
FeedDistributionStringFalseNoDistribution of the post both in LinkedIn and externally.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identifier of the restriction file.
URNStringTrueNoThe URN of the restriction file.
NameStringFalseNoThe name of the restriction file.
RestrictionTypeStringFalseNoThe restriction type of the file.
MediaURNStringFalseNoThe media URN with details on the uploaded file's location.
StatusStringTrueNoThe status of the restriction file.
AccountURNStringFalseNoThe unique identifier of the ad-account in which the restriction file exists.
CreatedAtDatetimeTrueNoThe time when the restriction file was created.
UpdatedAtDatetimeTrueNoThe time when the restriction file was last modified.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoSeniority id
URNStringTrueNoStandardized Seniority URN
NameStringTrueNoSeniority name in various locales. Represented as MultiLocaleString type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoskill id
NameStringTrueNoskill name in various locales. Represented as MultiLocaleString type.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TotalFirstLevelCommentsIntegerTrueNoTotal number of first level comments.
AggregatedTotalCommentsIntegerTrueNoTotal number of aggregated comments.
LikedByCurrentUserBooleanTrueNoIndicator if the post is liked by current user.
TotalLikesIntegerTrueNoTotal number of likes.
TargetStringTrueNoTotal number of likes.
UGCPostIdStringTruePosts.IdNoId of UGC Post.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe ad-targeting entity URN.
NameStringTrueNoThe name of the ad-targeting entity.
FacetURNStringTrueTargetingFacets.URNNoThe URN of the ad-targeting facet to use for searching entities.
TypeaheadEntityTypeStringTrueNoThe entity type to search for with the 'TYPEAHEAD' finder.
TypeaheadCriteriaStringTrueNoThe name of the entity to search for with the 'TYPEAHEAD' finder.
SimilarEntityURNStringFalseYesThe URN of an entity to use for finding other similar entities with the 'SIMILAR_ENTITIES' finder.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe facet URN.
NameStringTrueNoThe name of the facet.
EntityTypesStringTrueNoThe entity types associated with this facet.
EntityFindersStringTrueNoThe available targeting entity finders for this facet.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe campaign to which this recommendation belongs.
CreativeStringFalseNoThe campaign to which this recommendation belongs.
AccountStringTrueNoThe average spend of the entity.
EventStringFalseNoThe currency code of the average spend.
PlatformStringFalseNoA prediction of how much additional impressions could be generated from a different bid.
TrackingUrlStringFalseNoThe currency code of additional impressions.
CreatedTimestampTrueNoA prediction of how much additional impressions could be generated from a different bid.
LastModifiedTimestampTrueNoDate at which the ad entity's TotalBudget will be exhausted, in Unix Epoch time.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringTrueNoTitles id
URNStringTrueNoStandardized Titles URN
NameStringTrueNoTitles name in various locales. Represented as MultiLocaleString type.
FunctionStringTrueNoThe function URN that this title belongs to.
SuperTitleStringTrueNoThe superTitle URN that this title belongs to.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
URN [KEY]StringTrueNoThe URN of the video.
AccountURNStringTrueNoThe URN of the ad-account to which this video belongs.
MediaLibraryNameStringFalseNoThe name of the video asset in the media library.
MediaLibraryStatusStringFalseNoThe status of the video asset in the media library.
OwnerURNStringTrueNoThe URN of the entity who owns the video.
DownloadURLStringTrueNoThe URL for downloading the video.
DownloadURLExpiresAtDatetimeTrueNoThe time when the URL for downloading the video expires.
StatusStringTrueNoThe status of the video.
AspectRatioHeightDecimalTrueNoThe aspect ratio height of the video.
AspectRatioWidthDecimalTrueNoThe aspect ratio width of the video.
DurationLongTrueNoThe duration of the video.
ThumbnailDownloadURLStringTrueNoThe URL for downloading the video's thumbnail.
CaptionsDownloadURLStringTrueNoThe URL for downloading the video's captions.

Return to Top