Salesforce Docs Portal

LinkedIn Connector Objects

Objects Supported

Name Description
Comments Query Comments data for Posts in the Organization Pages that you administer.
CompanyDetails Retrieve company profiles and updates.
CompanyFollowerStatistics Query statistics about followers for a particular company page.
CompanyList Lists all companies and the privileges that the user has within the organization.
CompanyPageStatistics Query statistics about page views for a particular company page.
CompanyStatusUpdates Read and write posts in your organizations.
CompanyUpdateStatistics Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.
Documents Read the metadata of the document assets created in the organizations you administer.
Events Read and update events in your organizations.
GeoLocation Provides the display name for a given geo Id, or a set of geo Ids.
Images Read the metadata of the image assets created in the organizations you administer.
Industries Query the list of available industries in LinkedIn.
OrganizationAuthorizationActions Read data on the authorization action assignments for the organizations in which you are a member.
OrganizationFollowerCount The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.
OrganizationLocations Retrieve location information for any LinkedIn organization, regardless of whether you manage that organization.
Organizations Query information about any LinkedIn organization, regardless of whether the individual is an administrator for that organization.
Profiles Retrieves LinkedIn member profile information.
Videos Read the metadata of the video assets created in the organizations you administer.
VideoTimeWatchedForVideoViewsStatistics Query statistics about the time watched in milliseconds for video.
VideoTimeWatchedStatistics Query statistics about the time the video was watched in milliseconds.
VideoViewerStatistics Query statistics about unique viewers who made engaged plays on the video.
VideoViewStatistics Query statistics about video views for a particular company page.

Comments

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No The unique identifier for the comment.
UpdateId String False No The identifier for the update associated with the comment.
Text String False No The content of the comment regarding the update.
CreatedBy String False No The unique identifier for the person or company.
Date Datetime True No The date or timestamp when the comment was last modified.
Mentions String True No The Uniform Resource Names (URNs) for the organizations or individuals mentioned in the comment.

Return to Top

CompanyDetails

Name Type ReadOnly References FilterOnly Description
CompanyId [KEY] String True No The unique, internal, numeric identifier for the company in the following format urn:li:organization:{id}
CompanyName String True No The name of the company.
UniversalName String True No The unique string identifier for the company.
Description String True No The company description. Limit of 500 characters.
Specialties String True No The company specialties.
StaffCountRange String True No The company staff count range.
WebsiteUrl String True No The URL for the company website.
Logo String True No The original company logo.
SquareLogo String True No The square company logo.
CompanyTypeName String True No The name of the company type.
Groups String True No The groups of the company.
Industries String True No The industries of the company.
FoundedYear Integer True No The year the company was founded.
PrimaryOrganizationType String True No Type of primary organization being used in the lookup. Possible values: SCHOOL,BRAND,NONE
VanityName String True No Entity's unique name used in URLs.
VersionTag String True No Tag indicating version.

Return to Top

CompanyFollowerStatistics

Name Type ReadOnly References FilterOnly Description
CompanyId String True No Id of the Company associated with the follow statistics in the following format urn:li:organization:{id}.
Category String True No The category of the followers.
Type String True No Type of the category.
OrganicFollowerCount Integer True No Total number of the organic followers.
PaidFollowerCount Integer True No Total number of the paid followers.
TimeGranularity String True No Granularity of the statistics. Must be either DAY or MONTH.
ReportTimeRangeStart Datetime True No Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd Datetime True No Inclusive ending timestamp of when the query should end. Queries until current time when not set.
UsageStartTime Datetime True No Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime Datetime True No Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.

Return to Top

CompanyList

Name Type ReadOnly References FilterOnly Description
Id String True No A unique identifier for the company in the following format urn:li:organization:{id}
RoleAssignee String True No Id of the assigned person.
Role String True No Role of the assigned person. Possible values are: ADMINISTRATOR, DIRECT_SPONSORED_CONTENT_POSTER, RECRUITING_POSTER, LEAD_CAPTURE_ADMINISTRATOR, LEAD_GEN_FORMS_MANAGER, ANALYST, CURATOR, CONTENT_ADMINISTRATOR.
State String True No State of the role assigned to the person. Possible values are: APPROVED, REJECTED, REQUESTED, REVOKED.

