# SearchAdAnalytics

Required Frends version: 5.1+

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

Compatible Agents: Legacy, Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.LinkedIn/tree/main/Frends.LinkedIn.SearchAdAnalytics>

{% tabs %}
{% tab title="Parameter: Filter" %}

| Name                                | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Finder : `Finder`                   | <p>Specifies the Finder used in the request.</p><p>Statistics allows up to three pivots in the request.</p><p>Analytics finder is used when specifying a single pivot.</p><p>Possible values:</p><ul><li><code>Statistics</code>:</li></ul><p>Specifies the Finder used in the request.</p><p>Statistics allows up to three pivots in the request.</p><p>Analytics finder is used when specifying a single pivot.</p><ul><li><code>Analytics</code>:</li></ul><p>Specifies the Finder used in the request.</p><p>Statistics allows up to three pivots in the request.</p><p>Analytics finder is used when specifying a single pivot.</p><p><br>Default: <code>1</code><br>Example: <code>Finder.Statistics</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Pivot : `Pivot`                     | <p>Pivot of results, by which each report data point is grouped. Optional.</p><p>Possible values:</p><ul><li><code>NONE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>COMPANY</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>ACCOUNT</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>SHARE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CAMPAIGN</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CREATIVE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CAMPAIGN\_GROUP</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CONVERSION</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CONVERSATION\_NODE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CONVERSATION\_NODE\_OPTION\_INDEX</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>SERVING\_LOCATION</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>CARD\_INDEX</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_COMPANY\_SIZE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_INDUSTRY</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_SENIORITY</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_JOB\_TITLE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_JOB\_FUNCTION</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_COUNTRY\_V2</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_REGION\_V2</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>MEMBER\_COMPANY</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>PLACEMENT\_NAME</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><ul><li><code>IMPRESSION\_DEVICE\_TYPE</code>:</li></ul><p>Pivot of results, by which each report data point is grouped. Optional.</p><p><br>Default: <code>-</code><br>Example: <code>Pivot.COMPANY</code></p> |
| Pivots : `Pivot[]`                  | <p>Pivot of results, by which each report data point is grouped. Optional.</p><p><br>Default: <code>-</code><br>Example: <code>\[ Pivot.COMPANY, Pivot.ACCOUNT]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| StartDate : `String`                | <p>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></p><p><br>Default: <code>-</code><br>Example: <code>12-10-2023</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| EndDate : `String`                  | <p>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></p><p><br>Default: <code>-</code><br>Example: <code>12-10-2023</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| TimeGranularity : `TimeGranularity` | <p>Time granularity of results.</p><p>Possible values:</p><ul><li><code>ALL</code>:</li></ul><p>Time granularity of results.</p><ul><li><code>DAILY</code>:</li></ul><p>Time granularity of results.</p><ul><li><code>MONTHLY</code>:</li></ul><p>Time granularity of results.</p><ul><li><code>YEARLY</code>:</li></ul><p>Time granularity of results.</p><p><br>Default: <code>-</code><br>Example: <code>TimeGranularity.ALL</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Campaigns : `String[]`              | <p>Match result by campaign facets.</p><p><br>Default: <code>-</code><br>Example: <code>\[ urn:li:sponsoredCampaign:1234567, urn:li:sponsoredCampaign:1234568 ]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Creatives : `String[]`              | <p>Match result by creative facets.</p><p><br>Default: <code>-</code><br>Example: <code>\[ ]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Metrics : `String[]`                | <p><br>Default: <code>-</code><br>Example: <code>-</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| {% endtab %}                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

{% tab title="Parameter: Options" %}

| Name                                               | Description                                                                                                                                                                                                                                                                                                                     |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| LinkedInAPIVersion : `String`                      | <p>Version of the API used in the request.</p><p>API versions should have date format as YYYYMM or YYYYMM.RR where RR is the revision.</p><p>More information: <https://learn.microsoft.com/en-us/linkedin/marketing/versioning?view=li-lms-2023-09></p><p><br>Default: <code>202309</code><br>Example: <code>202309</code></p> |
| 🗝Token : `String`                                 | <p>Bearer token to be used for requests. Token will be added as Authorization header.</p><p><br>Default: <code>-</code><br>Example: <code>xRqjX\_9QXZlvRL6HZHJvbrubhvceV4NFccANh6RwndmAJDkPfP...</code></p>                                                                                                                     |
| ConnectionTimeoutSeconds : `Int32`                 | <p>Timeout in seconds to be used for the connection and operation.</p><p><br>Default: <code>30</code><br>Example: <code>30</code></p>                                                                                                                                                                                           |
| FollowRedirects : `Boolean`                        | <p>If FollowRedirects is set to false, all responses with an HTTP status code from 300 to 399 is returned to the application.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                                                                                                                            |
| AllowInvalidCertificate : `Boolean`                | <p>Do not throw an exception on certificate error.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p>                                                                                                                                                                                                          |
| AllowInvalidResponseContentTypeCharSet : `Boolean` | <p>Some Api's return faulty content-type charset header. This setting overrides the returned charset.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p>                                                                                                                                                       |
| ThrowExceptionOnErrorResponse : `Boolean`          | <p>Throw exception if return code of request is not successfull.</p><p><br>Default: <code>-</code><br>Example: <code>true</code></p>                                                                                                                                                                                            |
| AutomaticCookieHandling : `Boolean`                | <p>If set to false, cookies must be handled manually. Defaults to true.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p>                                                                                                                                                                                  |
| {% endtab %}                                       |                                                                                                                                                                                                                                                                                                                                 |

{% tab title="Result: Result" %}

| Name                                   | Description                                                                                                                                                                                                       |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Body : `Object`                        | <p>Body of response. Response body contains two properties: paging and elements.<br>Example: <code>{"paging": {"start": 0, "count":10, "links": \[], "total": 1}, "elements": \[{"totalBudget": ...}]}</code></p> |
| Headers : `Dictionary<String, String>` | <p>Headers of response<br>Example: <code>{\[ "content-type": "application/json", ... ]}</code></p>                                                                                                                |
| StatusCode : `Int32`                   | <p>Status code of the response.<br>Example: <code>200</code></p>                                                                                                                                                  |
| {% endtab %}                           |                                                                                                                                                                                                                   |

{% tab title="Changelog" %}

## Changelog

### \[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
  {% endtab %}
  {% endtabs %}