Linkedin

id

text

[en] Unique internal ID representing the account

status

text

[en] ACTIVE – Account is active; this is the default state; CANCELED – Account has been permanently canceled; DRAFT – Account is in draft status, meaning it's not yet fully set up and it is not serving; PENDING_DELETION – Denotes that the account has been requested to be deleted that is currently pending; REMOVED – Denotes that the account was deleted, but must remain fetchable due to the existence of performance data.

reference

text

[en] The entity on whose behalf the account is advertised. Must either be in the format urn:li:person:{id} (for persons) or urn:li:organization:{id} (for organizations). Only organization ad accounts are supported

    Páginas de organizações > > organization_urn

notifiedoncreativerejection

boolean

[en] Indicates if the creative contact is notified when a creative has been rejected due to content

currency

text

[en] The 3 character standard currency code such as USD for United States Dollar. Note: Advertisers selecting Brazilian Real (BRL) as a currency see their account budget, advertising bids, and spend in BRL, but their account is billed in USD.

changeauditstamps__lastmodified

float

changeauditstamps__created

float

name

text

[en] A label for the account

notifiedonendofcampaign

boolean

[en] Indicates if the campaign contact is notified when an associated campaign has been completed

version__versiontag

float

notifiedoncampaignoptimization

boolean

[en] Indicates if the campaign contact is notified about campaign optimization opportunities

servingstatuses

text

[en] An array of enums with information about the account's system serving statuses. If an account is eligible for serving, then the array has a single element: RUNNABLE. Otherwise, the array contains one or more reasons why the account is not servable: STOPPED, BILLING_HOLD, ACCOUNT_TOTAL_BUDGET_HOLD, ACCOUNT_END_DATE_HOLD, RESTRICTED_HOLD

notifiedoncreativeapproval

boolean

[en] Indicates if the creative contact is notified when a creative has been reviewed and approved

type

text

[en] BUSINESS (created via API) or ENTERPRISE (created by LinkedIn)

id

text

[en] Campaign ID

name

text

[en] The name of the campaign; primarily used to make it easier to reference a campaign and to recall its purpose

account_id

text

[en] ID identifying the advertising account associated with the campaign – calculated by Kondado from API field account

    Contas de anúncios > > id

associated_entity_reference

text

[en] An URN identifying the intended beneficiary of the advertising campaign such as a specific company or member

associated_entity_id

text

[en] An ID identifying the intended beneficiary of the advertising campaign such as a specific company or member – calculated by Kondado from API field associatedEntity

campaign_group_reference

text

[en] URN identifying the campaign group associated with the campaign

campaign_group_id

text

[en] ID identifying the campaign group associated with the campaign – calculated by Kondado from API field campaignGroup

    Detalhes dos grupos de campanhas > > id

audienceexpansionenabled

boolean

[en] Enable Audience Expansion for the campaign provides query expansion for certain targeting criteria

changeauditstamps_created_time

timestamp

changeauditstamps_lastmodified_time

timestamp

costtype

text

[en] *CPM*: Cost per thousand advertising impressions. If type=SPONSORED_INMAILS, cost per send (CPS) is measured as CPM x 1000; *CPC*: Cost per individual click on the associated link; *CPV*: Cost per view for video ads.

creativeselection

text

[en] *ROUND_ROBIN*: Rotate through available creatives to serve them as evenly as possible; *OPTIMIZED*: Bias selection taking into account such as expected performance. Not available for Message and Conversation Ads (type=SPONSORED_INMAILS)

format

text

[en] The ad format on campaign level. Read more: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/campaign-formats

locale_country

text

[en] Locale of the campaign. An uppercase two-letter country code as defined by ISO-3166.

locale_language

text

[en] Locale of the campaign. A lowercase two-letter language code as defined by ISO-3166.

objectivetype

text

[en] Campaign Objective type values. Read more: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads-reporting/ad-budget-pricing-type-combinations

offsitedeliveryenabled

boolean

optimizationtargettype

text

[en] Determines how this campaign is optimized for spending. If this is not set, there is no optimization. Read more: https://docs.microsoft.com/en-us/linkedin/marketing/integrations/ads/account-structure/create-and-manage-campaigns?tabs=http#campaign-types-schema

pacingstrategy

text

[en] Identifies the pacing option used for the campaign. Possible values: *LIFETIME*: Lifetime pacing that optimizes campaign budget delivery throughout campaign`s lifetime

runschedule_end

timestamp

[en] Scheduled date range to run associated creatives. Represents the exclusive (strictly less than) value in which to end the range. This field is optional. An unset field indicates an open range

runschedule_start

timestamp

[en] Scheduled date range to run associated creatives. The start date must be non-null. Represents the inclusive (greater than or equal to) value in which to start the range

servingstatuses

text

[en] Listing of values that determine whether or not a campaign may be served; unlike status, which is user-managed, the values are controlled by the service. This is a read-only field. Possible values are *RUNNABLE*: Campaign is eligible for serving; *STOPPED*: Campaign is currently not servable for reasons other than billing information, budgetary constraints, or termination dates. For instance, an campaign will be STOPPED if it has been PAUSED by the user; *ACCOUNT_TOTAL_BUDGET_HOLD*: Parent account total budget has been reached; *ACCOUNT_END_DATE_HOLD*: Parent account end date has been reached; *CAMPAIGN_START_DATE_HOLD*: Campaign start date is in the future; *CAMPAIGN_END_DATE_HOLD*: Campaign end date has been reached; *CAMPAIGN_TOTAL_BUDGET_HOLD*: Campaign total budget has been reached; *CAMPAIGN_AUDIENCE_COUNT_HOLD*: Campaign is on hold because it has an audience count lower than the threshold; *CAMPAIGN_GROUP_START_DATE_HOLD*: Campaign group start date is in the future; *CAMPAIGN_GROUP_END_DATE_HOLD*: Campaign Group end date is in the past; *CAMPAIGN_GROUP_TOTAL_BUDGET_HOLD*: Campaign group total budget has been reached; *CAMPAIGN_GROUP_STATUS_HOLD*: Campaign group status is on hold; *ACCOUNT_SERVING_HOLD*: Parent account is on hold and not eligible for serving;

status

text

[en] *ACTIVE*: Denotes that the campaign is fully servable; *PAUSED*: Denotes that the campaign meets all requirements to be served, but temporarily should not be; *ARCHIVED*: Denotes that the campaign is presently inactive, and should mostly be hidden in the UI until un-archived; *COMPLETED*: Denotes that the campaign has reached a specified budgetary or chronological limit; *CANCELED*: Denotes that the campaign has been permanently canceled, such as when an advertising account is permanently closed; *DRAFT*: Denotes that the campaign is still being edited and not eligible for serving. Some validation will be postponed until the campaign is activated

storydeliveryenabled

boolean

test

boolean

[en] Flag showing whether this campaign is a test campaign, i.e., belongs to a test account. This is a read-only and immutable field that is set implicitly during creation based on whether the account is a Test Account or not

totalbudget_amount

float

[en] Maximum amount to spend over the life of the campaign

totalbudget_currencycode

text

[en] ISO currency code

dailybudget_amount

float

[en] Maximum amount to spend per day

dailybudget_currencycode

text

[en] ISO currency code

type

text

[en] *TEXT_AD*: Text-based ads that show up in the right column or top of the page on LinkedIn; *SPONSORED_UPDATES*: Native ads that promote a company`s content updates in the LinkedIn feed; *SPONSORED_INMAILS*: Personalized messages with a call-to-action button delivered to a LinkedIn`s member inbox; *DYNAMIC*: Ads that are dynamically personalized

unitcost_amount

float

[en] Amount to bid (for manual bidding) or amount which is the target cost (for target cost bidding) per click, impression, or other event depending on the pricing model. The amount of money as a real number string. The amount should be non-negative if the bidding strategy is manual bidding or target cost bidding. The default is 0 with the currency code set to match that of the associated account

unitcost_currencycode

text

[en] Amount to bid per click, impression, or other event depending on the pricing model. The default is 0 with the currency code set to match that of the associated account. ISO currency code

version_versiontag

text

[en] Each entity has a version tag associated with it. The version tag is initiated to 1 when the entity is created. Each single update to the entity increases its version tag by 1

id

text

[en] Campaign Group ID

account_reference

text

[en] URN identifying the advertising account associated with the Campaign Group

account_id

text

[en] ID identifying the advertising account associated with the Campaign Group – calculated by Kondado from API field account

    Contas de anúncios > > id

backfilled

boolean

[en] Flag that denotes whether the Campaign Group was created organically or was created to backfill existing campaigns. This is a system controlled field

changeauditstamps_created_time

timestamp

changeauditstamps_lastmodified_time

timestamp

name

text

[en] The name of the Campaign Group. Primarily used to make it easier to reference a Campaign Group and to recall its purpose

runschedule_start

timestamp

[en] Represents the inclusive (greater than or equal to) value in which to start the range. This field is mandatory

runschedule_end

timestamp

[en] Scheduled date range to run associated objects. The start date must be non-null. Represents the exclusive (strictly less than) value in which to end the range. This field is optional. An unset field here indicates an open range. If totalBudget is set, this field is mandatory

servingstatuses

text

[en] Listing of values that determine whether or not a campaign within the campaign group may be served; unlike status, which is user-managed, the values are controlled by the service. This is a read-only field. Possible values are: *RUNNABLE*: Campaign group is currently active. Billing information, budgetary constraints, or start and end dates are valid; *STOPPED*: Campaign group is currently not eligible for serving for reasons other than billing information, budgetary constraints, or termination dates. For instance, a campaign group will be STOPPED if it has been canceled by the user, or it is marked as spam; *BILLING_HOLD*: Parent account is on billing hold; *ACCOUNT_TOTAL_BUDGET_HOLD*: Parent account total budget has been reached; *ACCOUNT_END_DATE_HOLD*: Parent account end date has been reached; *CAMPAIGN_GROUP_TOTAL_BUDGET_HOLD*: Campaign group total budget has been reached; *CAMPAIGN_GROUP_START_DATE_HOLD*: Campaign group start date is in the future; *CAMPAIGN_GROUP_END_DATE_HOLD*: Campaign group end date has been reached

status

text

[en] *ACTIVE*: Denotes that the Campaign Group is capable of serving ads, subject to run date and budget limitations (as well as any other limitations at the account or campaign level); *ARCHIVED*: Denotes that the Campaign Group is presently inactive, and should mostly be hidden in the UI until un-archived; *CANCELED*: Denotes that the Campaign Group has been permanently canceled and cannot be reactivated; *DRAFT*: Denotes Campaign Group is in a preliminary state and should temporarily not be served; *PAUSED*: Denotes that the Campaign Group meets all requirements to be served, but temporarily should not be

test

boolean

id

text

[en] Unique ID for a creative

name

text

[en] This field is calculated by Kondado and should return the creative name as displayed in the UI. This field is in beta

account_id

text

    Contas de anúncios > > id

account_reference

text

campaign_reference

text

campaign_id

text

    Detalhes das campanhas > > id

created_at

timestamp

[en] Creation time

last_modified_at

timestamp

[en] Time at which the creative was last modified

reference

text

[en] A reference URN for this object to an external system, with semantics varying based on the creative type. SSU creative must contain a valid activity/share reference. If the activity/share has an associated company actor, it must match the parent campaign`s reference. SSU creative reference cannot be modified after creation. Reference is not applicable and is not set for text ad creative

review_status

text

[en] Creative review status. The review is absent (null) when the creative is in DRAFT state

is_serving

boolean

[en] This indicates whether the creative is currently being served or not

intended_status

text

[en] Creative user intended status. The creative intended status is set independently from parent entity status, but parent entity status overrides creative intended status in effect. For example, parent entity status may be PAUSED while creative status is ACTIVE, in which case the creative`s effective status is PAUSED, and not served. [ACTIVE] – Creative development is complete and the creative is available for review and can be served; [PAUSED] – Creative development is complete and the creative is current, but should temporarily not be served; [DRAFT] – Creative development is incomplete and may still be edited; [ARCHIVED] – Creative development is complete, but creative should not be served and should be separated from non-archived creatives in any UI; [CANCELLED] – The creative is permanently cancelled; [PENDING_DELETION] – Denotes that the creative has been requested to be deleted that is currently pending; [REMOVED] – Denotes that the creative was deleted, but must remain fetchable due to the existence of performance data.

is_test

boolean

metric_date

date

conversionvalueinlocalcurrency

text

[en] Value of the conversions in the accounts 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

reactions

float

[en] The count of positive reactions on Sponsored Content which can capture, like, interest, praise, and other responses

account_id

text

    Contas de anúncios > > id

likes

float

[en] The count of likes. Sponsored Content only

opens

float

[en] The count of opens of Sponsored Messaging ads. Sponsored Messaging ads only

externalwebsitepostclickconversions

float

[en] Total number of times users took a desired action after clicking on your ad. When conversions cannot be attributed to individual users, group level attribution or estimation may be used

leadgenerationmailcontactinfoshares

float

[en] The number of times users shared contact info through the One Click Lead Gen for Sponsored Messaging ads. Sponsored Messaging ads only

externalwebsitepostviewconversions

float

[en] Total number of times users took a desired action after seeing your ad. When conversions cannot be attributed to individual users, group level attribution or estimation may be used

otherengagements

float

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

follows

float

[en] The count of follows. Sponsored Content and Follower ads only

oneclickleads

float

[en] The count of leads generated through One Click Lead Gen

sends

float

[en] The count of sends of Sponsored Messaging ads. Sponsored Messaging ads only

campaign_reference

text

campaign_id

text

    Detalhes das campanhas > > id

campaign_group_reference

text

campaign_group_id

text

    Detalhes dos grupos de campanhas > > id

impressions

float

[en] This is the count of impressions for Sponsored Content and sends for Sponsored Messaging

comments

float

[en] The count of comments. Sponsored Content only

shares

float

[en] The count of shares. Sponsored Content only

clicks

float

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

externalwebsiteconversions

float

[en] Total number of times users took a desired action after clicking on or seeing your ad. When conversions cannot be attributed to individual users, group level attribution or estimation may be used

totalengagements

float

[en] The count of all user interactions with the ad unit

costinlocalcurrency

float

[en] Cost in the accounts local currency based on the given date and broken down by campaign, campaign group, and creative. Cost is not adjusted for overdelivery

oneclickleadformopens

float

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

creative_reference

text

creative_id

text

    Detalhes dos criativos > > id

conversionvalueinlocalcurrency

text

[en] Value of the conversions in the accoun`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.