Return to Top

CompanyPageStatistics

Name Type ReadOnly References FilterOnly Description
CompanyId String True No Id of the Company associated with the page statistics in the following format urn:li:organization:{id}
Category String True No The category of the statistics.
Type String True No Type of the category. Not applicable for the totalPageStatistics category.
AllPageViews Integer True No Complete page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
AllDesktopPageViews Integer True No Complete desktop page views count.
AllMobilePageViews Integer True No Complete mobile page views count.
OverviewPageViews Integer True No Total Overview page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic.
CareersPageViews Integer True No Total Careers page views count.
DesktopCareersPageViews Integer True No Total desktop Careers page views count.
DesktopJobsPageViews Integer True No Total desktop Jobs page views count.
DesktopLifeAtPageViews Integer True No Total desktop Life Atpage views count.
DesktopOverviewPageViews Integer True No Total desktop Overview page views count.
JobsPageViews Integer True No Total Jobs page views count.
LifeAtPageViews Integer True No Total LifeAt page views count.
MobileCareersPageViews Integer True No Total mobile Careers page views count.
MobileJobsPageViews Integer True No Total mobile Jobs page views count.
MobileLifeAtPageViews Integer True No Total mobile LifeAt Page views count.
MobileOverviewPageViews Integer True No Total mobile Overview page views count.
MobileProductsPageViews Integer True No Total mobile Products page views count.
InsightsPageViews Integer True No Total Insights page views count.
MobileAboutPageViews Integer True No Total mobile About page views count.
ProductsPageViews Integer True No Total Products page views count.
DesktopProductsPageViews Integer True No Total desktop Products page views count.
PeoplePageViews Integer True No Total People page views count.
DesktopPeoplePageViews Integer True No Total desktop People page views count.
AboutPageViews Integer True No Total About page views count.
DesktopAboutPageViews Integer True No Total desktop About page views count.
MobilePeoplePageViews Integer True No Total mobile People page views count.
DesktopInsightsPageViews Integer True No Total desktop Insights page views count.
MobileInsightsPageViews Integer True No Total mobile Insights page views count.
MobileCareersPagePromoLinksClicks Integer True No Total mobile clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
MobileCareersPageJobsClicks Integer True No Total mobile clicks count on Careers page Jobs. Applicable only for the totalPageStatistics category.
MobileCareersPageEmployeesClicks Integer True No Total mobile clicks count on Careers page Employees. Applicable only for the totalPageStatistics category.
CareersPagePromoLinksClicks Integer True No Total clicks count on Careers page promo links. Applicable only for the totalPageStatistics category.
CareersPageBannerPromoClicks Integer True No Total clicks count on Careers page banner promo. Applicable only for the totalPageStatistics category.
CareersPageJobsClicks Integer True No Total clicks count on Careers page jobs. Applicable only for the totalPageStatistics category.
CareersPageEmployeesClicks Integer True No Total clicks count on Careers page employees. Applicable only for the totalPageStatistics category.
TimeGranularity String True No Granularity of the statistics. Must be either DAY or MONTH.
UsageStartTime Datetime True No Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report.
UsageEndTime Datetime True No Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report.
ReportTimeRangeStart Datetime True No Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
ReportTimeRangeEnd Datetime True No Inclusive ending timestamp of when the query should end. Queries until current time when not set.

Return to Top

CompanyStatusUpdates

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No Unique identifier for the post.
Comment String False No Text comment associated with the post.
CompanyId String True No Identifier of the company to which the post belongs.
Date Datetime True No Timestamp when the post was created.
CreatedBy String False No Identifier of the user who created the post.
FirstPublishedAt Datetime True No Timestamp when the post was published.
LastModified Datetime True No Timestamp when the post most last modified.
Visibility String False No Specifies who can view the post.
LifecycleState String False No Current lifecycle state of the post.
Content String False No Main content of the post.
ContentCTALabel String True No The call-to-action label used in the post's content.
IsReshareDisabled Boolean False No Indicates if the author has disabled re-sharing for the post.
ParentPostURN String False CompanyStatusUpdates.Id No URN of the parent post if the post is a re-share.
RootPostURN String True CompanyStatusUpdates.Id No URN of the root post in the re-share chain if the post is a re-share.

Return to Top

CompanyUpdateStatistics

Name Type ReadOnly References FilterOnly Description
Clicks Integer True No Total clicks count.
Comments Integer True No Total comments count.
CommentMentions Integer True No Total comment mentions count.
Engagement Double True No Total engagement count.
Impressions Integer True No Total impressions count.
Likes Integer True No Total likes count.
Shares Integer True No Total shares count.
ShareMentions Integer True No Total share mentions count.
UniqueImpressions Integer True No Total share mentions count.
TimeRangeStart Datetime True No Exclusive starting datetime of when the query should begin. When not set, queries from the beginning of time.
TimeRangeEnd Datetime True No Inclusive ending datetime of when the query should end. When not set, queries until the current time.
TimeGranularity String True No Granularity of the statistics. Must be either DAY or MONTH. Requires TimeRangeStart and TimeRangeEnd.
UGCPostId String True No The ID of the UGC post.
ShareId String True No The ID of the share.
CompanyId String True CompanyList.Id No Id of the Company associated with the update statistics.
IntervalStartTime Datetime True No Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime Datetime True No Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

Return to Top

Documents

Name Type ReadOnly References FilterOnly Description
URN [KEY] String True No The URN of the document.
OwnerURN String True No The URN of the entity who owns the document.
DownloadURL String True No The URL for downloading the document.
DownloadURLExpiresAt Datetime True No The time when the URL for downloading the document expires.
Status String True No The status of the document.

Return to Top

Events

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No Unique identifier for the event.
URN String True No URN of the event.
OrganizerURN String True No URN of the event organizer.
Name String True No Name of the event.
Description String True No Detailed description of the event.
Type String True No Type or category of the event. Data is returned in JSON format.
VanityName String False No Custom or user-friendly name for the event.
StartsAt Datetime True No Timestamp when the event starts.
BackgroundImageURN String True No URN of the event's background image.
LeadFormURN String True No URN of the lead generation form associated with the event.
DiscoveryMode String True No How the event is discovered or promoted.
PostURN String True CompanyStatusUpdates.Id No URN of the post associated with the event.
CreatedBy String True No URN of the actor who created the event.
CreatedAt Datetime True No Timestamp when the event was created.
LastUpdatedBy String True No URN of the actor who last updated the event.
LastUpdatedAt Datetime True No Timestamp when the event was last updated.

Return to Top

GeoLocation

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No Unique identifier for the entity. Can be a single Id or a comma-separated list of Ids.
Country String False No An uppercase two-letter country code as defined by ISO-3166.
Language String False No A lowercase two-letter language code as defined by ISO-639.
Value String False No The value of the display text.
LocaleLanguage String False Yes The locale language the country data is requested in. A lowercase two-letter language code as defined by ISO-639.
LocaleCountry String False Yes The locale country the country data is requested in. An uppercase two-letter country code as defined by ISO-3166.

Return to Top

Images

Name Type ReadOnly References FilterOnly Description
URN [KEY] String True No The URN of the image.
OwnerURN String True No The URN of the entity who owns the image.
DownloadURL String True No The URL for downloading the image.
DownloadURLExpiresAt Datetime True No The time when the URL for downloading the image expires.
Status String True No The status of the image.

Return to Top

Industries

Name Type ReadOnly References FilterOnly Description
Id [KEY] Integer True No The identifier of the industry.
Name String True No The name of the industry.
URN String True No The URN of the industry.
ParentId Integer True Industries.Id No The identifier of the parent industry of this industry.

Return to Top

OrganizationAuthorizationActions

Name Type ReadOnly References FilterOnly Description
OrganizationURN [KEY] String True No Unique identifier of the organization.
MemberURN [KEY] String True No Unique profile identifier of the member assigned the authorization action.
AuthorizationAction [KEY] String True No Authorization action assigned to the member for organization management.
Status String True No Status of the authorization action assignment.

Return to Top

OrganizationFollowerCount

Name Type ReadOnly References FilterOnly Description
FirstDegreeSize Integer True No The number of first-degree connections (followers) for the organization.

Return to Top

OrganizationLocations

Name Type ReadOnly References FilterOnly Description
OrganizationId String True Organizations.Id No The identifier of the organization.
OrganizationVanityName String True No The vanity name of the organization.
GeoLocationURN [KEY] String True No The geolocation URN of the organization's location.
LocationType String True No The type of the organization's location.
Description String True No The description of the organization's location.
StaffCountRange String True No The range of staff members of the organization's location.
AddressLine1 String True No The first line of the address of the organization's location.
AddressLine2 String True No The second line of the address of the organization's location.
City String True No The city of the organization's location.
AdministrativeUnit String True No This refers to the administrative unit (e.g. state, country, province) of the organization's location.
PostalCode String True No The postal code of the organization's location.
Country String True No The country of the organization's location.

Return to Top

Organizations

Name Type ReadOnly References FilterOnly Description
Id [KEY] String True No The identifier of the organization.
Name String True No The name of the organization.
VanityName String True No The vanity name of the organization.
Website String True No The organization's website.
PrimaryType String True No The primary type of the organization.
LogoAssetURN String True No The digital media asset URN for the organization's logo.
HierarchyClassification String True No The classification for the school's hierarchy in case the organization is a school.
SchoolType String True No The type of school in case the organization is a school.
YearLevel String True No The classification of the length of the school's educational programs in case the organization is a school.

Return to Top

Profiles

Name Type ReadOnly References FilterOnly Description
Id [KEY] String False No The unique identifier of the member's profile.
FirstName String False No The first name of the member's profile.
LastName String False No The last name of the member's profile.
MaidenName String False No The maiden name of the member's profile.
Headline String False No The headline of the member's profile. Often this is the job title.
VanityName String False No The vanity name of the member's profile.
PictureAssetURN String False No The digital media asset URN for the picture of the member's profile.
URN String False No URN of the member's profile.

Return to Top

Videos

Name Type ReadOnly References FilterOnly Description
URN [KEY] String True No The URN of the video.
OwnerURN String True No The URN of the entity who owns the video.
DownloadURL String True No The URL for downloading the video.
DownloadURLExpiresAt Datetime True No The time when the URL for downloading the video expires.
Status String True No The status of the video.
AspectRatioHeight Decimal True No The aspect ratio height of the video.
AspectRatioWidth Decimal True No The aspect ratio width of the video.
Duration Long True No The duration of the video.
ThumbnailDownloadURL String True No The URL for downloading the video's thumbnail.
CaptionsDownloadURL String True No The URL for downloading the video's captions.

Return to Top

VideoTimeWatchedForVideoViewsStatistics

Name Type ReadOnly References FilterOnly Description
UGCPostId String False No Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
TimeWatchedForVideoViews Long False No The time watched in milliseconds for video play-pause cycles that are at least 3 seconds.
TimeGranularity String False No Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime False No Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime False No Inclusive ending timestamp of when the query should end. Queries until current time when not set.
IntervalStartTime Datetime False No Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime Datetime False No Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

Return to Top

VideoTimeWatchedStatistics

Name Type ReadOnly References FilterOnly Description
UGCPostId String False No Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
TimeWatched Long False No The time the video was watched in milliseconds.
TimeGranularity String False No Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime False No Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime False No Inclusive ending timestamp of when the query should end. Queries until current time when not set.
IntervalStartTime Datetime False No Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime Datetime False No Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

Return to Top

VideoViewerStatistics

Name Type ReadOnly References FilterOnly Description
UGCPostId String False No Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
Viewers Long False No Unique viewers who made engaged plays on the video.
TimeGranularity String False No Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime False No Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime False No Inclusive ending timestamp of when the query should end. Queries until current time when not set.
IntervalStartTime Datetime False No Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime Datetime False No Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

Return to Top

VideoViewStatistics

Name Type ReadOnly References FilterOnly Description
UGCPostId String False No Id of the Post associated with the video in the following format urn:li:ugcPost:{id}.
Views Long False No Video views of the statistic.
TimeGranularity String False No Granularity of the statistics. Can be DAY, WEEK, or ALL (default).
TimeRangeStart Datetime False No Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set.
TimeRangeEnd Datetime False No Inclusive ending timestamp of when the query should end. Queries until current time when not set.
IntervalStartTime Datetime False No Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column.
IntervalEndTime Datetime False No Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column.

Return to Top