Viewership statistics for an episode
| Property | Value |
|---|---|
| Product | Publishing (pco.publishing, API version 2024-03-25) |
| Resource type | EpisodeStatistics |
| TypeScript | Publishing.EpisodeStatistics, attributes Publishing.EpisodeStatisticsAttributes, schema Publishing.EpisodeStatisticsSchema |
| Planning Center path | /publishing/v2/channels/{channel_id}/statistics |
| Planning Center docs | EpisodeStatistics |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.publishing.channels.id(channelId).statistics |
Collection | No |
From a collection, .id(episodeStatisticsId) addresses one EpisodeStatistics: pco.publishing.channels.id(channelId).statistics.id(episodeStatisticsId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Publishing.EpisodeStatisticsAttributes. Every resource also has id and type ('EpisodeStatistics') next to its attributes.
| Name | Type | Description |
|---|---|---|
library_watch_count |
boolean | null |
|
live_watch_count |
boolean | null |
|
published_live_at |
string | null |
|
published_to_library_at |
string | null |
|
times |
unknown[] | null |
watch_count per EpisodeTime |
title |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Publishing } from '@mackenly/planningcenterkit';
const channelId = '1'; // Channel id
const page = await pco.publishing.channels.id(channelId).statistics.perPage(25).list();
const items: Publishing.EpisodeStatistics[] = page.data;