account_id

text

    Contas de anúncios > > id

viralexternalwebsitepostviewconversions

float

[en] The count of post-view conversions that are attributed to your ads driven by a viral impression

externalwebsitepostclickconversions

float

[en] The count of post-click conversions that are attributed to your ads driven by a viral click

externalwebsitepostviewconversions

float

[en] The count of post-view conversions that are attributed to your ads driven by a viral impression

metric_date

date

campaign_reference

text

campaign_id

text

    Detalhes das campanhas > > id

conversion_reference

text

conversion_id

text

viralexternalwebsiteconversions

float

[en] The count of conversions that are attributed to your ads driven by a viral event

viralexternalwebsitepostclickconversions

float

[en] The count of post-click conversions that are attributed to your ads driven by a viral click

externalwebsiteconversions

float

[en] Total number of times users took a desired action after clicking on or seeing your ad. When conversions cannot be attributed to individual users, group level attribution or estimation may be used

creative_reference

text

creative_id

text

    Detalhes dos criativos > > id

lastcallbackat

float

account_id

text

    Contas de anúncios > > id

account_reference

text

attributiontype

text

imagepixeltag

text

id

text

name

text

created

float

lastmodified

float

enabled

boolean

value__currencycode

text

value__amount

float

postclickattributionwindowsize

