Skip to content
FrameWorks Docs
Blog

Analytics types S–V

GraphQL schema reference · API guide · SDKs · Types of Analytics

SessionQoeSummary

Section titled “SessionQoeSummary”

object

Viewer-experienced QoE summary. Ratios are sum(numerator)/sum(denominator) over the player-reported session beacons; rebufferingRatio is the headline QoE number.

  • sessionCount: Int!
  • playedHours: Float!
  • rebufferingRatio: Float!
  • rebuffersPerHour: Float!
  • avgRebufferMs: Float!
  • frameDropRatio: Float!
  • playbackFailureRate: Float!
  • ebvsRate: Float!
  • avgBitrateBps: Float!
  • abrSwitchesPerHour: Float!
  • avgLiveEdgeLatencyMs: Float!

SessionQoeTimeSeriesBucket

Section titled “SessionQoeTimeSeriesBucket”

object

One toStartOfInterval window of the viewer-experienced QoE summary. Ratios are sum(numerator)/sum(denominator) over the per-session rollup; sessionCount and playedHours are the per-bucket denominators.

  • timestamp: Time! (Time)
  • sessionCount: Int!
  • playedHours: Float!
  • rebufferingRatio: Float!
  • frameDropRatio: Float!
  • avgBitrateBps: Float!

SortOrder

Section titled “SortOrder”

enum

Sort direction for ordered results.

  • ASC — Ascending order (oldest first, A-Z).
  • DESC — Descending order (newest first, Z-A).

StorageEventEdge

Section titled “StorageEventEdge”

object

StorageEventsConnection

Section titled “StorageEventsConnection”

object

StorageUsage

Section titled “StorageUsage”

object

StorageUsageConnection

Section titled “StorageUsageConnection”

object

StorageUsageEdge

Section titled “StorageUsageEdge”

object

StorageUsageRecord

Section titled “StorageUsageRecord”

object

Implements Node.

  • id: ID!
  • timestamp: Time! (Time)
  • nodeId: String!
  • storageScope: String!
  • totalBytes: Float!
  • fileCount: Int!
  • dvrBytes: Float!
  • clipBytes: Float!
  • vodBytes: Float!
  • frozenDvrBytes: Float!
  • frozenClipBytes: Float!
  • frozenVodBytes: Float!

StreamAnalyticsDaily

Section titled “StreamAnalyticsDaily”

object

Implements Node.

  • id: ID!
  • day: Time! (Time)
  • streamId: ID!
  • stream: Stream (Stream)
  • totalViews: Int!
  • uniqueViewers: Int!
  • uniqueCountries: Int!
  • uniqueCities: Int!
  • egressBytes: Float!

StreamAnalyticsDailyConnection

Section titled “StreamAnalyticsDailyConnection”

object

StreamAnalyticsDailyEdge

Section titled “StreamAnalyticsDailyEdge”

object

StreamAnalyticsSummary

Section titled “StreamAnalyticsSummary”

object

  • streamId: ID!
  • stream: Stream (Stream)
  • timeRange: TimeRange! (TimeRange)
  • rangeAvgViewers: Float!
  • rangePeakConcurrentViewers: Int!
  • rangeTotalViews: Int!
  • rangeTotalSessions: Int!
  • rangeAvgBufferHealth: Float!
  • rangeAvgBitrate: Int!
  • rangeAvgFps: Float!
  • rangePacketLossRate: Float
  • rangeAvgConnectionTime: Float
  • rangeViewerHours: Float!
  • rangeEgressGb: Float!
  • rangeAvgSessionSeconds: Float!
  • rangeAvgBytesPerSession: Float!
  • rangeUniqueViewers: Int!
  • rangeUniqueCountries: Int!
  • rangeRebufferCount: Int!
  • rangeIssueCount: Int!
  • rangeBufferDryCount: Int!
  • rangeQuality: QualityTierSummary! (QualityTierSummary)
  • rangeEgressSharePercent: Float — This stream’s percentage of tenant total egress (only set in bulk queries).
  • rangeViewerSharePercent: Float — This stream’s percentage of tenant total unique viewers (only set in bulk queries).
  • rangeViewerHoursSharePercent: Float — This stream’s percentage of tenant total viewer hours (only set in bulk queries).

StreamAnalyticsSummaryConnection

Section titled “StreamAnalyticsSummaryConnection”

object

Connection for paginated stream analytics summaries. Returns pre-aggregated summaries for multiple streams with share percentages.

StreamAnalyticsSummaryEdge

Section titled “StreamAnalyticsSummaryEdge”

object

Edge for StreamAnalyticsSummary connection.

StreamConnectionHourly

Section titled “StreamConnectionHourly”

object

Implements Node.

  • id: ID!
  • hour: Time! (Time)
  • streamId: ID!
  • stream: Stream (Stream)
  • totalBytes: Float!
  • uniqueViewers: Int!
  • totalSessions: Int!

StreamConnectionHourlyConnection

Section titled “StreamConnectionHourlyConnection”

object

StreamConnectionHourlyEdge

Section titled “StreamConnectionHourlyEdge”

object

StreamEventEdge

Section titled “StreamEventEdge”

object

StreamEventsConnection

Section titled “StreamEventsConnection”

object

StreamHealth5m

Section titled “StreamHealth5m”

object

Implements Node.

  • id: ID!
  • timestamp: Time! (Time)
  • nodeId: String
  • rebufferCount: Int!
  • issueCount: Int!
  • sampleIssues: String
  • avgBitrate: Int!
  • avgFps: Float!
  • avgBufferHealth: Float!
  • avgFrameJitterMs: Float
  • maxFrameJitterMs: Float
  • bufferDryCount: Int!
  • qualityTier: String

StreamHealth5mConnection

Section titled “StreamHealth5mConnection”

object

StreamHealth5mEdge

Section titled “StreamHealth5mEdge”

object

StreamHealthMetric

Section titled “StreamHealthMetric”

object

Implements Node.

  • id: ID!
  • timestamp: Time! (Time)
  • streamId: ID!
  • stream: Stream (Stream)
  • nodeId: String!
  • issuesDescription: String
  • hasIssues: Boolean!
  • bitrate: Int
  • fps: Float
  • width: Int
  • height: Int
  • codec: String
  • qualityTier: String
  • gopSize: Int
  • frameMsMax: Float
  • frameMsMin: Float
  • framesMax: Int
  • framesMin: Int
  • keyframeMsMax: Float
  • keyframeMsMin: Float
  • frameJitterMs: Float
  • trackCount: Int
  • bufferState: BufferState! (BufferState)
  • bufferHealth: Float
  • bufferSize: Int
  • audioChannels: Int
  • audioSampleRate: Int
  • audioCodec: String
  • audioBitrate: Int
  • trackMetadata: JSON (JSON)

StreamHealthMetricEdge

Section titled “StreamHealthMetricEdge”

object

StreamHealthMetricsConnection

Section titled “StreamHealthMetricsConnection”

object

StreamHealthSummary

Section titled “StreamHealthSummary”

object

Pre-aggregated stream health summary from stream_health_5m.

  • avgBitrate: Float!
  • avgFps: Float!
  • avgBufferHealth: Float!
  • totalRebufferCount: Int!
  • totalIssueCount: Int!
  • sampleCount: Int!
  • hasActiveIssues: Boolean!
  • currentQualityTier: String

StreamSummarySortField

Section titled “StreamSummarySortField”

enum

Sort field for stream analytics summaries.

  • EGRESS_GB — Sort by egress bandwidth (cost attribution).
  • UNIQUE_VIEWERS — Sort by unique viewers (engagement).
  • TOTAL_VIEWS — Sort by total views (popularity).
  • VIEWER_HOURS — Sort by viewer hours (watch time).

StreamingUsage

Section titled “StreamingUsage”

object

Streaming usage analytics. streamId arguments accept Stream.id (Relay global ID).

TenantAnalyticsDaily

Section titled “TenantAnalyticsDaily”

object

  • id: ID!
  • day: Time! (Time)
  • totalStreams: Int!
  • totalViews: Int!
  • uniqueViewers: Int!
  • egressBytes: Float!

TenantAnalyticsDailyConnection

Section titled “TenantAnalyticsDailyConnection”

object

TenantAnalyticsDailyEdge

Section titled “TenantAnalyticsDailyEdge”

object

TenantDailyStat

Section titled “TenantDailyStat”

object

Implements Node.

  • id: ID!
  • date: Time! (Time)
  • egressGb: Float!
  • viewerHours: Float!
  • uniqueViewers: Int!
  • totalSessions: Int!
  • totalViews: Int!

TimeRange

Section titled “TimeRange”

object

Time range returned in query results.

  • start: Time! (Time) — Start of the time range.
  • end: Time! (Time) — End of the time range.

TopAssetEntry

Section titled “TopAssetEntry”

object

One ranked asset for the Top Assets surface — cross-kind, ranked server-side by audience sessions in the window. kind badges the asset type; title/playbackId are composed from the catalog. (Named distinctly from the periscope proto TopAsset to avoid gqlgen autobinding to that message.)

  • artifactHash: String!
  • kind: StorageArtifactKind! (StorageArtifactKind)
  • totalSessions: Int!
  • watchHours: Float!
  • durationS: Int!
  • title: String
  • playbackId: String

TrackListEvent

Section titled “TrackListEvent”

object

Implements Node.

  • id: ID!
  • streamId: ID!
  • stream: Stream (Stream)
  • nodeId: String
  • trackList: String!
  • trackCount: Int!
  • timestamp: Time! (Time)
  • tracks: [StreamTrack!] (StreamTrack)

TrackListEventEdge

Section titled “TrackListEventEdge”

object

TrackListEventsConnection

Section titled “TrackListEventsConnection”

object

ViewerCountBucket

Section titled “ViewerCountBucket”

object

  • timestamp: Time! (Time)
  • viewerCount: Int!
  • streamId: ID
  • stream: Stream (Stream)

ViewerCountBucketEdge

Section titled “ViewerCountBucketEdge”

object

ViewerGeoHourly

Section titled “ViewerGeoHourly”

object

Implements Node.

  • id: ID!
  • hour: Time! (Time)
  • countryCode: String!
  • viewerCount: Int!
  • viewerHours: Float!
  • egressGb: Float!

ViewerGeoHourlyConnection

Section titled “ViewerGeoHourlyConnection”

object

ViewerGeoHourlyEdge

Section titled “ViewerGeoHourlyEdge”

object

ViewerGeographic

Section titled “ViewerGeographic”

object

  • timestamp: Time! (Time)
  • streamId: ID
  • stream: Stream (Stream)
  • nodeId: String
  • countryCode: String
  • city: String
  • latitude: Float
  • longitude: Float
  • viewerCount: Int
  • connectionAddr: String
  • eventType: String
  • source: String
  • sessionDurationSeconds: Int
  • bytesTransferred: Float
  • connector: String

ViewerGeographicEdge

Section titled “ViewerGeographicEdge”

object

ViewerGeographicsConnection

Section titled “ViewerGeographicsConnection”

object

ViewerHoursHourly

Section titled “ViewerHoursHourly”

object

Implements Node.

  • id: ID!
  • hour: Time! (Time)
  • streamId: ID
  • stream: Stream (Stream)
  • countryCode: String
  • uniqueViewers: Int!
  • totalSessionSeconds: Int!
  • totalBytes: Float!
  • viewerHours: Float!
  • egressGb: Float!

ViewerHoursHourlyConnection

Section titled “ViewerHoursHourlyConnection”

object

ViewerHoursHourlyEdge

Section titled “ViewerHoursHourlyEdge”

object

ViewerSession

Section titled “ViewerSession”

object

Implements Node.

  • id: ID!
  • timestamp: Time! (Time)
  • streamId: ID!
  • stream: Stream (Stream)
  • nodeId: String
  • sessionId: String!
  • connectedAt: Time (Time)
  • disconnectedAt: Time (Time)
  • connector: String
  • countryCode: String
  • city: String
  • latitude: Float
  • longitude: Float
  • durationSeconds: Int
  • bytesUp: Float
  • bytesDown: Float
  • connectionQuality: Float
  • bufferHealth: Float
  • clientBucket: GeoBucket (GeoBucket)

ViewerSessionEdge

Section titled “ViewerSessionEdge”

object

ViewerSessionsConnection

Section titled “ViewerSessionsConnection”

object

ViewerTimeSeriesConnection

Section titled “ViewerTimeSeriesConnection”

object

VodRetention

Section titled “VodRetention”

object

VOD retention curve for an artifact. retention(T) = points[T].reached / totalSessions (monotonic non-increasing); density(T) = points[T].secondsWatched (the “most replayed” curve). Buckets are fixed-width (bucketWidthS) along the asset timeline. These differ because a seek-to-end raises reach without adding density.

  • bucketWidthS: Int!
  • assetDurationS: Int!
  • totalSessions: Int!
  • points: [VodRetentionPoint!]! (VodRetentionPoint)

VodRetentionAsset

Section titled “VodRetentionAsset”

object

A VOD asset with retention data in the window. Eligibility + stats (sessions, duration, lastSeen) come from analytics; title/playbackId are composed from the catalog by artifactHash — both may be null when the asset is uncatalogued (e.g. deleted but retention still within TTL).

  • artifactHash: String!
  • totalSessions: Int!
  • durationS: Int!
  • lastSeen: Time! (Time)
  • title: String
  • playbackId: String

VodRetentionAssetConnection

Section titled “VodRetentionAssetConnection”

object

VodRetentionAssetEdge

Section titled “VodRetentionAssetEdge”

object

VodRetentionPoint

Section titled “VodRetentionPoint”

object

One point of the VOD retention curve: a fixed-width timeline bucket with its watched-seconds density and the count of sessions that reached it.

  • bucketIndex: Int!
  • secondsWatched: Float!
  • reached: Int! — Sessions whose furthest playhead position is at or beyond this bucket (audience retention numerator).