CData Python Connector for LinkedIn

Build 24.0.9062

CompanyPageStatistics

Query statistics about page views for a particular company page.

Note: Requires the r_organization_admin OAuth scope.

Select

The 本製品 uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the 本製品.

  • CompanyId supports only the '=' operator.
  • TimeGranularity supports only the '=' operator.
  • ReportTimeRangeStart supports only the '=' operator.
  • ReportTimeRangeEnd supports only the '=' operator.

The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.

  • Lifetime page statistics: To retrieve lifetime page statistics, do not set the ReportTimeRangeStart and ReportTimeRangeEnd in the WHERE clause conditions. The API returns view and click statistics segmented by various facets. For example:
    SELECT * FROM [CompanyPageStatistics]
  • Time-bound page statistics: To retrieve time-bound page statistics, include the ReportTimeRangeStart and/or ReportTimeRangeEnd in the WHERE clause conditions. The API returns aggregate page statistics within all of the days or months in between the selected date range based on the specified TimeGranularity (DAY or MONTH). For example:
    SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-20' AND ReportTimeRangeEnd = '2020-10-15'
    
    SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY'
    
    SELECT * FROM [CompanyPageStatistics] WHERE TimeGranularity = 'MONTH' AND ReportTimeRangeStart = '2019-10-15' AND ReportTimeRangeEnd = '2020-10-15' AND companyId = '10904095'

Time-Based Data Queries

The three inputs that control time-based data queries are TimeGranularity, TimeRangeStart, and TimeRangeEnd. TimeGranularity is not always required, but if it is specified you must also specify TimeRange Start, TimeRangeEnd, or both.

The behavior of TimeGranularity in a query depends on what other inputs are specified.

Inputs specified Result
None The driver returns all data from the time the company page was created until the present time, in one record.
TimeRangeStart only
(no TimeRangeEnd or TimeGranularity)
The driver returns all data from the time specified in TimeRangeStart until the present time, in one record.
TimeRangeStart and TimeRangeEnd
(no TimeRangeGranularity)
The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd.
TimeRangeEnd only
(no TimeRangeStart or TimeGranularity)
The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record.
All The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity.

Columns

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062