float

viewthroughattributionwindowsize

float

type

text

conversion_id

text

associatedcampaigns__associatedat

float

associatedcampaigns__conversion

text

associatedcampaigns__campaign

text

conversionvalueinlocalcurrency

text

[en] 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

account_id

text

    Contas de anúncios > > id

metric_date

date

campaign_reference

text

campaign_id

text

    Detalhes das campanhas > > id

campaign_group_reference

text

campaign_group_id

text

    Detalhes dos grupos de campanhas > > id

impressions

float

[en] This is the count of "impressions" for Sponsored Content and "sends" for Sponsored Messaging

costinlocalcurrency

float

[en] Cost in the account`s local currency

creative_reference

text

creative_id

text

    Detalhes dos criativos > > id

videocompletions

float

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

viralvideostarts

float

[en] The count of viral video ads that were started by users. Since viral videos are automatically played for ON_SITE

viralvideoviews

float

[en] 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.

videoviews

float

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

viralvideothirdquartilecompletions

float

[en] The count of viral video ads that played through the third quartile of the video. This includes watches that skipped to this point

fullscreenplays

float

[en] Number of times members click on the full screen button or on the video(mobile only) to go into full screen mode.

videofirstquartilecompletions

float

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

viralvideocompletions

float

[en] The count of viral video ads that played 97-100% of the video. This includes watches that skipped to this point.

videostarts

float

[en] The count of video ads that were started by users.

viralvideomidpointcompletions

float

[en] The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point.

viralfullscreenplays

float

[en] Number of times members click on the full screen button or on the video(mobile only) to go into full screen mode.

videomidpointcompletions

float

[en] The count of viral video ads that played through the midpoint of the video. This includes watches that skipped to this point.

viralvideofirstquartilecompletions

float

[en] The count of viral video ads that played through the first quartile of the video. This includes watches that skipped to this point

videothirdquartilecompletions

float

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

metric_date

date

organization_urn

text

organization_name

text

organicfollowergain

float

paidfollowergain

float

uniqueimpressionscount

float

[en] Number of unique impressions

sharecount

float

[en] Number of shares

engagement

float

[en] Number of organic clicks, likes, comments, and shares over impressions

clickcount

float

[en] Number of clicks

likecount

float

[en] Number of likes. This field can become negative when members who liked a sponsored share later unlike it. The like is not counted since it is not organic, but the unlike is counted as organic

impressioncount

float

[en] Number of impressions

commentcount

float

[en] Number of comments

mobilecustombuttonclickcounts

float

desktopcustombuttonclickcounts

float

mobilecareerspagejobsclicks

float

mobilecareerspagepromolinksclicks

float

mobilecareerspageemployeesclicks

float

careerspagepromolinksclicks

float

careerspagebannerpromoclicks

float

careerspagejobsclicks

float

careerspageemployeesclicks

float

mobileproductspageviews

float

mobileproductsuniquepageviews

float

alldesktoppageviews

float

alldesktopuniquepageviews

float

insightspageviews

float

insightsuniquepageviews

float

mobileaboutpageviews

float

mobileaboutuniquepageviews

float

allmobilepageviews

float

allmobileuniquepageviews

float

desktopproductspageviews

float

desktopproductsuniquepageviews

float

productspageviews

float

productsuniquepageviews

float

jobspageviews

float

jobsuniquepageviews

float

peoplepageviews

float

peopleuniquepageviews

float

overviewpageviews

float

overviewuniquepageviews

float

mobileoverviewpageviews

float

mobileoverviewuniquepageviews

float

lifeatpageviews

float

lifeatuniquepageviews

float

desktopoverviewpageviews

float

desktopoverviewuniquepageviews

float

mobilecareerspageviews

float

mobilecareersuniquepageviews

float

allpageviews

float

alluniquepageviews

float

mobilejobspageviews

float

mobilejobsuniquepageviews

float

careerspageviews

float

careersuniquepageviews

float

mobilelifeatpageviews

float

mobilelifeatuniquepageviews

float

desktopjobspageviews

float

desktopjobsuniquepageviews

float

desktoppeoplepageviews

float

desktoppeopleuniquepageviews

float

aboutpageviews

float

aboutuniquepageviews

float

desktopaboutpageviews

float

desktopaboutuniquepageviews

float

mobilepeoplepageviews

float

mobilepeopleuniquepageviews

float

desktopinsightspageviews

float

desktopinsightsuniquepageviews

float

desktopcareerspageviews

float

desktopcareersuniquepageviews

float

desktoplifeatpageviews

float

desktoplifeatuniquepageviews

float

mobileinsightspageviews

float

mobileinsightsuniquepageviews

float

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

    Páginas de organizações > > organization_urn

lifecyclestate

text

[en] The state of the content. The following values can be returned in responses: DRAFT – Represents content that is accessible only to the author and is not yet published; PUBLISHED – Represents content that is accessible to all entities. This is the only accepted field during creation; PUBLISH_REQUESTED – Represents content that has been submitted for publishing but is not yet ready for rendering; PUBLISH_FAILED – Represents content that has been submitted for publishing but was not processed. An edit is required in order to re-attempt publishing;

visibility

text

[en] Visibility restrictions on content. Type of MemberNetworkVisibility which has the values of: CONNECTIONS – Represents 1st degree network of owner. PUBLIC – Anyone can view this. LOGGED_IN – Viewable by logged in members only. CONTAINER – Visibility is delegated to the owner of the container entity. For example, posts within a group are delegated to the groups authorization API for visibility authorization.

publishe_dat

timestamp

[en] The time at which this content was published

last_modified_at

timestamp

[en] Time at which the resource was last modified

feed_distribution

text

[en] Specifies the feeds distributed to within LinkedIn. NONE-Do not distribute within LinkedIn via feed. MAIN_FEED-Distribute to the flagship feed, and container entity feed if applicable

commentary

text

[en] The user generated commentary for the post

is_edited_by_author

boolean

content_type

text

[en] The content type of the post, based on https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/posts-api?view=li-lms-2023-02&tabs=curl#content [Calculated by Kondado]. Can be: text, media_image, media_video, media_other, poll, multi_image, article, carousel, unknown

content_media_id

text

[en] If content_type is media_image or media_video, shows the media URN

content_media_title

text

[en] If content_type is media_image or media_video, shows the media title (if provided)

content_media_image_download_url

text

[en] If content_type is media_image, shows the media URL. Requires the user to have permissions to read images [ https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions ]. Empty if the user doens`t have enough permissions. The download URL expires, so if you need it to always be refreshed, use integral replication for the pipeline

