Class AnalyticsImpressionSample
AnalyticsImpressionSample
Inheritance
Inherited Members
Namespace: Bitmovin.Api.Sdk.Models
Assembly: Bitmovin.Api.Sdk.dll
Syntax
public class AnalyticsImpressionSampleProperties
Ad
Is an ad playing. 0 indicates no, 1 indicates yes
Declaration
public long? Ad { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
AnalyticsVersion
Collector version
Declaration
public string AnalyticsVersion { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
AudioBitrate
Audio Bitrate
Declaration
public long? AudioBitrate { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
AudioCodec
Audio codec of currently playing stream
Declaration
public string AudioCodec { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
AudioLanguage
Selected audio language
Declaration
public string AudioLanguage { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Autoplay
Autoplay enabled
Declaration
public bool? Autoplay { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Browser
Browser name
Declaration
public string Browser { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
BrowserVersionMajor
Browser version major
Declaration
public string BrowserVersionMajor { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
BrowserVersionMinor
Browser version minor
Declaration
public string BrowserVersionMinor { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Buffered
Milliseconds the player buffered
Declaration
public long? Buffered { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
CastTech
Casting Technology
Declaration
public string CastTech { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CdnProvider
CDN Provider
Declaration
public string CdnProvider { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
City
City
Declaration
public string City { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ClientTime
Current time of the client
Declaration
public long? ClientTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Country
Country
Declaration
public string Country { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData1
Free form data set via the customData1 field in the analytics collector configuration
Declaration
public string CustomData1 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData10
Free form data set via the customData10 field in the analytics collector configuration
Declaration
public string CustomData10 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData11
Free form data set via the customData11 field in the analytics collector configuration
Declaration
public string CustomData11 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData12
Free form data set via the customData12 field in the analytics collector configuration
Declaration
public string CustomData12 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData13
Free form data set via the customData13 field in the analytics collector configuration
Declaration
public string CustomData13 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData14
Free form data set via the customData14 field in the analytics collector configuration
Declaration
public string CustomData14 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData15
Free form data set via the customData15 field in the analytics collector configuration
Declaration
public string CustomData15 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData16
Free form data set via the customData16 field in the analytics collector configuration
Declaration
public string CustomData16 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData17
Free form data set via the customData17 field in the analytics collector configuration
Declaration
public string CustomData17 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData18
Free form data set via the customData18 field in the analytics collector configuration
Declaration
public string CustomData18 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData19
Free form data set via the customData19 field in the analytics collector configuration
Declaration
public string CustomData19 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData2
Free form data set via the customData2 field in the analytics collector configuration
Declaration
public string CustomData2 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData20
Free form data set via the customData20 field in the analytics collector configuration
Declaration
public string CustomData20 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData21
Free form data set via the customData21 field in the analytics collector configuration
Declaration
public string CustomData21 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData22
Free form data set via the customData22 field in the analytics collector configuration
Declaration
public string CustomData22 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData23
Free form data set via the customData23 field in the analytics collector configuration
Declaration
public string CustomData23 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData24
Free form data set via the customData24 field in the analytics collector configuration
Declaration
public string CustomData24 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData25
Free form data set via the customData25 field in the analytics collector configuration
Declaration
public string CustomData25 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData26
Free form data set via the customData26 field in the analytics collector configuration
Declaration
public string CustomData26 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData27
Free form data set via the customData27 field in the analytics collector configuration
Declaration
public string CustomData27 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData28
Free form data set via the customData28 field in the analytics collector configuration
Declaration
public string CustomData28 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData29
Free form data set via the customData29 field in the analytics collector configuration
Declaration
public string CustomData29 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData3
Free form data set via the customData3 field in the analytics collector configuration
Declaration
public string CustomData3 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData30
Free form data set via the customData30 field in the analytics collector configuration
Declaration
public string CustomData30 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData4
Free form data set via the customData4 field in the analytics collector configuration
Declaration
public string CustomData4 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData5
Free form data set via the customData5 field in the analytics collector configuration
Declaration
public string CustomData5 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData6
Free form data set via the customData6 field in the analytics collector configuration
Declaration
public string CustomData6 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData7
Free form data set via the customData7 field in the analytics collector configuration
Declaration
public string CustomData7 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData8
Free form data set via the customData8 field in the analytics collector configuration
Declaration
public string CustomData8 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomData9
Free form data set via the customData9 field in the analytics collector configuration
Declaration
public string CustomData9 { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
CustomUserId
Custom user ID
Declaration
public string CustomUserId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DeviceClass
Type of device (Desktop, Phone, Tablet)
Declaration
public string DeviceClass { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DeviceType
Type of the device detected via User Agent
Declaration
public string DeviceType { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Domain
Domain the player was loaded on (.www is stripped away)
Declaration
public string Domain { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DrmLoadTime
Time in milliseconds it took the DRM server to respond
Declaration
public long? DrmLoadTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
DrmType
DRM system used for this impression
Declaration
public string DrmType { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
DroppedFrames
Dropped frames during playback
Declaration
public long? DroppedFrames { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Duration
Duration of the sample in milliseconds
Declaration
public long? Duration { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
ErrorCode
Error code
Declaration
public int? ErrorCode { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
ErrorMessage
Error message
Declaration
public string ErrorMessage { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ExperimentName
A/B test experiment name
Declaration
public string ExperimentName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ImpressionId
Random UUID that is used to identify a session (required)
Declaration
public string ImpressionId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
IpAddress
IP Address of the client
Declaration
public string IpAddress { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
IsCasting
Is chromecast active
Declaration
public bool? IsCasting { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
IsLive
Is the stream live or VoD
Declaration
public bool? IsLive { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
IsMuted
Is the player muted
Declaration
public bool? IsMuted { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
Isp
The users Internet Service Provider inferred via the IP address
Declaration
public string Isp { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Language
Language set in the browser
Declaration
public string Language { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
LicenseKey
Analytics license key
Declaration
public string LicenseKey { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
M3u8Url
URL of the HLS source
Declaration
public string M3u8Url { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
MpdUrl
URL of the DASH source
Declaration
public string MpdUrl { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Operatingsystem
Operating system
Declaration
public string Operatingsystem { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
OperatingsystemVersionMajor
Operating system version major
Declaration
public string OperatingsystemVersionMajor { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
OperatingsystemVersionMinor
Operating system version minor
Declaration
public string OperatingsystemVersionMinor { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PageLoadTime
Time in milliseconds the page took to load
Declaration
public int? PageLoadTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
PageLoadType
Player load type. 1 = Foreground, 2 = Background
Declaration
public int? PageLoadType { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Path
path on the website
Declaration
public string Path { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Paused
Milliseconds the player was paused
Declaration
public long? Paused { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Platform
Platform the player is running on (web, android, ios)
Declaration
public string Platform { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Played
Milliseconds the player played
Declaration
public long? Played { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Player
Video player being used for this session
Declaration
public string Player { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PlayerKey
Player license key
Declaration
public string PlayerKey { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PlayerStartuptime
Time in milliseconds the player took to start up
Declaration
public int? PlayerStartuptime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
PlayerTech
HTML or native playback
Declaration
public string PlayerTech { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
PlayerVersion
Player software version
Declaration
public string PlayerVersion { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ProgUrl
URL of the progressive MP4 source
Declaration
public string ProgUrl { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Region
Geographic region (ISO 3166-2 code)
Declaration
public string Region { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ScreenHeight
Screen as reported by the browser
Declaration
public int? ScreenHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
ScreenWidth
Screen as reported by the browser
Declaration
public int? ScreenWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
Seeked
Milliseconds it took the player to seek
Declaration
public long? Seeked { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
SegmentDownloadCount
Number of video segments downloaded
Declaration
public int? SegmentDownloadCount { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
SegmentDownloadSize
Size of downloaded video segments (byte)
Declaration
public int? SegmentDownloadSize { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
SegmentDownloadTime
Cumulative time needed to download video segments
Declaration
public int? SegmentDownloadTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
SequenceNumber
Sequence number of the sample in which it occured in the session
Declaration
public long? SequenceNumber { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
Size
Video size (FULLSCREEN or WINDOW)
Declaration
public string Size { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Startuptime
Combination of player- and videoStartuptime
Declaration
public int? Startuptime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
State
Internal state of the analytics state machine
Declaration
public string State { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
StreamFormat
Format of the stream (HLS, DASH, Progressive MP4)
Declaration
public string StreamFormat { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
SubtitleEnabled
Subtitle enabled
Declaration
public bool? SubtitleEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
SubtitleLanguage
Selected subtitle language
Declaration
public string SubtitleLanguage { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
SupportedVideoCodes
Video codecs supported by platform/browser
Declaration
public List<string> SupportedVideoCodes { get; set; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.String> |
Time
Current time in milliseconds
Declaration
public long? Time { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
UserId
ID that is persisted across sessions to identify a browser
Declaration
public string UserId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
VideoBitrate
Bitrate of the played back video rendition
Declaration
public long? VideoBitrate { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
VideoCodec
Video codec of current stream
Declaration
public string VideoCodec { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
VideoDuration
Length of the video in milliseconds
Declaration
public long? VideoDuration { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
VideoId
ID of the video as configured via the analytics config
Declaration
public string VideoId { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
VideoPlaybackHeight
Resolution of the played back Video Rendition
Declaration
public int? VideoPlaybackHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
VideoPlaybackWidth
Resolution of the played back Video Rendition
Declaration
public int? VideoPlaybackWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
VideostartFailed
True if starting the video failed
Declaration
public bool? VideostartFailed { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> |
VideostartFailedReason
Reason why starting the video failed
Declaration
public AnalyticsVideoStartFailedReason? VideostartFailedReason { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<AnalyticsVideoStartFailedReason> |
VideoStartuptime
Time in milliseconds it took to start video playback
Declaration
public long? VideoStartuptime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
VideotimeEnd
End time of the sample in the video (milliseconds)
Declaration
public long? VideotimeEnd { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
VideotimeStart
Start time of the sample in the video (milliseconds)
Declaration
public long? VideotimeStart { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> |
VideoTitle
Free form human readable video title as configured in the analytics config
Declaration
public string VideoTitle { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
VideoWindowHeight
Height of the video player on the page
Declaration
public int? VideoWindowHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
VideoWindowWidth
Width of the video player on the page
Declaration
public int? VideoWindowWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |