@wistia/bottler-helpers 1.0.5

package/schema.graphql

@@ -0,0 +1,848 @@
+"Represents a schema"
+schema {
+  query: RootQueryType
+  mutation: RootMutationType
+}
+
+type PageInfo {
+  startCursor: String
+  endCursor: String
+  hasNextPage: Boolean!
+  hasPreviousPage: Boolean!
+}
+
+input Pagination {
+  limit: Int!
+  cursor: String
+  direction: CursorDirection
+}
+
+type PollOption {
+  id: Int!
+  text: String!
+  count: Int!
+  percent: Float!
+}
+
+input Interval {
+  startDate: Date
+  endDate: Date
+}
+
+type LiveEventReferrerDomainAggregate {
+  accountKey: String
+  accountName: String
+  liveStreamEventId: Int
+  referrerDomain: String
+  impressions: Int
+  registrations: Int
+  attendees: Int
+}
+
+type LiveEventUtmCampaignAggregate {
+  accountKey: String
+  accountName: String
+  liveStreamEventId: Int
+  utmCampaign: String
+  impressions: Int
+  registrations: Int
+  attendees: Int
+}
+
+type PodcastEpisodeApplicationAggregate {
+  accountKey: String
+  accountName: String
+  application: String
+  downloads: Int
+  playableTimeDownloaded: Int
+  percentOfDownloads: Float
+}
+
+type PlayedTimeDatapointEpisode {
+  episodeId: Int!
+  playedTime: Int!
+  episodeName: String!
+}
+
+type RelativeMediaAggregate {
+  accountKey: String
+  accountName: String
+  projectHashedId: String
+  projectName: String
+  mediaGlobalId: String
+  mediaHashedId: String
+  mediaName: String
+  mediaType: String
+  mediaUploadedAt: DateTime
+  mediaDeletedAt: DateTime
+  mediaDuration: Float
+  mediaThumbnailUrl: String
+  episodeGlobalId: String
+  episodeHashedId: String
+  episodeTitle: String
+  episodeUploadedAt: DateTime
+  episodeDeletedAt: DateTime
+  episodePublishedAt: DateTime
+  liveStreamEventId: Int
+  containerIsPodcastEnabled: Boolean
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playRate: Float
+  uniqueVisitors: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+  cumulativePlays: Int
+  cumulativePlayedTime: Int
+}
+
+"Whether a lead is new or existing to Wistia"
+enum WistiaLeadType {
+  NEW
+  EXISTING
+}
+
+type ProjectAggregate {
+  accountId: Int
+  accountKey: String
+  accountName: String
+  projectId: Int
+  projectHashedId: String
+  projectName: String
+  projectUrl: String
+  projectCreatedAt: DateTime
+  projectVideoCount: Int
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playedTimeHumanReadable: String
+  uniquePlayedTimeHumanReadable: String
+  replayedTimeHumanReadable: String
+  playRate: Float
+  uniqueVisitors: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+}
+
+type MediaFormAggregate {
+  firstName: String
+  lastName: String
+  email: String!
+  convertedAt: DateTime!
+  wistiaLeadType: WistiaLeadType!
+}
+
+type MediaEmbedLanguageAggregate {
+  mediaGlobalId: String
+  plays: Int
+  language: String
+  percentOfTotalPlays: Float
+  captionsSupport: Boolean
+}
+
+type LiveStreamEventAggregate {
+  registrations: Int
+  chats: Int
+  totalWatchTime: Int
+  averageWatchTime: Int
+  chattedAttendees: Int
+  attendance: Int
+  engagementRate: Float
+  currentlyWatching: Int
+  engagedAttendees: Int
+  impressions: Int
+  eventTime: Int
+  attendeesHistogram: [Int]
+  chatHistogram: [Int]
+  visualFocusPlayedHistogram: [Int]
+  pollQuestions: [PollQuestion!]
+  pollResponses(visitorKey: String!): [PollResponse!]
+  qaQuestions: Int
+  qaAnswers: Int
+  annotationImpressions: Int
+  annotationClicks: Int
+}
+
+union RelativeMediaEventAggregateResult = RelativeAggregateEntries | AggregateError
+
+"A metric to order traffic aggregates"
+enum TrafficMetric {
+  IMPRESSIONS
+  REGISTRATIONS
+  ATTENDEES
+}
+
+"Filter by certain types in aggregation queries"
+enum TypeFilter {
+  PROJECTS
+  CHANNELS
+  MEDIA
+  PODCAST_EPISODE
+  PODCAST_EPISODE_APPLICATION
+  ACCOUNT_EMBED_LOCATION
+  MEDIA_EMBED_LOCATION
+}
+
+input SearchFilter {
+  annotations: [Boolean]
+  autoplays: [Boolean]
+  cta: [Boolean]
+  eventbrite: [Boolean]
+  loops: [Boolean]
+  marketo: [Boolean]
+  mediaTypes: [String]
+  turnstile: [Boolean]
+  contentIds: [String]
+  tags: [String]
+}
+
+type Media {
+  podcastPlays: Int
+}
+
+type DownloadsDatapointTimestamp {
+  timestamp: DateTime!
+  downloads: Int!
+}
+
+type PollQuestion {
+  id: Int!
+  pollId: Int!
+  text: String!
+  responseCount: Int!
+  options: [PollOption!]
+}
+
+"An interval of time to aggregate metrics into datapoints"
+enum Granularity {
+  "1 day"
+  P1D
+
+  "1 week (7 days)"
+  P1W
+
+  "4 weeks (28 days)"
+  P4W
+
+  "1 month"
+  P1M
+
+  "3 months (90 days)"
+  P3M
+
+  "1 year (265 days)"
+  P1Y
+}
+
+type LiveEventTimeseriesAggregate {
+  impressions: Int
+  registrations: Int
+  completionRate: Float
+}
+
+"Type of aggregate error"
+enum AggregateErrorType {
+  "The queried interval exceeds the data retention period for the aggregate."
+  INTERVAL_EXCEEDS_RETENTION
+}
+
+"""
+The `Date` scalar type represents a date. The Date appears in a JSON
+response as an ISO8601 formatted string, without a time component.
+"""
+scalar Date
+
+type AccountEmbedLocationAggregate {
+  accountKey: String
+  accountName: String
+  embedLocationCount: Int
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+}
+
+type DownloadsDatapointEpisode {
+  episodeId: Int!
+  downloads: Int!
+  episodeName: String!
+}
+
+type PollResponse {
+  pollId: Int!
+  pollQuestionId: Int!
+  pollOptionId: Int!
+}
+
+type PlaysDatapointEpisode {
+  episodeId: Int!
+  plays: Int!
+  episodeName: String!
+}
+
+type MediaEmbedLocationAggregate {
+  accountKey: String
+  accountName: String
+  containerGlobalId: String
+  containerHashedId: String
+  containerName: String
+  episodeHashedId: String
+  episodeGlobalId: String
+  episodeTitle: String
+  mediaHashedId: String
+  mediaGlobalId: String
+  mediaName: String
+  mediaThumbnailUrl: String
+  embedDomain: String
+  embedPath: String
+  embedUrl: String
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+  pageTitle: String
+  placement: String
+  size: String
+}
+
+type ChannelAggregate {
+  accountId: Int
+  accountKey: String
+  accountName: String
+  channelId: Int
+  channelHashedId: String
+  channelCreatedAt: DateTime
+  channelEpisodeCount: Int
+  channelTitle: String
+  channelPodcastEnabled: Boolean
+  channelUrl: String
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playedTimeHumanReadable: String
+  uniquePlayedTimeHumanReadable: String
+  replayedTimeHumanReadable: String
+  playRate: Float
+  uniqueVisitors: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+}
+
+type PodcastEpisodeAggregate {
+  accountKey: String
+  accountName: String
+  downloads: Int
+  playableTimeDownloaded: Int
+}
+
+type TopEpisodesDatapoint {
+  plays: Int!
+  playedTime: Int!
+  episodeId: Int!
+  episodeName: String!
+  mediaHashedId: String!
+  averageEngagement: Float!
+  publishedAt: String!
+}
+
+type MediaEventDatapoint {
+  timestamp: String
+  entries: [MediaEventAggregate]
+}
+
+type LiveEventDataPoint {
+  timestamp: String
+  entries: [LiveEventTimeseriesAggregate]
+}
+
+"An interval of time to aggregate metrics into datapoints"
+enum RelativePeriod {
+  "1 week (7 days)"
+  P7D
+
+  "30 days"
+  P30D
+}
+
+type AccountDigestStatus {
+  name: String!
+  status: String!
+}
+
+type RootMutationType {
+  exportMedia(contactId: Int!, interval: Interval, searchFilter: SearchFilter, aggregate: ExportAggregate): ExportStatus
+  accountDigest(contactId: Int!, interval: Interval!, overrideEmail: String): AccountDigestStatus
+}
+
+type Channel {
+  channelId: String
+  interval: String
+  priorInterval: String
+  currentPlays: Int
+  priorPlays: Int
+  currentDownloads: Int
+  priorDownloads: Int
+  currentPlayedTime: Int
+  priorPlayedTime: Int
+  currentAverageSessionDuration: Int
+  priorAverageSessionDuration: Int
+  playsByEpisode: [PlaysDatapointEpisode]
+  downloadsByEpisode: [DownloadsDatapointEpisode]
+  topPlaysByApplication(limit: Int): [PlaysDatapointApplication]
+  playsByApplication: [PlaysDatapointApplication]
+  downloadsByApplication: [DownloadsDatapointApplication]
+  playsOverTime: [PlaysDatapointTimestamp]
+  downloadsOverTime: [DownloadsDatapointTimestamp]
+  currentEmbedPlayedTime: Int
+  currentPodcastPlayedTime: Int
+  priorEmbedPlayedTime: Int
+  priorPodcastPlayedTime: Int
+  embedPlayedTimeOverTime: [PlayedTimeDatapointTimestamp]
+  podcastPlayedTimeOverTime: [PlayedTimeDatapointTimestamp]
+  playedTimeOverTime: [PlayedTimeDatapointTimestamp]
+  playedTimeByEpisode: [PlayedTimeDatapointEpisode]
+  topEpisodes: [TopEpisodesDatapoint]
+}
+
+type RootQueryType {
+  channel(channelHashedId: String!, interval: Interval): Channel
+  media(mediaId: Int!): Media
+  medias(searchFilter: SearchFilter): Medias
+  mediaEvents(interval: Interval, searchFilter: SearchFilter): MediaEvents
+  liveEvents(liveStreamEventIds: [Int]!, includePostEvent: Boolean): LiveEvents
+  liveEvent(liveStreamEventId: Int!, includePostEvent: Boolean): LiveEvent
+  mediaFormConversions(mediaGlobalId: String!, interval: Interval!, pagination: Pagination): MediaFormAggregateResult
+  relativeMediaEvents(relativePeriod: RelativePeriod!, searchFilter: SearchFilter): RelativeMediaEvents
+}
+
+type MediaReferrerDomainAggregate {
+  accountKey: String
+  accountName: String
+  containerGlobalId: String
+  containerHashedId: String
+  containerName: String
+  episodeHashedId: String
+  episodeGlobalId: String
+  episodeTitle: String
+  mediaHashedId: String
+  mediaGlobalId: String
+  mediaName: String
+  referrerDomain: String
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+}
+
+type EpisodeAggregate {
+  accountKey: String
+  accountName: String
+  channelHashedId: String
+  channelTitle: String
+  channelPodcastEnabled: Boolean
+  episodeGlobalId: String
+  episodeHashedId: String
+  episodeTitle: String
+  episodePublishedAt: DateTime
+  projectHashedId: String
+  projectName: String
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playRate: Float
+  uniqueVisitors: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+}
+
+"""
+The `DateTime` scalar type represents a date and time in the UTC
+timezone. The DateTime appears in a JSON response as an ISO8601 formatted
+string, including UTC timezone ("Z"). The parsed date and time string will
+be converted to UTC if there is an offset.
+"""
+scalar DateTime
+
+type MediaUtmCampaignAggregate {
+  accountKey: String
+  accountName: String
+  containerGlobalId: String
+  containerHashedId: String
+  containerName: String
+  episodeHashedId: String
+  episodeGlobalId: String
+  episodeTitle: String
+  mediaHashedId: String
+  mediaGlobalId: String
+  mediaName: String
+  utmCampaign: String
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+}
+
+type LiveEventUtmMediumAggregate {
+  accountKey: String
+  accountName: String
+  liveStreamEventId: Int
+  utmMedium: String
+  impressions: Int
+  registrations: Int
+  attendees: Int
+}
+
+type RelativeAccountAggregate {
+  accountKey: String
+  accountName: String
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playRate: Float
+  uniqueVisitors: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+}
+
+type MediaViewerScreenSizeAggregate {
+  accountKey: String
+  accountName: String
+  containerGlobalId: String
+  containerHashedId: String
+  containerName: String
+  episodeHashedId: String
+  episodeGlobalId: String
+  episodeTitle: String
+  mediaHashedId: String
+  mediaGlobalId: String
+  mediaName: String
+  viewerScreenSize: String
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+}
+
+type MediaUtmMediumAggregate {
+  accountKey: String
+  accountName: String
+  containerGlobalId: String
+  containerHashedId: String
+  containerName: String
+  episodeHashedId: String
+  episodeGlobalId: String
+  episodeTitle: String
+  mediaHashedId: String
+  mediaGlobalId: String
+  mediaName: String
+  utmMedium: String
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+}
+
+type AccountAggregate {
+  accountKey: String
+  accountName: String
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playRate: Float
+  uniqueVisitors: Int
+  mediaCount: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+  formImpressions: Int
+  formConversions: Int
+  formConversionRate: Float
+}
+
+type LiveEvent {
+  aggregate(includePostEvent: Boolean): LiveStreamEventAggregate
+  timeseries(granularity: Granularity!): [LiveEventDataPoint]
+  referrerDomainRegistrations(orderBy: TrafficMetric!, order: Order!): [LiveEventReferrerDomainAggregate]
+  utmCampaignRegistrations(orderBy: TrafficMetric!, order: Order!): [LiveEventUtmCampaignAggregate]
+  utmSourceRegistrations(orderBy: TrafficMetric!, order: Order!): [LiveEventUtmSourceAggregate]
+  utmMediumRegistrations(orderBy: TrafficMetric!, order: Order!): [LiveEventUtmMediumAggregate]
+}
+
+type MediaFormAggregateResult {
+  pageInfo: PageInfo!
+  entries: [MediaFormAggregate]
+}
+
+type RelativeMediaEventDatapoint {
+  relativePeriod: String
+  entries: [RelativeMediaAggregate]
+}
+
+type RelativeMediaEvents {
+  timeseries(granularity: Granularity!, limit: Int): [RelativeMediaEventDatapoint]
+  orderedEntriesResult(orderBy: MediaEventMetric!, order: Order!, limit: Int!): RelativeMediaEventAggregateResult
+  aggregate: RelativeAggregate
+}
+
+type RelativeAggregateEntries {
+  entries: [RelativeMediaAggregate]
+}
+
+type AggregateEntries {
+  entries: [MediaEventAggregate]
+}
+
+type AggregateError {
+  error: AggregateErrorType!
+  message: String!
+}
+
+type PlaysDatapointTimestamp {
+  timestamp: DateTime!
+  plays: Int!
+}
+
+type PlayedTimeDatapointTimestamp {
+  timestamp: DateTime!
+  playedTime: Int!
+}
+
+"A field to group entries by"
+enum MediaEventDimension {
+  ACCOUNT
+  PROJECT
+  CHANNEL
+  EPISODE
+  MEDIA
+  ACCOUNT_EMBED_LOCATION
+  MEDIA_EMBED_LOCATION
+  MEDIA_EMBED_LANGUAGE
+  PODCAST_EPISODE_APPLICATION
+  MEDIA_REFERRER_DOMAIN
+  MEDIA_VIEWER_SCREEN_SIZE
+  MEDIA_UTM_CAMPAIGN
+  MEDIA_UTM_SOURCE
+  MEDIA_UTM_MEDIUM
+}
+
+"Which way to paginate from a cursor"
+enum CursorDirection {
+  BEFORE
+  AFTER
+}
+
+"A field to filter entries by"
+enum FilterDimension {
+  EMBED_DOMAIN
+}
+
+type DownloadsDatapointApplication {
+  application: String!
+  downloads: Int!
+}
+
+type PlaysDatapointApplication {
+  application: String!
+  plays: Int!
+}
+
+type LiveEventUtmSourceAggregate {
+  accountKey: String
+  accountName: String
+  liveStreamEventId: Int
+  utmSource: String
+  impressions: Int
+  registrations: Int
+  attendees: Int
+}
+
+union RelativeAggregate = RelativeAccountAggregate
+
+type MediaAggregate {
+  accountKey: String
+  accountName: String
+  projectHashedId: String
+  projectName: String
+  mediaGlobalId: String
+  mediaHashedId: String
+  mediaName: String
+  mediaType: String
+  mediaUploadedAt: DateTime
+  mediaDeletedAt: DateTime
+  mediaDuration: Float
+  mediaThumbnailUrl: String
+  episodeGlobalId: String
+  episodeHashedId: String
+  episodeTitle: String
+  episodeUploadedAt: DateTime
+  episodeDeletedAt: DateTime
+  episodePublishedAt: DateTime
+  liveStreamEventId: Int
+  containerIsPodcastEnabled: Boolean
+  loads: Int
+  uniqueLoads: Int
+  plays: Int
+  uniquePlays: Int
+  playedTime: Int
+  uniquePlayedTime: Int
+  playRate: Float
+  uniqueVisitors: Int
+  ctaImpressions: Int
+  ctaConversions: Int
+  ctaConversionRate: Float
+  engagementRate: Float
+  formImpressions: Int
+  formConversions: Int
+  formConversionRate: Float
+}
+
+type MediaUtmSourceAggregate {
+  accountKey: String
+  accountName: String
+  containerGlobalId: String
+  containerHashedId: String
+  containerName: String
+  episodeHashedId: String
+  episodeGlobalId: String
+  episodeTitle: String
+  mediaHashedId: String
+  mediaGlobalId: String
+  mediaName: String
+  utmSource: String
+  plays: Int
+  playRate: Float
+  engagementRate: Float
+  playedTime: Int
+  loads: Int
+  uniqueVisitors: Int
+  ctaConversionRate: Float
+}
+
+"Type of export aggregate"
+enum ExportAggregate {
+  MEDIA
+  PROJECT_MEDIA
+  MEDIA_EMBED_LOCATION
+  PROJECTS
+  CHANNELS
+  PODCAST_EPISODE_APPLICATION
+  CHANNEL_EPISODE
+  PODCAST_EPISODE
+  MEDIA_FORM_CONVERSION
+  MEDIA_COMPARISON
+}
+
+union MediaEventAggregate = AccountAggregate | ChannelAggregate | EpisodeAggregate | MediaAggregate | PodcastEpisodeAggregate | PodcastEpisodeApplicationAggregate | ProjectAggregate | AccountEmbedLocationAggregate | MediaEmbedLocationAggregate | MediaReferrerDomainAggregate | MediaEmbedLanguageAggregate | MediaViewerScreenSizeAggregate | MediaUtmCampaignAggregate | MediaUtmSourceAggregate | MediaUtmMediumAggregate
+
+union MediaEventAggregateResult = AggregateEntries | AggregateError
+
+type MediaEvents {
+  aggregate(typeFilter: TypeFilter): MediaEventAggregate
+  timeseries(
+    for: MediaEventMetric!, over: MediaEventDimension!, granularity: Granularity!, typeFilter: TypeFilter, limit: Int
+  ): [MediaEventDatapoint]
+  orderedEntries(
+    groupBy: MediaEventDimension!, orderBy: MediaEventMetric!, order: Order!, limit: Int!, excludeAggregatesWithoutStats: Boolean, filters: [Filter]
+  ): [MediaEventAggregate]
+  orderedEntriesResult(
+    groupBy: MediaEventDimension!, orderBy: MediaEventMetric!, order: Order!, limit: Int!, excludeAggregatesWithoutStats: Boolean, filters: [Filter]
+  ): MediaEventAggregateResult
+}
+
+type ExportStatus {
+  name: String!
+  status: String!
+}
+
+type Medias {
+  totalCount: Int
+}
+
+type LiveEvents {
+  aggregate: LiveStreamEventAggregate
+}
+
+"A metric to order entries by"
+enum MediaEventMetric {
+  PLAYS
+  PLAYED_TIME
+  PLAY_RATE
+  ENGAGEMENT_RATE
+  CTA_CONVERSION_RATE
+  LOADS
+  UNIQUE_VISITORS
+  DOWNLOADS
+  PERCENT_OF_DOWNLOADS
+  PLAYABLE_TIME_DOWNLOADED
+  PLACEMENT
+  SIZE
+  FORM_CONVERSIONS
+}
+
+"Sort order"
+enum Order {
+  "Ascending sort order"
+  ASC
+
+  "Descending sort order"
+  DESC
+}
+
+input Filter {
+  dimension: FilterDimension!
+  value: String
+  operator: Operator
+}
+
+"Operation to perform on filter"
+enum Operator {
+  EQUALS
+  NOT_EQUALS
+}