Particle: Get Advertising Leaderboard Preview

Get the fixed top-10 podcast sponsors of the trailing 7 days with rank movement.

Tool ID: particle_get_advertising_leaderboard_preview

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'particle_get_advertising_leaderboard_preview',
  {
    "metric": "ad_count"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute particle_get_advertising_leaderboard_preview --input '{
  "metric": "ad_count"
}' --json

Example response

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

{
  "data": {
    "data": [
      {
        "movement": "new",
        "rank": 123,
        "rank_change": 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_preview --json for the latest machine-readable contract.

Input reference

Returns the top 10 advertising sponsors of the trailing 7 days ranked by the chosen metric, each with its rank movement versus the equivalent 7-day window ending 30 days ago. Every caller gets the same board regardless of plan, so unlike get-advertising-leaderboard this endpoint requires no premium access and is safe to render for signed-out visitors. Use get-advertising-leaderboard for deeper pages, other time windows, and company or publisher filtering.

Name	Type	Required	Default	Details
`payload.metric`	`"ad_count" \| "podcast_reach" \| "episode_reach"`	No	`"ad_count"`	Metric to rank sponsors by Allowed: `ad_count`, `podcast_reach`, `episode_reach`.

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[].movement`	`"new" \| "up" \| "down" \| "flat"`	Yes	—	Movement since the 7-day window ending 30 days ago. Allowed: `new`, `up`, `down`, `flat`.
`result.data.data[].previous_rank`	`integer`	No	—	Position in the 7-day window ending 30 days ago. Null when the sponsor was not in that window’s top 50. Format: `int64`.
`result.data.data[].rank`	`integer`	Yes	—	Position in the leaderboard Format: `int64`.
`result.data.data[].rank_change`	`integer`	Yes	—	Positions climbed since the 7-day window ending 30 days ago, negative when the sponsor fell. Zero for both a flat hold and a debut. Read ‘movement’ to tell those apart. 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).

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation