Skip to main content
GET
Prefer the terminal? This endpoint is also a command in the Particle CLI: pick Particle CLI in the request example’s language menu. Install the Particle CLI.

Authorizations

X-API-Key
string
header
required

Pass your API key in the X-API-Key header (recommended).

Query Parameters

sponsor_id
string

Sponsor ID. Exactly one of sponsor_id or company_id is required.

company_id
string

Company ID, domain, or entity slug. Aggregates across every sponsor alias linked to the company.

podcast_id
string

Restrict to ad placements on one podcast, by slug or ID.

publisher_id
string

Restrict to ad placements on podcasts attributed to one publisher (network), by slug or ID.

since
string

Inclusive start of the range as an ISO 8601 date or date-time. Omit for all time.

until
string

End of the range as an ISO 8601 date or date-time. A bare date includes that whole day. Defaults to now.

published_after
string
deprecated

Deprecated alias of since.

published_before
string
deprecated

Deprecated alias of until.

interval
enum<string>
default:week

Bucket width. Weeks start on Monday and all buckets are UTC-aligned.

Available options:
day,
week,
month

Response

OK

buckets
object[] | null
required

Contiguous zero-filled buckets in ascending order

distinct_episodes
integer<int64>
required

Distinct episodes those placements aired in

distinct_podcasts
integer<int64>
required

Distinct podcasts those placements aired on

host_read_count
integer<int64>
required

Host-read placements in the range

interval
enum<string>
required

Bucket width

Available options:
day,
week,
month
pre_recorded_count
integer<int64>
required

Placements not read by the host in the range

total_ads
integer<int64>
required

Ad placements matching the filters in the range

end
string

UTC date of the range's exclusive upper bound. When the bound falls inside a day, such as the default of now, ads on this date up to the bound are still counted.

start
string

Start of the first bucket as a UTC date