content_media_image_owner

text

[en] [Present if content_type=media_image and user has permission to read images https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions] The URN of the entity that owns this asset. It can be a person(urn:li:person:123), organization(urn:li:organization:123) or sponsoredAccount(urn:li:sponsoredAccount:123) URN

content_media_image_download_url_expires_at

timestamp

[en] [Present if content_type=media_image and user has permission to read images https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions] Shows when content_media_image_download_url expires. If not present, it might never expire but there`s no guarantee. Unless the use case has a security+legal exception, all URLs have an expiration time. If they don't, they can still expire because URLs are signed, and the sign keys might be rotated. If a non expiring URL was signed with a key that gets invalidated, it essentially expires

content_media_image_status

text

[en] [Present if content_type=media_image] PROCESSING Asset is processing to generate missing artifacts. PROCESSING_FAILED – Processing failed due to client error such as file size too large, unsupported file format, internal error (e.g., performance issue, database error, network failure), or other issue. AVAILABLE – All of the recipe`s required artifacts are ready. The asset is available to be served. WAITING_UPLOAD Waiting for client to upload source file or uploading process to be completed. FORBIDDEN – The asset could not be read due to user`s lacking permissions

content_media_video_duration

float

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] The length of the video in milliseconds. It is empty if the media asset isn`t available, failed processing, or there is another issue.

