Frends.LinkedIn.SearchAdAnalytics / 1.1.0

Summary

Fetches advertising metrics for a date range, aggregated along a pivot you choose and bucketed by a time granularity, so the same data can come back per campaign, per creative or per day.

Typical use — loading marketing performance into a warehouse or dashboard on a schedule

Details

Frends version: 5.1 and newer
Agents: Legacy, Crossplatform
Target frameworks: net471, net6.0, netstandard2.0

Input class usually contains parameters that are required.

Name	Type	Default	Example	Description
Finder	`Finder`	`Analytics`	`Finder.Statistics`	Specifies the Finder used in the request. Statistics allows up to three pivots in the request. Analytics finder is used when specifying a single pivot. Possible values: `Statistics`: Statistics allows up to three pivots in the request. `Analytics`: Analytics finder is used when specifying a single pivot.
Pivot	`Pivot`	–	`Pivot.COMPANY`	Pivot of results, by which each report data point is grouped. Optional. Possible values: `NONE`: Pivot will not be added to the request. `COMPANY`: Group results by advertiser's company. `ACCOUNT`: Group results by account. `SHARE`: Group results by sponsored share. `CAMPAIGN`: Group results by campaign. `CREATIVE`: Group results by creative. `CAMPAIGN_GROUP`: Group results by campaign group. `CONVERSION`: Group results by conversion. `CONVERSATION_NODE`: The element row in the conversation will be the information for each individual node of the conversation tree. `CONVERSATION_NODE_OPTION_INDEX`: Used actionClicks are deaggregated and reported at the Node Button level. The second value of the pivot_values will be the index of the button in the node. `SERVING_LOCATION`: Group results by serving location, onsite or offsite. `CARD_INDEX`: Group results by the index of where a card appears in a carousel ad creative. Metrics are based on the index of the card at the time when the user's action (impression, click, etc.) happened on the creative (Carousel creatives only). `MEMBER_COMPANY_SIZE`: Group results by member company size. `MEMBER_INDUSTRY`: Group results by member industry. `MEMBER_SENIORITY`: Group results by member seniority. `MEMBER_JOB_TITLE`: Group results by member job title. `MEMBER_JOB_FUNCTION`: Group results by member job function. `MEMBER_COUNTRY_V2`: Group results by member country. `MEMBER_REGION_V2`: Group results by member region. `MEMBER_COMPANY`: Group results by member company. `PLACEMENT_NAME`: Group results by placement. `IMPRESSION_DEVICE_TYPE`: Group results by the device type the ad made an impression on. Reach metrics and conversion metrics will not be available when this pivot is used.
Pivots	`Pivot[]`	–	`[ Pivot.COMPANY, Pivot.ACCOUNT]`	Pivot of results, by which each report data point is grouped. Optional.
StartDate	`String`	–	`12-10-2023`	Represents the inclusive start time range of the analytics. https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings#table-of-format-specifiers
EndDate	`String`	–	`12-10-2023`	Represents the inclusive end time range of the analytics. Must be after start time if it's present. Optional. https://learn.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings#table-of-format-specifiers
TimeGranularity	`TimeGranularity`	–	`TimeGranularity.ALL`	Time granularity of results. Possible values: `ALL`: Results grouped into a single result across the entire time range of the report. `DAILY`: Results grouped by day. `MONTHLY`: Results grouped by month. `YEARLY`: Results grouped by year.
Campaigns	`String[]`	–	`[ urn:li:sponsoredCampaign:1234567, urn:li:sponsoredCampaign:1234568 ]`	Match result by campaign facets.
Creatives	`String[]`	–	`[ ]`	Match result by creative facets.
Metrics	`String[]`	–	–	–