> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Particle: Get Advertising Leaderboard

> Rank the top podcast advertisers (sponsors) by ad_count, podcast_reach or episode_reach, optionally by time range, company or publisher.

Rank the top podcast advertisers (sponsors) by ad\_count, podcast\_reach or episode\_reach, optionally by time range, company or publisher.

> [!NOTE]
>
> Tool ID: `particle_get_advertising_leaderboard`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'particle_get_advertising_leaderboard',
  {
    "limit": 25,
    "cursor": "cursor_123",
    "metric": "ad_count"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute particle_get_advertising_leaderboard --input '{
  "limit": 25,
  "cursor": "cursor_123",
  "metric": "ad_count"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": [
      {
        "rank": 123,
        "sponsor": {
          "ad_count": 123,
          "episode_reach": 123,
          "id": "id_123",
          "name": "Example",
          "podcast_reach": 123
        }
      }
    ],
    "has_more": true
  }
}
```

Use `deepline describe particle_get_advertising_leaderboard --json` for the latest machine-readable contract.

## Input reference

Returns the top podcast advertising sponsors ranked by the specified metric, with optional time range and company filtering. All-time rankings — and two day-anchored windows: the trailing 7 days (since = UTC today−7d, no until) and the 7-day window ending 30 days ago (since = today−37d, until = today−30d) — reflect periodically refreshed snapshots. other time-windowed and company-filtered results may be cached for up to one hour.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.limit` | `integer` | No | `25` | Results per page Format: `int64`. Minimum: 1. Maximum: 100. |
| `payload.cursor` | `string` | No | — | Opaque pagination cursor from previous response |
| `payload.metric` | `"ad_count" \| "podcast_reach" \| "episode_reach"` | No | `"ad_count"` | Metric to rank sponsors by Allowed: `ad_count`, `podcast_reach`, `episode_reach`. |
| `payload.since` | `string` | No | — | Only include ads from episodes published on or after this ISO 8601 date or date-time (e.g. 2025-01-01 or 2025-01-01T00:00:00Z) |
| `payload.until` | `string` | No | — | Only include ads from episodes published before this ISO 8601 date or date-time (e.g. 2026-01-01 or 2026-01-01T00:00:00Z) |
| `payload.company_id` | `string` | No | — | Filter by company ID, domain, or entity slug |
| `payload.publisher_id` | `string` | No | — | Restrict the leaderboard to ads on podcasts attributed to this publisher (slug or ID) |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns the top podcast advertising sponsors ranked by the specified metric, with optional time range and company filtering. All-time rankings — and two day-anchored windows: the trailing 7 days (since = UTC today−7d, no until) and the 7-day window ending 30 days ago (since = today−37d, until = today−30d) — reflect periodically refreshed snapshots; other time-windowed and company-filtered results may be cached for up to one hour.",
    "properties": {
      "limit": {
        "type": "integer",
        "description": "Results per page",
        "default": 25,
        "minimum": 1,
        "maximum": 100,
        "format": "int64"
      },
      "cursor": {
        "type": "string",
        "description": "Opaque pagination cursor from previous response"
      },
      "metric": {
        "type": "string",
        "description": "Metric to rank sponsors by",
        "default": "ad_count",
        "enum": [
          "ad_count",
          "podcast_reach",
          "episode_reach"
        ]
      },
      "since": {
        "type": "string",
        "description": "Only include ads from episodes published on or after this ISO 8601 date or date-time (e.g. 2025-01-01 or 2025-01-01T00:00:00Z)"
      },
      "until": {
        "type": "string",
        "description": "Only include ads from episodes published before this ISO 8601 date or date-time (e.g. 2026-01-01 or 2026-01-01T00:00:00Z)"
      },
      "company_id": {
        "type": "string",
        "description": "Filter by company ID, domain, or entity slug"
      },
      "publisher_id": {
        "type": "string",
        "description": "Restrict the leaderboard to ads on podcasts attributed to this publisher (slug or ID)"
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.cursor` | `string` | No | — | Pass to next request for more results |
| `result.data.data` | `array` | Yes | — | List of results |
| `result.data.data[].rank` | `integer` | Yes | — | Position in the leaderboard Format: `int64`. |
| `result.data.data[].sponsor` | `object` | Yes | — | — |
| `result.data.data[].sponsor.ad_count` | `integer` | Yes | — | Total number of ads (excluding network promos) Format: `int64`. |
| `result.data.data[].sponsor.company` | `object` | No | — | — |
| `result.data.data[].sponsor.company.description` | `string` | No | — | Short company description, when known. |
| `result.data.data[].sponsor.company.domain` | `string` | No | — | Primary website domain (e.g. 'nvidia.com'), when known. |
| `result.data.data[].sponsor.company.id` | `string` | Yes | — | Company identifier (domain, slug, or encoded ID) |
| `result.data.data[].sponsor.company.image_url` | `string` | No | — | Company logo or image URL |
| `result.data.data[].sponsor.company.name` | `string` | Yes | — | Company name |
| `result.data.data[].sponsor.company.slug` | `string` | No | — | Stable human-readable handle (the linked knowledge-graph slug, e.g. 'nvidia'), when known. Companies have no slug of their own. prefer this for display and pass it (or id) to /v1/companies. |
| `result.data.data[].sponsor.company.ticker` | `string` | No | — | Primary stock ticker symbol, when listed. |
| `result.data.data[].sponsor.episode_reach` | `integer` | Yes | — | Number of distinct episodes featuring the sponsor Format: `int64`. |
| `result.data.data[].sponsor.first_seen_at` | `string` | No | — | Earliest detected ad appearance Format: `date-time`. |
| `result.data.data[].sponsor.id` | `string` | Yes | — | Unique identifier |
| `result.data.data[].sponsor.last_seen_at` | `string` | No | — | Most recent ad appearance Format: `date-time`. |
| `result.data.data[].sponsor.name` | `string` | Yes | — | Sponsor name |
| `result.data.data[].sponsor.podcast_reach` | `integer` | Yes | — | Number of distinct podcasts the sponsor advertises on Format: `int64`. |
| `result.data.has_more` | `boolean` | Yes | — | Whether more results exist |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "cursor": {
            "type": "string",
            "description": "Pass to next request for more results"
          },
          "data": {
            "type": "array",
            "description": "List of results",
            "items": {
              "type": "object",
              "properties": {
                "rank": {
                  "type": "integer",
                  "description": "Position in the leaderboard",
                  "format": "int64"
                },
                "sponsor": {
                  "type": "object",
                  "properties": {
                    "ad_count": {
                      "type": "integer",
                      "description": "Total number of ads (excluding network promos)",
                      "format": "int64"
                    },
                    "company": {
                      "type": "object",
                      "properties": {
                        "description": {
                          "type": "string",
                          "description": "Short company description, when known."
                        },
                        "domain": {
                          "type": "string",
                          "description": "Primary website domain (e.g. 'nvidia.com'), when known."
                        },
                        "id": {
                          "type": "string",
                          "description": "Company identifier (domain, slug, or encoded ID)"
                        },
                        "image_url": {
                          "type": "string",
                          "description": "Company logo or image URL"
                        },
                        "name": {
                          "type": "string",
                          "description": "Company name"
                        },
                        "slug": {
                          "type": "string",
                          "description": "Stable human-readable handle (the linked knowledge-graph slug, e.g. 'nvidia'), when known. Companies have no slug of their own; prefer this for display and pass it (or id) to /v1/companies."
                        },
                        "ticker": {
                          "type": "string",
                          "description": "Primary stock ticker symbol, when listed."
                        }
                      },
                      "required": [
                        "id",
                        "name"
                      ],
                      "additionalProperties": false
                    },
                    "episode_reach": {
                      "type": "integer",
                      "description": "Number of distinct episodes featuring the sponsor",
                      "format": "int64"
                    },
                    "first_seen_at": {
                      "type": "string",
                      "description": "Earliest detected ad appearance",
                      "format": "date-time"
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier"
                    },
                    "last_seen_at": {
                      "type": "string",
                      "description": "Most recent ad appearance",
                      "format": "date-time"
                    },
                    "name": {
                      "type": "string",
                      "description": "Sponsor name"
                    },
                    "podcast_reach": {
                      "type": "integer",
                      "description": "Number of distinct podcasts the sponsor advertises on",
                      "format": "int64"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "ad_count",
                    "podcast_reach",
                    "episode_reach"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "rank",
                "sponsor"
              ],
              "additionalProperties": false
            }
          },
          "has_more": {
            "type": "boolean",
            "description": "Whether more results exist"
          }
        },
        "required": [
          "data",
          "has_more"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Particle provider guide](https://deepline.com/docs/providers/particle/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.