content_media_video_aspect_ratio_width

float

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] Aspect ratio width of the media. For media with a 16:9 ratio, it is 16. There might be decimal values for high density displays for a greater degree of precision. aspectRatioHeight and aspectRatioWidth would either both be present or both be null. It is empty if the media asset isn't available, failed processing, or there is another issue

content_media_video_aspect_ratio_height

float

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] Media aspect ratio height. For media with a 16:9 ratio, it is a 9. There might be decimal values for high density displays for a greater degree of precision. aspectRatioHeight and aspectRatioWidth would either both be present or both be null. It is empty if the media asset isn't available, failed processing, or there is another issue

content_media_video_thumbnail

text

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] URL to retrieve the thumbnail file. This URL expires. So use integral replication if you need it to be available more often

content_media_video_download_url

text

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] Public URL to download/view the media asset. It will be empty if the media asset isn't available, failed processing, or there is another issue. This URL expires. So use integral replication if you need it to be available more often

content_media_video_download_url_expires_at

timestamp

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] when the identifier expires. If it is not present, it may never expire. Unless the use case has a security and legal exception, all URLs have an expiration time. If they don't, they can still expire because URLs are signed, and the sign keys may be rotated. If a non expiring URL was signed with a key that gets invalidated, it expires

content_media_video_owner

text

[en] [Present if content_type=media_video and user has permission to read videos https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions] URN of the entity that owns this asset. Can be a person(urn:li:person:123), or organization(urn:li:organization:123) URN

content_media_video_status

text

[en] [Present if content_type=media_video] PROCESSING Asset is processing to generate missing artifacts. PROCESSING_FAILED Processing failed due to client error such as file size too large, unsupported file format, internal error (e.g., performance issue, database error, network failure), or other issue. AVAILABLE All of the recipe's required artifacts are ready. The asset is available to be served. WAITING_UPLOAD Waiting for client to upload source file or uploading process to be completed. FORBIDDEN: video info not be fetched due to lack of permissions (https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/videos-api?view=li-lms-2023-02&tabs=http#permissions)

content_poll_settings_vote_selection_type

text

[en] [Present if content_type=poll] The selection type of votes on the poll. SINGLE_VOTE – Single-select vote. MULTIPLE_VOTE – Multiple-select vote (To be supported later in future)

content_poll_settings_duration

text

[en] [Present if content_type=poll] Duration of poll being open for votes. It will close after the specified duration from creation time: ONE_DAY – Poll is open for 1 day; THREE_DAYS – Poll is open for 3 days; SEVEN_DAYS – Poll is open for 7 days; FOURTEEN_DAYS – Poll is open for 14 days

content_poll_settings_is_vote_visible_to_author

boolean

[en] [Present if content_type=poll] Poll author’s visibility to voters. Defaults to TRUE. Currently, FALSE is not supported

content_poll_unique_voters_count

float

[en] [Present if content_type=poll] Number of unique voters on the poll

content_poll_question

text

[en] [Present if content_type=poll] Question for the poll

content_article_description

text

[en] [Present if content_type=article] Custom or saved description of the article. If empty, there is none

content_article_title

text

[en] [Present if content_type=article] Custom or saved title of the article

content_article_source

text

[en] [Present if content_type=article] A URL of the article. Typically the URL that was ingested to maintain URL parameters.

content_article_thumbnail_alt_text

text

[en] [Present if content_type=article] Alt text for the custom thumbnail. If empty, there is none

content_article_thumbnail

text

[en] [Present if content_type=article] Custom or saved thumbnail for the article. If empty, there is none

content_article_thumbnail_download_url

text

