For the complete documentation index, see llms.txt. This page is also available as Markdown.

SearchAdAnalytics

Frends Task for fetching AdAnalytics from LinkedInAds.

Task version: 1.1.0

Required Frends version: 5.1+

Required .NET version: 471, 6.0, standard2.0

Compatible Agents: Legacy, Crossplatform

Task Parameters

Name
Description

Finder : Finder

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: 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.

  • Analytics: 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.

Default: 1 Example: Finder.Statistics

Pivot : Pivot

Pivot of results, by which each report data point is grouped. Optional.

Possible values:

  • NONE: Pivot of results, by which each report data point is grouped. Optional.

  • COMPANY: Pivot of results, by which each report data point is grouped. Optional.

  • ACCOUNT: Pivot of results, by which each report data point is grouped. Optional.

  • SHARE: Pivot of results, by which each report data point is grouped. Optional.

  • CAMPAIGN: Pivot of results, by which each report data point is grouped. Optional.

  • CREATIVE: Pivot of results, by which each report data point is grouped. Optional.

  • CAMPAIGN_GROUP: Pivot of results, by which each report data point is grouped. Optional.

  • CONVERSION: Pivot of results, by which each report data point is grouped. Optional.

  • CONVERSATION_NODE: Pivot of results, by which each report data point is grouped. Optional.

  • CONVERSATION_NODE_OPTION_INDEX: Pivot of results, by which each report data point is grouped. Optional.

  • SERVING_LOCATION: Pivot of results, by which each report data point is grouped. Optional.

  • CARD_INDEX: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_COMPANY_SIZE: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_INDUSTRY: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_SENIORITY: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_JOB_TITLE: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_JOB_FUNCTION: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_COUNTRY_V2: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_REGION_V2: Pivot of results, by which each report data point is grouped. Optional.

  • MEMBER_COMPANY: Pivot of results, by which each report data point is grouped. Optional.

  • PLACEMENT_NAME: Pivot of results, by which each report data point is grouped. Optional.

  • IMPRESSION_DEVICE_TYPE: Pivot of results, by which each report data point is grouped. Optional.

Default: - Example: Pivot.COMPANY

Pivots : Pivot[]

Pivot of results, by which each report data point is grouped. Optional.

Default: - Example: [ Pivot.COMPANY, Pivot.ACCOUNT]

StartDate : String

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

Default: - Example: 12-10-2023

EndDate : String

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

Default: - Example: 12-10-2023

TimeGranularity : TimeGranularity

Time granularity of results.

Possible values:

  • ALL: Time granularity of results.

  • DAILY: Time granularity of results.

  • MONTHLY: Time granularity of results.

  • YEARLY: Time granularity of results.

Default: - Example: TimeGranularity.ALL

Campaigns : String[]

Match result by campaign facets.

Default: - Example: [ urn:li:sponsoredCampaign:1234567, urn:li:sponsoredCampaign:1234568 ]

Creatives : String[]

Match result by creative facets.

Default: - Example: [ ]

Metrics : String[]

Default: - Example: -

Task Result

Name
Description

Body : Object

Body of response. Response body contains two properties: paging and elements. Example: {"paging": {"start": 0, "count":10, "links": [], "total": 1}, "elements": [{"totalBudget": ...}]}

Headers : Dictionary<String, String>

Headers of response Example: {[ "content-type": "application/json", ... ]}

StatusCode : Int32

Status code of the response. Example: 200

Task Changelog

Changelog for Task Frends.LinkedIn.SearchAdAnalytics.

[1.1.0] - 2025-03-18

Changed

  • Update packages: Newtonsoft.Json 12.0.3 -> 13.0.3 System.ComponentModel.Annotations 4.7.0 -> 5.0.0 System.Runtime.Caching 7.0.0 -> 9.0.3 coverlet.collector 3.1.2 -> 6.0.4 Microsoft.NET.Test.Sdk 16.6.1 -> 17.13.0 nunit 3.12.0 -> 4.3.2 NUnit3TestAdapter 3.17.0 -> 5.0.0

[1.0.0] - 2023-11-02

Added

  • Initial implementation

Last updated

Was this helpful?