[en] [Present if content_type=article] Image of the thumbnail. Requires the user to have permissions to read images [ https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions ]. Empty if the user doens`t have enough permissions. The download URL expires, so if you need it to always be refreshed, use integral replication for the pipeline

lifetime_uniqueimpressionscount

float

[en] Lifetime number of unique impressions

lifetime_sharecount

float

[en] Lifetime number of shares

lifetime_engagement

float

[en] Lifetime number of organic clicks, likes, comments, and shares over impressions

lifetime_clickcount

float

[en] Lifetime number of clicks

lifetime_likecount

float

[en] Lifetime number of likes. This field can become negative when members who liked a sponsored share later unlike it. The like is not counted since it is not organic, but the unlike is counted as organic

lifetime_impressioncount

float

[en] Lifetime number of impressions

lifetime_commentcount

float

[en] Lifetime number of comments

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

hashtag

text

[en] The hashtag

metric_date

date

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

uniqueimpressionscount

float

[en] Number of unique impressions

sharecount

float

[en] Number of shares

engagement

float

[en] Number of organic clicks, likes, comments, and shares over impressions

clickcount

float

[en] Number of clicks

likecount

float

[en] Number of likes. This field can become negative when members who liked a sponsored share later unlike it. The like is not counted since it is not organic, but the unlike is counted as organic

impressioncount

float

[en] Number of impressions

commentcount

float

[en] Number of comments

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

fallback_text

text

[en] Text to be rendered and displayed

target_urn

text

[en] URN representing the entity to be mentioned. Can be a Person or Organization URN

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

option_text

text

[en] [Available if content_type = poll] Text describing the option

is_option_voted_by_viewer

boolean

[en] [Available if content_type = poll] Whether the viewer [data source user] voted this poll option

option_vote_count

float

[en] [Available if content_type = poll] Vote counts of the poll option. Missing if the viewer [data source user] of the poll is not allowed to view votes count on individual options based on visibility rules (e.g. viewer has not already voted on the poll)

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

landing_page

text

[en] [Available if content_type = carousel] The web page that can be associated with the content and is opened when the member clicks on the content. For example, if the content is an image and the landing page is a web page then clicking on the image will take the member to the web page. If empty, then there is no landing page associated with the content

media_id

text

[en] [Available if content_type = carousel] The id of the media contained in the card

media_title

text

[en] [Available if content_type = carousel] The title of the media contained in the card

media_download_url

text

[en] [Available if content_type = carousel] Url to view the media contained in the card. Requires the user to have permissions to read images [ https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions ]. Empty if the user doens`t have enough permissions. The download URL expires, so if you need it to always be refreshed, use integral replication for the pipeline

post_id

text

[en] Unique id for this object

organization_urn

text

[en] The organizational entity URN

image_id

text

[en] If content_type is multi_image, shows the image_id

image_title

text

[en] If content_type is multi_image, shows the image title (if provided)

image_download_url

text

[en] If content_type is multi_image, shows the media URL. Requires the user to have permissions to read images [ https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions ]. Empty if the user doens`t have enough permissions. The download URL expires, so if you need it to always be refreshed, use integral replication for the pipeline

image_owner

text

[en] [Present if content_type=multi_image and user has permission to read images https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions] The URN of the entity that owns this asset. It can be a person(urn:li:person:123), organization(urn:li:organization:123) or sponsoredAccount(urn:li:sponsoredAccount:123) URN

image_download_url_expires_at

timestamp

[en] [Present if content_type=multi_image and user has permission to read images https://learn.microsoft.com/en-us/linkedin/marketing/integrations/community-management/shares/images-api?view=li-lms-2023-02&tabs=http#permissions] Shows when content_media_image_download_url expires. If not present, it might never expire but there`s no guarantee. Unless the use case has a security+legal exception, all URLs have an expiration time. If they don't, they can still expire because URLs are signed, and the sign keys might be rotated. If a non expiring URL was signed with a key that gets invalidated, it essentially expires

image_status

text

[en] [Present if content_type=multi_image] PROCESSING Asset is processing to generate missing artifacts. PROCESSING_FAILED – Processing failed due to client error such as file size too large, unsupported file format, internal error (e.g., performance issue, database error, network failure), or other issue. AVAILABLE – All of the recipe`s required artifacts are ready. The asset is available to be served. WAITING_UPLOAD Waiting for client to upload source file or uploading process to be completed. FORBIDDEN – The asset could not be read due to user`s lacking permissions