Insight Platform - Current Product 2015-02-13
-
Upload
rahul-bansod -
Category
Documents
-
view
7 -
download
0
Transcript of Insight Platform - Current Product 2015-02-13
Insight Platform SpecificationFor product shipped as of February 13, 2015
2
1. IntroductionThe Insight product suite consists of a number of different products:
Content Insights - the core insight platform Viewer Insights - tools to target individual subscribers and better retain them Pay Per View - monitoring subscriber purchasing behaviour for PPV content Ads and Promos - a suite of tools for improving ad sales Promo Booster - tool to measure and optimise the effectiveness of on-air
promotions Viewer Ascription - segmentation of viewers as individuals rather than
households Multiscreen Quality - a suite of tools to monitor and enhance the end user
experience for those on mobile devices and PCs DVB/IPTV Quality - monitoring performance quality on STBs and identifying
errors UX Insights - a bespoke tool to track and improve user interfaces
Each product consists of cubes and/or dashboards. The cubes enable users to explore the data and the dashboards meet the key use cases in an easy to use format. Both cubes and dashboards can be customised as part of a bespoke Insights deployment.
This document details each of the products available and their corresponding cubes and dashboards. Each cube and dashboard is then described in terms of the dimensions and measures which are included. Finally there is a comprehensive A-Z of Dimensions and Measures and the standard data import fields that are used to populate them.
1.1. Insight Product SuiteContent Insights is the core product within the Insights Product suite allowing the other products to build on Content Insights and provide granularity, depth of knowledge and analysis.
In order to purchase the following products you will need to have purchased Content Insights:
Viewer Insights Pay Per View Viewer Ascription Ads and Promos Source Code Access UX
Additionally by purchasing Ads and Promos you may then buy Promo Booster to better understand the effectiveness of on-air promotions.
The following can be bought as standalone products or with the other products:
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
3
Multiscreen Quality DVB/IPTV Quality
1.2. Insight Cubes – Reporting and AnalysisA default Ad-Hoc Reporting Tool is included for use with the cubes that makes it easy for users to create reports and drill down to detail based on each cube. Reports can be exported in the most popular file formats and integrated into third party reporting tools as part of an integrated business intelligence solution.
1.3. CustomisationsThis Insight Product Specification describes the “out of the box” product. Customisations to meet specific customer requirements are typically made at the point of deploying the Insight products. Typical customisations include:
Inclusion of additional fields in the cubes for segmentation. Up to five generic attributes are available for channels, subscribers, devices, and programmes
Custom reports for distribution by email on a regular basis Custom cubes when the Source Code Access product is purchased Setup of data exports to 3rd party tools.
1.4. Source code accessAs an additional option, customers can purchase source code access which allows development of their own custom fork of the product. This provides extensive options for customisation including:
Additional dimensions and measures that are not included in the standard product
Additional cubes for custom analysis including SSO reporting, hardware measures and suchlike
Additional data mining activities, e.g. credit scoring model and inclusion of the output of the data mining in the cubes
Custom dashboards and reports
1.5. UX InsightsUX Insights is a bespoke product that integrates clickstream information with other data sources within the Insight platform to provide ad-hoc analysis on how people are using the TV platform to better inform product developments.
Typical applications include:
Identifying the most commonly used keys on the remote control and how they are used
Setting-up and analysing conversion funnels for PPV and other services Measuring the impact of new user interfaces (and A/B splits) on viewing
habits
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
4
1.6. Viewer AscriptionViewer ascription is a bespoke method of turning insight about viewing at a set-top box or household level into insight about viewing at an individual level. This greatly increases the overall value of the data.
Return path data captures the viewing of a subscriber. We have then created a statistical model that allows us to interpret the viewing behaviour of each individual household member.
The model uses account, CRM and other operator data to define the make-up of every household whose viewing is being measured. This is then fused with survey and other viewing data to accurately ascribe viewing of a programme to a specific household member. Key benefits include:
Segment viewers as individuals rather than whole households Benchmark against other industry measures Greater depth of understanding about viewers
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
5
2. Content Insights
2.1. Key benefits Identify viewing of channels and programmes by different segment of the
subscriber base: top 10s, most watched etc Optimise channel packaging to minimise costs and increase propensity to
upsell Provide detailed consumption information on channels to channel providers to
reduce carriage fees - includes household demographics, PVR usage Identify the strongest viewing preferences of the subscriber base and
leverage this for marketing campaigns, content commissioning and acquisition
Identify key viewing behaviours that drive loyalty and build marketing campaigns around these areas
Improve channel performance by scheduling according to best performing times for different geographies and demographics and flows to-and-from other channels
Quickly identify under-performing programmes and channels and act accordingly
Identify the most important unique platform content, and measure performance across all platforms
Measure the impact of marketing campaigns on subscriber viewing and consumption
2.2. Channel dashboard Compare Rating, 3 minute reach, Average timeshift, Average subscriber
viewing time and share of viewing time across up to 4 channels and channel variants
See the device types subscribers are using to consume the content Understand when subscribers are viewing the content Investigate when subscribers use trickplay View the demographics of subscribers consuming each channel
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
6
2.2.1. Channel dashboard screenshot
2.3. Programme dashboardThe Programme Dashboard enables the user to view detailed consumption data for a specific programme and compare it to other programmes
View peak rating and 3 minute reach across programmes, seasons and episodes
Identify the most popular broadcast instances or on demand episodes Compare subscribers that view on different channels See which device types people view the programme on View demographic information for subscribers that watch each season,
episode or instance or who watch on a particular channel View minute by minute audience build or drop off of individual episodes or
instances View minute by minute consumption playback speed through individual
episodes or instances
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
7
2.3.1. Programme dashboard screenshot
2.4. Content Insights dashboard dimensionsDimension Channel Programm
eAir Date x xAir Time x xChannel Audio Stream Language
x x
Channel Information x xConsumption Date xConsumption Method x xDevice Type x xPlayback Speed x xProgramme xSubscriber Age Group x xSubscriber Ethnicity x xSubscriber Gender x xSubscriber Home Location x xSubscriber Income Group x xTimeshift Band x x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
8
2.5. Content Insights dashboard measuresMeasure Channel Programm
e3 Minute Reach x xAverage (viewing) Subscriber Viewing Time
x
Average Timeshift xDownload Reach xPeak Rating xRating ($) xRecording Reach xShare of Viewing Time xTotal Viewing Time x x
2.6. Cubes
2.6.1. Channel cubeThe channel cube is used to show industry standard Share percentage and Rating percentage at a Channel level, allowing you to compare Channels like for like.
2.6.2. Linear Programme cubeThe linear programme cube is used to explore data on subscribers’ viewing of programmes that are associated with a linear channel. Only viewing at the normal playback speed (x 1 forwards) is included.
2.6.3. Programme cubeThe programme cube is used to explore data on subscribers’ viewing of programmes including both linear and on demand. Only viewing at the normal playback speed (x 1 forwards) is included.
2.6.4. Content Insights cube dimensionsDimension Channel Linear
ProgrammeProgramme
Air Date xAir Day of Week xAir Time xChannel Audio Stream Language
x
Channel Information xConsumption Date x xConsumption Day of Week x xConsumption Method x xConsumption Time x xContent Start Air Date xContent Start Air Time xDevice Type x xGeneric Subscriber Attribute x x xGeographical Location x xProgramme x xProgramme Country of Origin x x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
9
Dimension Channel Linear Programme
Programme
Programme Genre x xProgramme Primary Language x xSubscriber Age Group x x xSubscriber Ethnicity x x xSubscriber Gender x x xSubscriber Home Location x x xSubscriber Income Group x x xSubscriber Information xTimeshift Band x x
2.6.5. Content Insights cube measuresMeasure Channel Linear
ProgrammeProgramme
Average (viewing) Subscriber Viewing Time
x x x
Average Timeshift x x xRating xRating (%) xShare of Viewing Time xSuccessful Session Count x x xTotal Viewing Time x x x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
10
3. Viewer Insights
3.1. Key benefitsViewer Insights builds on the dimensions and measures available in Content Insights to allow a detailed view at a subscriber level.
Target individual subscribers based on their viewing patterns and preferences Integrate personal viewing summaries into call centres to improve the
customer experience Leverage clusters of programmes and channels that frequently perform well
together for packaging and upselling Understand the viewing habits of subscribers who take-up new services, PVR,
HD, VOD and OTT and optimise marketing and content accordingly
Viewer Insights adds the Subscriber Information dimension to the Content Insights Product and other Insights products purchased enabling individual subscribers to be targeted for marketing and retention purposes.
3.2. Cubes
3.2.1. Viewer Insights cubeThe Viewer Insights cube is used to explore data at a subscriber level including most preferred channels, programmes and genres as well as clusters of channels and programmes.
3.2.2. Viewer Insights cube dimensionsDimension Viewer
InsightsSubscriber Average Daily Viewing Time Band
x
Subscriber Information x
3.2.3. Viewer Insights cube measuresMeasure
Viewer Insights
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
11
4. Pay Per View
4.1. Key benefits Understand subscriber's purchasing habits based on day of week and time. Identify the most purchased programmes and programme genres. Understand the cost profile of the most purchased programmes. Explore which programmes generate the most revenue.
4.2. Cubes
4.2.1. PPV Purchasing cubeThe PPV purchasing cube is used to explore data on subscriber’s PPV purchasing behaviour.
4.2.2. Pay Per View cube dimensionsDimension PPV
PurchasingGeneric Subscriber Attribute xLaunch to Purchase Band xPurchase Asset Count Band xPurchase Content Duration Band xPurchase Date xPurchase Day of Week xPurchase Expiry xPurchase Genre xPurchase Name xPurchase Price Band xPurchase Time xPurchase Type xSubscriber Age Group xSubscriber Average Monthly PPV Purchase Count Band
x
Subscriber Average Monthly PPV Revenue Band xSubscriber Ethnicity xSubscriber Gender xSubscriber Home Location xSubscriber Income Group x
4.2.3. Pay Per View cube measuresMeasure PPV
PurchasingAverage Number of Purchases per Purchaser
x
Average Purchase Price xAverage Revenue per Purchaser xCount of Assets Purchased xCount of Purchases xTotal Revenue xUnique Purchaser Count x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
12
5. Ads and Promos
5.1. Key benefits Individual reach and frequency measures for each ad slot and campaign
according to demographic measures Improve ad sales revenue based on actual audiences Measure the impact of PVR and VOD on ad viewing Identify key viewing characteristics of a third party database, e.g. purchasers
of a particular brand View second by second viewing data of advertisements.
5.2. Ad and Promo Campaigns dashboardThe Ad and Promo Campaigns dashboard enables the user to see in detail how an ad campaign and the individual copylines within it have performed.
Reach and frequency data for ad campaigns by copyline and broadcast instance together with demographics for those subscribers including home location
See what device types subscribers are using when consuming ads Second by second graph showing count of subscribers and playback speed
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
13
5.2.1. Ad and Promo Campaigns dashboard screenshot
5.3. Ads and Promos dashboard dimensionsDimension Ad and Promo CampaignsAdvertisements and Promotions
x
Air Date xAir Time xChannel Information xConsumption Method xDevice Type xProgramme xSubscriber Age Group xSubscriber Ethnicity xSubscriber Gender xSubscriber Home Location xSubscriber Income Group xTimeshift Band x
5.4. Ads and Promos dashboard measuresMeasure Ad and Promo CampaignsFrequency ($) xGRP ($) x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
14
Measure Ad and Promo CampaignsReach xTotal Viewing Time
x
5.5. Cubes
5.5.1. Ads and Promos Slots cubeThe Ads and Promos slots cube is used to explore data on subscribers linear channel advertisement viewing at the normal playback speed (x 1 forwards).
5.5.2. Ads and Promos cube dimensionsDimension Ads and Promos
SlotsAdvertisements and Promotions
x
Air Date xAir Day of Week xAir Time xChannel Information xCommercial Spot Cost Band xCommercial Spot Number xConsumption Date xConsumption Day of Week xConsumption Method xConsumption Time xContent Start Air Date xContent Start Air Time xDevice Type xGeneric Subscriber Attribute xProgramme xProgramme Genre xSubscriber Age Group xSubscriber Ethnicity xSubscriber Gender xSubscriber Home Location xSubscriber Income Group xTimeshift Band x
5.5.3. Ads and Promos cube measuresMeasure Ads and Promos
SlotsAverage (viewing) Subscriber Viewing Time
x
Frequency ($) xReach x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
15
6. Promo Booster
6.1. Key benefits Compare viewers of individual promotions with those of promoted content Identify best performing slots, copy, and programmes to place promos in Identify success of promoted VOD, OTT, and linear TV services
6.2. Promo Conversion dashboardThe Promo Conversion dashboard enables the user to select the promotion campaign and promoted programme of interest and see how the promotions are performing in terms of conversion rates.
The Promo Conversion dashboard supports:
Reach and frequency of promotion viewing at campaign, copyline and broadcast instance level
Conversion rate - how many subscribers who watched a promotion went on to watch the programme
Cross channel conversions Compare demographics of subscribers who viewed the promotion to those
who viewed the programme Compare the device types in use for viewing the promotion compared to
those used for viewing the programme
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
16
6.2.1. Promo Conversion dashboard screenshot
6.3. Promo Booster dashboard dimensionsDimension Promo
ConversionAdvertisements and Promotions
x
Air Date xAir Time xChannel Information xContent Start Air Date xContent Start Air Time xDevice Type xProgramme xPromotion Viewing Band xSubscriber Age Group xSubscriber Ethnicity xSubscriber Gender xSubscriber Home Location xSubscriber Income Group x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
17
6.4. Promo Booster dashboard measuresMeasure Promo
Conversion3 Minute Reach xFrequency ($) xReach xSubscriber Conversion Rate
x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
18
7. Multiscreen Quality
7.1. Key benefits End to end performance monitoring from mobile devices, tablets and PCs Identify households, devices, channels, VOD assets, and network segments in
error in real time View detailed information on devices, including the OS, browser in use, device
ID etc. Bring real-time data into the network operations centre to provide immediate
corrective actions Analyse trends in quality to identify problematic devices, networks, and third
party suppliers
The Multiscreen Quality monitoring product consists of Insights elements and MiriMON elements.
7.2. Realtime Multiscreen Quality dashboardProvides realtime reporting of quality of service and consumption information for use in network operations centres and by support staff
The realtime dashboard supports:
Top content viewed in realtime Content that has recently suffered from high error rates Most active current bit rates Buffering ratios and video start-up times
7.2.1. Realtime Multiscreen Quality dashboard screenshot
7.3. Multiscreen Quality dashboard dimensionsDimension Realtime Multiscreen
QualityPlayer Bitrate
x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
19
7.4. Multiscreen Quality dashboard measuresMeasure Realtime Multiscreen
QualityAverage Player AV Error Ratio xAverage Player Buffering Event Rate
x
Average Session Startup Time xReach x
7.5. Cubes
7.5.1. Linear Multiscreen QoE cubeThe linear multiscreen QoE cube is used to explore data on the quality of experience subscriber’s have when viewing linear content at the normal playback speed (x 1 forwards).
7.5.2. On Demand Multiscreen QoE cubeThe on demand multiscreen QoE cube is used to explore data on the quality of experience subscriber’s have when viewing on demand content at the normal playback speed (x 1 forwards).
7.5.3. Multiscreen Quality cube dimensionsDimension Linear Multiscreen
QoEOn Demand Multiscreen QoE
Air Date xAir Time xAutonomous System Number
x x
Browser x xChannel Information x xConsumption Date x xConsumption Method x xConsumption Time x xContent Delivery Network x xDevice Connection Type x xDevice Information x xDevice Model x xDevice Type x xGeographical Location x xInternet Service Provider x xPlayer Bitrate x xProgramme xSession AV Error Ratio Band
x x
Session Buffering Ratio Band
x x
Session Startup Result x xSession Startup Time Band x xSubscriber Information x xTimeshift Band x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
20
7.5.4. Multiscreen Quality cube measuresMeasure Linear Multiscreen
QoEOn Demand Multiscreen QoE
All Attempted Session Count
x x
Average Player AV Error Ratio
x x
Average Player Bitrate x xAverage Player Buffering Ratio
x x
Average Session Startup Time
x x
Successful Session Count x xTotal Viewing Time x xUnique Device Count x x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
21
8. DVB/IPTV Quality
8.1. Key benefits End to end performance monitoring from STBs Identify households, devices, channels, VOD assets, and network segments in
error in real time View detailed information on devices, including device ID Bring real-time data into the network operations centre to provide immediate
corrective actions Analyse trends in quality to identify problematic devices, networks, and third
party suppliers Full compliance with TR-160 and complimentary to TR-069 and TR-135
through an additional TR160 report pack.
The DVB/IPTV Quality monitoring product consists of Insights elements and MiriMON elements.
8.2. Realtime DVB/IPTV dashboardProvides realtime reporting of quality of service and consumption information for use in network operations centres and by support staff
The realtime dashboard supports:
Top content viewed in realtime Content that has recently suffered from high error rates Most active current bit rates Buffering ratios and video start-up times
8.2.1. Realtime DVB/IPTV dashboard screenshot
8.3. DVB/IPTV Quality dashboard dimensionsDimension Realtime
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
22
DVB/IPTVPlayer Bitrate
x
VOD Asset x
8.4. DVB/IPTV Quality dashboard measuresMeasure Realtime
DVB/IPTVAverage Player AV Error Ratio xAverage Player Buffering Event Rate
x
Average Session Startup Time x
8.5. Cubes
8.5.1. Linear DVB/IPTV Quality cubeThe DVB/IPTV cube is used to explore data on the quality of experience subscriber’s have when viewing content at the normal playback speed (x 1 forwards) on STBs.
8.5.2. On Demand DVB/IPTV Quality cubeThe on demand DVB/IPTV cube is used to explore data on the quality of experience subscriber’s have when viewing on demand content at the normal playback speed (x 1 forwards).
8.5.3. DVB/IPTV Quality cube dimensionsDimension Linear DVB/IPTV
QualityOn Demand DVB/IPTV Quality
Air Date xAir Time xAutonomous System Number
x x
Channel Information x xConsumption Date x xConsumption Method x xConsumption Time x xContent Delivery Network x xDevice Connection Type x xDevice Information x xDevice Model x xDevice Type x xGeographical Location x xInternet Service Provider x xPlayer Bitrate x xSession AV Error Ratio Band
x x
Session Buffering Ratio Band
x x
Session Startup Result x xSession Startup Time Band
x x
Subscriber Age Group x x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
23
Dimension Linear DVB/IPTV Quality
On Demand DVB/IPTV Quality
Subscriber Information x xTimeshift Band xVOD Asset x x
8.5.4. DVB/IPTV Quality cube measuresMeasure Linear DVB/IPTV
QualityOn Demand DVB/IPTV Quality
All Attempted Session Count x xAverage (viewing) Subscriber Viewing Time
x x
Average Player AV Error Ratio x xAverage Player Bitrate x xAverage Player Buffering Ratio x xAverage Session Startup Time x xSuccessful Session Count x xTotal Viewing Time x xUnique Device Count x x
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
24
9. Key concepts
9.1. Broadcast InstanceThe term "broadcast instance" is used to mean the specific instance of a programme that was broadcast at a specific time/channel.
For example "The Lord of the Rings" is an example of a programme. The "The Lord of the Rings" shown at 21:00 on Sky Movies 1 is an example of a broadcast instance of the programme.
9.2. ClustersThe purpose of clustering is to identify groups of items (channels, programmes or topics) that are often viewed by the same subscribers. For example clustering analysis is performed on channels to identify those groups of channels that a subscriber is likely to watch.
Cluster analysis is performed on the previous complete calendar month of data. It is not possible to compare clusters historically but it is possible to compare consumption against the clusters historically.
The clustering algorithm in use identifies the most closely related items and creates a new cluster that includes those elements. This process is continued until the desired number of clusters is achieved.
Each item is only present in 1 cluster.
These clusters are then made available as a dimension, for further slicing and dicing of the data.
Note that any channel with no viewing in the previous calendar month will appear in the cluster "Unknown".
9.3. PreferencesA subscriber is defined to have a preference if they watch a significant amount of a particular type of content.
It is very valuable to identify that a subscriber has a preference for a specific type of content. This is something that they watch it significantly more than the average household over an extended period of time, for example a household that watches a lot of football is a football household. If they mostly watch football when a certain team is playing, we can identify them as a fan of that team.
Preference is a strong metric: households may not watch a substantial proportion of their viewing on pay channels, but if they have preference to content that is only available on pay TV channels then they are unlikely to churn.
A subscriber’s preference for content (programme, channel, cluster etc) is calculated at the end of each calendar month based upon the previous 12
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
25
months of data. A subscriber’s preference is determined based upon two factors:
Subscriber’s absolute preference - the proportion of the subscriber’s total viewing time of the selected content compared to the whole audience’s average total viewing time of the content. I.e. How much of this content the subscriber watches compared to the average subscriber.
Subscriber’s relative preference – the % of the subscriber’s total viewing time that was spent watching the selected content.
These two factors are combined using an algorithm to calculate a subscriber’s preference for the selected content.
9.4. Privacy and Data Security ConsiderationsGenius Digital has strict policies on privacy and data security of customer data. Where Genius Digital’s products are cloud hosted we do not recommend the transfer of sensitive personal information such as subscriber names and addresses to the cloud.
Instead, personal data should be tokenised (ideally before delivery to Genius Digital) using anonymous external identifiers in place of the personal data that can be used by an operator’s other systems to locate the personal data securely should it be required.
9.5. PurchasablesA PPV Purchase may consist of a single programme or asset or a collection of programmes/assets. This is referred to as a Purchasable. As Purchasables may have different costs over time, it is at purchase time that the cost paid is recorded.
9.6. Reporting dayThe standard reporting day is from 00:01 to 24:00. It is possible to customise the product to change the start/end time of the reporting day.
9.7. SessionA session is a period of uninterrupted viewing of a channel or asset.
9.8. Session trimming and truncationIf a viewer is rapidly switching channels, spending a few seconds on each, a large number of sessions would be recorded. However, as the viewer has not watched these channels for a significant amount of time, reporting these sessions may be considered to be “noise”.
Likewise if a device has been left on consuming content for a number of hours with no user interaction then it can be assumed that there are no viewers watching the content.
Hence, there is the concept of session trimming and truncation:
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
26
Very short sessions - session trimming removes sessions that are shorter than a certain period. The period is configurable as part of a bespoke Insight installation. Trimming is only used within Content Insights.
Very long sessions – long sessions are truncated to a configurable length (for example 2.5 hours session length or 45 minutes after the last user interaction). Truncation is applied to all content.
Trimming and truncation are done at a session level and is applied on a cube by cube basis.
The thresholds for session trimming are configurable (globally) as part of a bespoke installation
When session trimming is applied, the original data is not deleted, so it is possible to change the thresholds for session trimming retrospectively for tuning purposes; processing time must be allowed for retrospective changes.
9.9. TopicsTopics are used to identify when subscribers view content of a type that the customer is particularly interested in. Typically the customer provides a list of topics to Genius Digital which may contain content with particular actors in, or particular sports teams or whatever is most interesting. It is assumed that the keyword or topic can be identified in the schedule data.
Consumption of these topics can then be identified and used to analyse the data and segment the subscriber base.
9.10. Trick playTrick play refers to the use of fast forward, rewind and pause.
All of the viewing measures are based upon playback at normal speed. In the dashboards at the programme or channel level the user can see how much of the total consumption was at playback speeds other than normal speed. This enables the user to get an overview at a programme or channel level of how much time is spent fast forwarding content, e.g. fast forwarding through advertisements.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
27
10. Non-functional requirements
10.1. External Database ViewsSupport for exporting data from the Insight Products into other systems is provided through use of the Insight SQL API.
A set of “read only” views of all dimensions and facts that are used in the Insight products is available via a SQL API. Depending upon the scheduling and size of the exports required there are optional performance enhancements available.
10.2. Language SupportThe Insights products are provided in the English language by default. Support for other languages is available as a customisation.
10.3. Performance and data retentionThe Insight Product performance will be optimised for the customer’s needs as part of a bespoke Insight installation.
Typically a number of versions of each cube are provided each populated with data over a different period, for example:
The last week The last month The last 6 months To date (up to 2 years)
This maximises performance for analysis of the more recent data whilst ensuring that the longer term data is available for up to 2 years.
10.4. Supported BrowsersThe Insight products support the following browser versions:
Chrome Version 29+ Firefox Version 24+ SafariVersion 6+ Internet Explorer 9+
10.5. Third Party Data Ingest PerformanceThird party data for ingest into the Insights Platform is usually delivered via a batch process to a predefined location. The recommended frequency of the batch delivery is every 1 hour but delivery frequencies of 15 minutes to 24 hours are supported.
The time taken for the Insights Platform to extract, transform and load (ETL) the third party data is typically half the batch delivery period. The worst case time to ETL all the data from batches over any given 24 hour period is 24 hours. The worst case time to ETL the data for any individual batch delivery is 4 times the batch period.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
28
11. Dimensions
11.1. Advertisements and PromotionsThe Advertisements and Promotions dimension shows the hierarchy of advertisement and promotion information.
Label Description Possible values(all advertisements)Advert or Promo?
The "Advert or Promo?" dimension is used to select Advertisements or Promotions if you're only interested in one of them.
Advertisement Promotion
Advertiser The name of the advertiser. From imported data.Not applicable (for Promotions).
Brand The name of the brand represented in the advertisement
From imported dataNot applicable (for Promotions).
Product The name of the product represented in the advertisement
From Imported DataNot applicable (for Promotions).
Campaign The name of the advertising campaign or promotion campaign that the advertisement or promotion belongs to.
From imported data.
Copyline The name of the advertisement. From imported data
11.2. Air DateThe Air Date dimensions are grouped together for ease of use, in this case referring to when the content was aired. It represents viewing of content that was aired during this date.
For example, a programme that was aired from Thursday 22nd March at 2300 to Friday 23rd March at 0030 would be represented on both 22nd and 23rd March. If a subscriber had watched all of the programme then 60 minutes viewing would be shown on the 22nd and 30 minutes on the 23rd.
Note that when using cubes and where a programme crosses an hour or day boundary the show start date/time can be used so that all viewing of the programme is included in a single row.
Label Description Possible values(all air dates)Air Year The year in which the
content was broadcast.From imported data, e.g. 2014.
Air The quarter in which the From imported data.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
29
Label Description Possible valuesQuarter content was broadcast.Air Month The month in which the
content was broadcast.From imported data.
Air Day The day in which the content was broadcast.
From imported data. Number from 1 - 31 to represent the day of the month.
11.3. Air Day of WeekThe Air Day of Week represents during which day of the week the content was aired. For example, content that was aired from Thursday at 2300 to Friday at 0030 would be represented on both Thursday and Friday.
Note that when using cubes and where a programme crosses a day boundary the show start date/time should be used so that all viewing of the programme is included in a single row.
Label Description Possible values(all air days of week)
From imported data.
Aired Day of Week
The Air Day of Week represents during which day of the week the content was aired.
For example content that was aired from Thursday at 2300 to Friday at 0030 would be represented on both Thursday and Friday.
Monday Tuesday Wednesday Thursday Friday Saturday Sunday
11.4. Air TimeThe Air Time represents when the content was aired. It represents viewing of content that was aired during this period. Content that was aired from 1145 to 1215 would be represented in both the 1100 hour and the 1200 hour.
Aired minute is also available in some dashboards. Aired second is available in the Ad and Promo Campaign dashboard.
Note that when using cubes and where a programme crosses an hour or day boundary the show start date/time can be used so that all viewing of the programme is included in a single row.
Label Description Possible values
(all air times)
From imported data.
Aired Hour
The Aired Hour represents the hour in which the content was aired. It represents viewing of content that was aired during this hour. For example content that was aired from 1145 to 1215 would be represented in both the 1100 hour and the 1200 hour.
From imported data.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
30
11.5. Autonomous System NumberThe Autonomous System Number dimension shows the ASN of the Autonomous System that the device was connected to at the start of the session or login period.
Label Description Possible values
(all ASN’s)Autonomous System Number
The Autonomous System Number dimension shows the ASN of the Autonomous System that the device is connected to.
From imported data.
11.6. BrowserThis dimension represents the browser that was in use at the start of the session or login period.
Label Description Possible values(all browsers)Browser This dimension represents the browser
that was in use for the session.From imported data. e.g. Safari, Chrome.
11.7. Channel Audio Stream LanguageThe Channel Audio Stream Language represents the audio stream language that the subscriber has selected to watch the channel in.
Label Description Possible values
(all channel audio languages)Channel Audio Language
The channel audio language represents the audio stream language that the subscriber has selected to watch the channel in.
From import data
11.8. Channel InformationThe Channel Information dimension group consists of a collection of Channel related dimensions.
A channel is typically a linear content service available to subscribers.
Label Description Possible values(all channel information)Channel is Exclusive?
The Exclusive Channel dimension represents whether the channel is exclusive or not.
Exclusive Channel
Channel Not Exclusive
UnknownFree/Paid for Channel
Free Channel
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
31
Label Description Possible values Paid
Channel Unknown
Channel The Channel dimension supports the Channel name. Some channels are available on multiple channel numbers, channels with identical names are represented as a single channel in the Channel dimension.
From imported data, e.g. Sky1
Channel Variant
For channels which are available on multiple channel numbers, the different channel ID variants can be distinguished by using the Channel Variant dimension.
For example the variant can be used to distinguish between HD and SD variants of the same channel.
From imported data
Channel Number
The local channel number. From imported data
11.9. Commercial Spot Cost BandThe Commercial Spot Cost dimension represents the cost of the ad spot in bands.
Commercial Spot Cost Band is not available in cubes
Label Description Possible values
(all commercial spot costs)Commercial Spot Cost Band
The Commercial Spot Cost dimension represents the cost of the ad spot in bands.
The bands are configurable as part of a custom Insight installation.
Unknown Bands 1 -
30
11.10. Commercial Spot NumberThe Commercial Spot Number represents the spot number of the advertisement or promotion within the commercial break.
Label Description Possible values(all commercial spot numbers)Commercial Spot Number
The Commercial Spot Number represents the spot number of the advertisement or promotion within the commercial break.
Unknown Commercial spot
number from imported data
11.11. Consumption DateThe consumption date refers to during which date the content was consumed. If content was consumed from 2300 on 22nd April until 0005 on 23rd April, it would be represented on both 22nd and 23rd April.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
32
Label Description Possible values(all consumption dates)Consumption Year The year in which the content was
consumed.From imported data
Consumption Quarter
The quarter in which the content was consumed.
From imported data
Consumption Month The month in which the content was consumed.
From imported data
Consumption Day The day in which the content was consumed.
From imported data
11.12. Consumption Day of WeekThe consumption day of week represents during which day of the week the content was consumed on.
For example if content was consumed from 2300 on Thursday until 0005 on Friday, it would be represented on both Thursday and Friday.
Label Description Possible values
(all consumption days of week)Consumption Day of Week
The consumption day of week represents during which day of the week the content was consumed on.
For example if content was consumed from 2300 on Thursday until 0005 on Friday, it would be represented on both Thursday and Friday.
Monday Tuesday Wednesday Thursday Friday Saturday Sunday
11.13. Consumption MethodThe consumption method is typically used to separate different ways of consuming content or different sources of the content. What the field represents and the options available are agreed on a per customer basis.
Label Description Possible values
(all consumption methods)Consumption Method
The consumption method is typically used to separate different ways of consuming content or different sources of the content. What the field represents and the options available are agreed on a per customer basis.
From imported data
11.14. Consumption TimeThe consumption time represents when the content was consumed.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
33
Label Description Possible values
(all consumption times)Consumption Hour
The consumption time represents the hour during which the content was consumed. For example if content was consumed from 1035 until 1105, it would be represented in both the 1000 hour and the 1100 hour.
From imported data
11.15. Content Delivery NetworkThe Content Delivery Network (CDN) dimension shows the CDN that the device was using at the start of the session or login period to access the content.
Label Description Possible values
(all content delivery networks)Content Delivery Network
The Content Delivery Network (CDN) dimension shows the CDN that the device has used to access the relevant content.
From imported data.
11.16. Content Start Air DateThe content start air date is used to show viewing of content whose scheduled broadcast time started on that date.
The content start air date and time are very useful in the cubes as they can be used to show all viewing for individual broadcast instances of programmes, ads or promos on a single row rather than being split over hour or day boundaries.
Label Description Possible values
(all content start air dates)Content Start Air Year
The year in which the content was scheduled to start.
From import data.
Content Start Air Quarter
The quarter in which the content was scheduled to start.
From import data.
Content Start Air Month
The month in which the content was scheduled to start.
From import data.
Content Start Air Day
The day in which the content was scheduled to start.
From import data.
11.17. Content Start Air TimeThe Content Start Air Time is used to show viewing of content whose scheduled broadcast time started at that time.
The content start air date and time are very useful in the cubes as they can be used to show all viewing for individual broadcast instances of programmes, ads or promos on a single row rather than being split over hour or day boundaries.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
34
It is recommended that Content Start Air Time is not used as a filter.
Label Description Possible values
(all content start air times)Content Start Air Time
The time at which the content was scheduled to start, this is displayed to minute accuracy.
From import data.
11.18. Device Connection TypeThe connection type that the device is using to access the service, for example HSPA, WiFi etc
Label Description Possible values(all device connection types)Device Connection Type
The connection type that the device is using to access the service, for example HSPA, WiFi etc
From imported data, for example HSPA, WiFi, 4G etc
11.19. Device InformationDetails of the OS and ID of the device used to consume content.
Label Description Possible values(all device information)Device OS The Device OS shows the operating
system (OS) of the device used to access the content.
From imported data, for example, iOS 6
Device ID The ID of the device. For example the mac address or other unique identifier.
From imported data
11.20. Device ModelThe Device Model dimension represents the attributes of the device model.
Label Description Possible values(all models)Manufacturer The manufacturer name of the
device used to access the content.
From imported data, for example Apple, Samsung, Amino
Model The model name of the device used to access the content.
From imported data., for example iPhone4, Galaxy S5
Firmware Version
The Firmware Version in use on the device used to access the content.
From imported data
11.21. Device TypeThe Device Type dimension represents the device type for example: Smart Phone, Tablet, PC, and STB
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
35
Label Description Possible values
(all device types)Device Type
The Device Type dimension represents the device type for example: Smart Phone, Tablet, PC, and STB
From imported data
11.22. Generic Subscriber AttributeThere are a number of generic subscriber attribute dimensions that are available for customisation purposes to enable custom segmentation of the subscriber base.
The generic subscriber dimensions can be loaded and named as part of a custom Insight installation or at any time once the system has been deployed.
11.23. Geographical LocationThe geographical location dimension shows the location of the device at the beginning of the session or login period.
Label Description Possible values
(all session locations)Country The country where the device was located at
the beginning of the session.From imported data
State The state where the device was located at the beginning of the session.
From imported data
City The city where the device was located at the beginning of the session.
From imported data
11.24. Internet Service ProviderThe Internet Service Provider (ISP) dimension shows the name of the ISP that was providing the viewing device’s internet connection at the start of the session or login period.
Label Description Possible values
(all internet service providers)Internet Service Provider
The Internet Service Provider (ISP) dimension shows the name of the ISP that is providing the viewing device’s internet connection.
From imported data
11.25. Launch to Purchase BandThe Launch to Purchase Band dimension is used for PPV content to represent the time between the launch and purchase of the product.
Label Description Possible values(all launch to purchase
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
36
Label Description Possible valuesbands)Launch to Purchase Band
The Launch to Purchase Band dimension is used for PPV content to represent the time between the launch and purchase of the product.
There are 20 bands available by default. Each band represents a period of time from launch to purchase and is configurable as part of a bespoke Insight installation.
Unknown Launch to
Purchase Bands
11.26. Playback SpeedThe Playback Speed represents the speed at which the content was consumed.
Playback Speed is not available in cubes
Label Description Possible values
(all playback speeds)Playback Speed
The Playback Speed represents the speed at which the content was consumed. 1x speed is the normal playback speed, with 2x being twice the normal speed and 4x being four times normal speed.
A playback speed of x0.5 represents half the normal rate and a negative number represents reverse play.
From imported data.
11.27. Player BitrateThe Player Bitrate dimension represents the player bitrate. The player bitrate can vary during a session where adaptive rate streaming is in use.
Label Description Possible values
(all player bitrates)Player Bitrate
The Player Bitrate dimension represents the player bitrate.
Note that the player bitrate can vary during a session where adaptive rate streaming is in use, so if 4 player bitrates are used in a session and you plot player bitrate versus session count, that session will be represented at 4 player bitrates.
From import data.
11.28. ProgrammeThe programme dimensions are grouped together for convenience and represent the programme that has been consumed.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
37
In the Ad slots cube the programme dimension represents the programme that was being watched when the Advertisement was seen.
Label Description Possible values(all programmes)Programme The title of the
programme or show.From imported data, e.g. "Harry Potter and the Philosopher's Stone"
Season The season number. From imported data, e.g "2" for Season 2
Episode The episode number or episode title.
From imported data, e.g "6" for episode 6.
11.29. Programme Country of OriginThe Programme Country of Origin represents the Programme’s Country of Origin.
Label Description Possible values
(all programme country of origin)Programme Country of Origin
The Programme Country of Origin represents the Programme’s Country of Origin.
From imported data.
11.30. Programme GenreThe Programme Genre dimension represents the genre of the programme. The first genre in the content metadata for the programme is used to populate the genre field in cubes.
Programme Genre is not available in cubes
Label Description Possible values
(all Programme Genres)Programme Genre
The Programme Genre dimension represents the genre of the programme. The first genre in the content metadata for the programme is used to populate the genre field in cubes.
From imported data
11.31. Programme Primary LanguageThe Programme Language represents the primary language of the selected content.
Label Description Possible values
(all programme primary languages)Programme Primary Language
The Programme Primary Language represents the primary language of the selected content.
From imported data
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
38
11.32. Purchase Asset Count BandThe Purchase Asset Count band shows the number of assets or individual programmes that are included in the purchase.
For example a box set may have an “asset count” of 10, meaning that there are 10 episodes included in the purchase.
Label Description Possible values(all purchase asset count bands)Purchase Asset Count Known
The Purchase Asset Count Known dimension represents whether the number of assets included in the purchase is known or not.
Known Unknown Not Applicable
Note "Not Applicable" is used when a subscription bundle has been purchased.
Purchase Asset Count Band
The Purchase Asset Count band shows the number of assets or individual programmes that are included in the purchase.
There are 10 bands in addition to the "unknown" category
Unknown Purchase Asset Count
Bands 1 - 10
11.33. Purchase Content Duration BandThe Purchase Content Duration Band represents the total duration of the content purchased represented in bands.
Label Description Possible values(all purchase content duration bands)Purchase Content Duration Known
The Purchase Asset Content Duration Known dimension represents whether the duration of the content in the purchase is known or not.
Known Unknown Not Applicable
Note "Not Applicable" is used when a subscription bundle has been purchased.
Purchase Content Duration Bands
The Purchase Content Duration Band represents the total duration of the content purchased represented in bands.
There are 10 bands in addition to the "unknown" category
Unknown Purchase Content
Duration Bands 1 - 10
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
39
11.34. Purchase DateThe purchase date dimensions are grouped together for ease of use.
Label Description Possible values(all purchase dates)Purchase Year The year in which the PPV purchase was
made.From imported data
Purchase Quarter
The quarter in which the PPV purchase was made.
From imported data
Purchase Month The month in which the PPV purchase was made.
From imported data
Purchase Day The day in which the PPV purchase was made.
From imported data
11.35. Purchase Day of WeekThe Purchase Day of Week dimension shows which day of the week the content was purchased upon.
Label Description Possible values
(all purchase days of week)Purchase day of week
The Purchase Day of Week dimension shows which day of the week the content was purchased upon. This dimension allows the user to understand PPV purchase across different days of the week to identify patterns.
Monday Tuesday Wednesday Thursday Friday Saturday Sunday
11.36. Purchase ExpiryThe Purchase Expiry dimension is used to show whether the subscriber can still view the purchased content or whether it has now expired.
Label Description Possible values
(all purchase expiry statuses)Purchase Expiry
The Purchase Expiry dimension is used to show whether the subscriber can still view the purchased content or whether it has now expired. This dimension is useful when considering which purchases have not been viewed.
Expired Not
Started Ongoing Unknown
11.37. Purchase GenreThe Purchase Genre dimension is used to show the genre of a purchase.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
40
Label Description Possible values
(all purchase genres)Purchase Genre
The Purchase Genre dimension is used to show the genre of a purchase.
From imported data
11.38. Purchase NameThe Purchase Name dimension shows the name of the PPV content that has been purchased.
Label Description Possible values
(all purchase names)Purchase Name
The Purchase Name dimension shows the name of the PPV content that has been purchased.
Purchases can either be for single assets/broadcast instances of programmes or for a bundle of assets.
From import data.
11.39. Purchase Price BandThe Purchase Price Band dimension represents in bands the purchase price paid when PPV product was purchased.
Label Description Possible values(all purchase price bands)Purchase Price band
The Purchase Price Band dimension represents in bands the purchase price paid when PPV products are purchased.
There are 8 bands available which are configurable as part of a bespoke Insight installation.
Purchase Price Band 1- 8
Unknown
11.40. Purchase TimeThe purchase time is used to show the hour during which a purchase has been made.
Label Description Possible values
(all purchase times)Purchase Hour
The Purchase Hour dimension shows the hour during which a purchase has been made.
From imported data
11.41. Purchase TypeThe Purchase type represents whether the purchased PPV product is transactional VOD or Pay per View linear content.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
41
Label Description Possible values(all purchase types)Purchase Type
The Purchase type represents whether the purchased PPV product is transactional VOD or Pay per View linear content.
From imported data. Unknown tVOD PPV linear
Purchase Sub Type
The Purchase Sub Type is used to separate whether the purchased items are individual assets/episodes or whether they’re bundles.
From import data, for example "Unknown", "Individual", "Bundle".
11.42. Session AV Error Ratio BandThe Session AV Error Ratio Band dimension groups the sessions in bands based upon the Average AV Error Ratio during those sessions.
A device is considered to be in AV error if it’s experiencing AV errors including buffering, dropped frames, corrupt frames or absent audio or video.
Label Description Possible values(all Session AV error ratio bands)Session AV Error Ratio Band
The Session AV Error Ratio Band dimension segments the sessions based upon the AV Error Ratio during those sessions. See the documentation on the "Average AV Error Ratio" measure for more detail on how the ratio is calculated.
This banded dimension has 8 bands available. The bands are configurable as part of a custom Insight deployment.
Session AV Error Ratio Bands 1 - 8
Unknown
11.43. Session Buffering Ratio BandThe Session Buffering Ratio Band dimension groups the sessions in bands based upon the Average Player Buffering Ratio during those sessions.
Label Description Possible values(all session buffering ratio bands)Session Buffering Ratio Band
The Session Buffering Ratio Band dimension groups the sessions in bands based upon the Player Buffering Ratio during those sessions. See the documentation on the "Average Buffering Ratio" measure for further detail on how this is calculated.
There are up to 8 bands which are configurable
Session Buffering Ratio Band 1 - 8
Unknown
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
42
Label Description Possible valuesas part of a bespoke Insight installation in addition to an “Unknown” band.
11.44. Session Startup ResultThe Session Startup Result dimension shows the result of the user’s attempt to start a session (i.e. what happens after a viewer has selected the content and then pressed “play”).
Label Description Possible values
(all session startup results)Start Status The Start status field shows whether the
session startup is considered to have been successful or to have failed.
The mapping of individual startup results to "success" and "failure" can be customised based on the imported data.
Success Failure
Session Startup Result
The Session Startup Result dimension shows the reported session startup result.
From imported data.
11.45. Session Startup Time BandThe Sessions Startup Time Band dimension shows the time for session startup.
Label Description Possible values(all session startup time bands)Session Startup Time Band
The Sessions Startup Time Band dimension shows the time taken for session startup.
The bands can be customised as part of a custom Insight installation.
Less than 1 second
1 - 2 seconds 2 - 3 seconds 3 - 4 seconds 4 - 5 seconds 5 - 6 seconds 6 - 7 seconds 7 - 8 seconds 8 - 9 seconds More than 9
seconds Unknown
11.46. Subscriber Age GroupThe Subscriber Age Group dimension represents the age group of the subscriber.
Label Description Possible values
(all age groups)Subscriber Age The Subscriber Age Group dimension 17 or less
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
43
Label Description Possible values
Group represents the age group of the subscriber.
There are 15 bands available which can be customised.
18 - 20 21 - 24 25 - 29 30 - 34 35 - 39 40 - 44 45 - 49 50 - 54 55 - 59 60 - 64 65 - 69 70 - 74 75 - 79 80+ Unknown
11.47. Subscriber Average Daily Viewing Time BandThe Subscriber Average Daily Viewing Time Band dimension represents in bands the average daily viewing time of a subscriber. It allows the user to segment the subscribers by their Average Daily Viewing Time Band.
Label Description Possible values(all subscriber average daily viewing time bands)Subscriber Average Daily Viewing Time Band
The Subscriber Average Daily Viewing Time Band dimension represents in bands the average daily viewing time of a subscriber.
The bands are configured when the Insight product is installed. Which band a subscriber belongs in is calculated monthly at the end of the month using data from the previous 12 complete months and then updated to the Insight platform.
Where a subscriber has not had a subscription for all of the months in the segmentation period this is compensated for by scaling up their viewing time.
In a new installation of Insight where there are fewer than 12 months of data, data from the complete months to date is used to generate the segments.
If a subscriber has not had an active subscription in the previous 12 months (of
Subscriber Average Daily Viewing Time Band 1 - 10
Unknown
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
44
Label Description Possible valuesdata in the Insight platform) then they will be placed in the “Unknown” band.
11.48. Subscriber Average Monthly PPV Purchase Count Band
This dimension allows the user to segment subscribers by the number of PPV purchases that that subscriber typically makes.
Label Description Possible values(all subscriber average monthly PPV purchase count bands)Subscriber Average Monthly PPV Purchase Count Band
The Subscriber Average Monthly PPV Purchase Count Band dimension represents in bands the average number of PPV purchases a subscriber makes in a month using the last twelve months of data.
Which band a subscriber belongs in is calculated monthly at the end of the month using data from the previous 12 months and updated to the Insight platform monthly. Historical values for Subscriber Average Monthly PPV Band are not retained.
Where a subscriber has not had a subscription for all of the months in the period this is compensated for by scaling up the volume of their PPV purchases.
In a new installation of Insight where there are fewer than 12 months of data, data from the complete months to date is used to generate the segments.
If a subscriber does not have an active subscription at all in the previous 12 months (of data in the Insight platform) then they will be placed in the “no segment” band.
Subscriber Average Monthly PPV Purchase Count Bands 1 - 10
No segment Unknown
11.49. Subscriber Average Monthly PPV Revenue BandThe Subscriber Average Monthly PPV Revenue Band dimension represents in bands the average revenue generated from a subscriber’s PPV purchases in one month.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
45
It allows the user to segment the subscribers by the amount of PPV revenue that that subscriber typically generates.
Label Description Possible values(all subscriber average monthly PPV revenue bands)Subscriber Average Monthly PPV Revenue Band
The Subscriber Average Monthly PPV Revenue Band dimension represents in bands the average revenue generated from a subscriber’s PPV purchases in one month.
The bands are calculated monthly at the end of the month using data from the previous 12 months and updated to the Insight platform monthly.
Where a subscriber has not had a subscription for all of the months in the segmentation period this is compensated for by proportionately scaling up the revenue that that subscriber generates.
In a new installation of Insight where there are fewer than 12 months of data, data from the complete months to date is used to generate the segments.
If a subscriber does not have an active subscription in the previous 12 months (of data in the Insight platform) then they will be placed in the “no segment” band.
Subscriber Average Monthly PPV Revenue Band 1 - 10
Unknown No Segment
11.50. Subscriber EthnicityThe Subscriber Ethnicity represents the ethnicity of the subscriber.
Label Description Possible values(all ethnicities)Ethnicity This dimension represents the ethnicity of the
subscriber.From import data.
11.51. Subscriber GenderSubscriber Gender represents the gender of the subscriber.
Label Description Possible values(all genders)Gender The gender of the From import
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
46
Label Description Possible valuessubscriber. data.
11.52. Subscriber Home LocationThe Subscriber Home Location represents the subscriber's home location.
Label Description Possible values
(all subscriber home locations)Home Country The Home Country dimension shows the
subscriber’s home country.From import data.
Home State The Home State dimension shows the subscriber’s home state.
From import data.
Home City The Home City dimension shows the subscriber’s home city.
From import data.
11.53. Subscriber Income GroupThe Subscriber Income Group dimension represents the subscriber's income represented in bands.
Label Description Possible values
(all income groups)Subscriber Income Group
The Income Group that the Subscriber belongs to. There are 10 bands available which are configurable as part of a custom installation of Insight.
Income group 1 - 10
Unknown
11.54. Subscriber InformationThe Subscriber Information dimension includes information relating to the subscriber.
Label Description Possible values(all Subscriber Information)Subscriber Status
The Subscriber Status dimension is used to segment subscribers based upon whether they have become a new subscriber, remained a subscriber, or stopped being a subscriber in the previous 12 months.
If a subscriber has both joined and churned within the last 12 complete months they are shown in the churned band.
In a new installation of Insight the status over the complete
Joined – a new subscriber who has joined the service within the last 12 complete months.
Ongoing – a subscriber who has maintained their subscription for all of the last 12 complete months.
Churned – a subscriber who has terminated their subscription.
Churned (Involuntary) – a subscriber whose subscription has been terminated by the
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
47
Label Description Possible valuesmonths to date will be used. This status is updated monthly.
operator, for example due to a credit default.
Subscriber ID The Subscriber ID is a globally unique identifier usually provided by the Operator, for example account number. It may be personally identifiable by association with operator account information.
From import data.
Subscriber Username
The Subscriber Username is the username which the subscriber uses to login.
From import data
11.55. Timeshift BandTimeshift represents the time since the content was available as linear content. It typically applies to content consumed from the PVR or sometimes a catch-up service.
The timeshift can vary within a session, for example if the user presses pause in which case each part of the session is represented in the relevant timeshift band.
Label Description Possible values
(all timeshift bands)Timeshift Band
Timeshift represents the time since the content was available as linear content. It typically applies to content consumed via live buffer, PVR or perhaps from a catch-up service if there is available data to link the catch-up content to the original broadcast time and channel.
Each Timeshift Band represents a range of timeshifts. For example if a subscriber watched twenty minutes of a show live and a further 30 minutes with a timeshift of 1 hour 30 minutes then they would be represented in both the live band and the 1 - 4 hour timeshift band.
Timeshift for linear content is the time difference between the broadcast time and the viewing time.
There is no concept of timeshift for VOD. VOD content is put into the “not applicable” segment.
The Timeshift bands are configurable as part of a custom installation of Insight.
No timeshift
>0 – 60 minutes
1 – 4 hours 4 – 24
hours 1 – 3 days 3 – 7 days 1 – 2
weeks 2 – 3
weeks 3 – 4
weeks 4 – 6
weeks 6 – 8
weeks 8 – 12
weeks > 12
weeks. Not
applicable
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
48
11.56. VOD AssetThe VOD Asset dimension represents the VOD asset being consumed.
Label Description Possible values
(all vod assets)VOD Asset The VOD Asset dimension represents the name of
the VOD asset being consumed.From import data
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
49
12. Measures
12.1. 3 Minute Reach3 minute reach is the unique count of subscribers who have had a session viewing the selected content that is at least 3 minutes long.
3 Minute Reach is not available in cubes
12.2. All Attempted Session CountThe All Attempted Session Count measure represents the total number of attempted sessions from the selected dimensions. It includes successful, failed and very short sessions (less than session trimming threshold).
12.3. Average (viewing) Subscriber Viewing TimeAverage Subscriber Viewing Time is the average time that a subscriber who has watched the selected content has watched it for.
12.4. Average Number of Purchases per PurchaserThe average number of purchases made of the selected PPV products per subscriber who purchased a PPV product.
12.5. Average Player AV Error RatioThe Player AV Error Ratio is the average ratio of time spent in AV error compared to the viewing duration for the selected dimensions (including the time spent in AV error).
A device is considered to be in AV error if it’s experiencing AV errors including buffering, dropped frames, corrupt frames or absent audio or video.
12.6. Average Player BitrateThe Average Player Bitrate of the content stream being played.
12.7. Average Player Buffering Event RateThe Average Player Buffering Event Rate represents the average rate at which Buffering Events are experienced in the selected dimensions. It is displayed in Buffering Events per hour. The purpose of this measure is to show how frequently viewing has been disturbed by buffering events. Buffering events received whilst the player is starting up are excluded.
Buffering events can have different durations; if buffering occurs for 100ms, then the buffering event is 100ms long, alternatively a player may be buffering for 15 seconds, in which case the buffering event would be reported as 15 seconds long. This measure reports the frequency of the events not the duration.
12.8. Average Player Buffering RatioThe Average Player Buffering Ratio is the average ratio of time spent in Player Buffering compared to the viewing duration in the selected dimensions (including
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
50
the time spent in Player Buffering). The time spent “buffering” excludes the player startup time.
12.9. Average Purchase PriceThe average price paid for the selected items purchased.
12.10. Average Revenue per PurchaserThe average amount of revenue generated from purchasing of PPV products per subscriber who purchased at least one PPV product.
12.11. Average Session Startup TimeSession Startup time is the time taken to start playback after the viewer has selected the content and pressed “play” averaged across the selected sessions.
Note that failed startups are excluded.
12.12. Average TimeshiftThe Average Timeshift is the average timeshift over the period selected, for the selected content.
Timeshift for catch-up and PVR is the time difference between the broadcast time and the viewing time.
Live content may have a timeshift if live buffer is in use, in which case the timeshift is the difference between the scheduled broadcast time and the viewing time.
There is no concept of timeshift for VOD. VOD content is put into the “not applicable” segment.
12.13. Count of Assets PurchasedThe count of individual assets or episodes purchased.
12.14. Count of PurchasesThe number of PPV purchases in the selected period.
12.15. Download ReachThe Download Reach represents the number of subscribers who downloaded the content.
Download Reach is not available in cubes
12.16. Frequency ($)The frequency is the average number of times a subscriber who has watched the content has watched it, i.e. the number of times that they have been "reached".
For example if one subscriber had watched a particular coca cola advertisement on 5 separate occasions, and a separate subscriber had only watched it once, the frequency would be 3.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
51
Frequency ($) is a ratings standard measure
12.17. GRP ($)The GRP dimension is the product of Reach and Frequency. It represents the total number of times an ad or a campaign of ads have been consumed.
GRP ($) is not available in cubes
GRP ($) is a ratings standard measure
12.18. Peak RatingThe peak rating measure represents the peak Rating achieved on a single broadcast instance of the selected content.
For programmes this rating measure includes time spent viewing advertisements and promotions within the scheduled programme slot.
This measure only includes broadcast instances of programmes.
Peak Rating is not available in cubes
12.19. RatingThe Rating represents the average number of devices viewing the selected content in the selected period on a second by second basis. It is calculated by (total time spent viewing selected content/duration of content).
For programmes this is based on the scheduled programme slot including any advertisement and promotion time within the scheduled programme slot.
Rating is not available in cubes
12.20. Rating ($)The Rating represents the average number of devices viewing the selected content in the selected period on a second by second basis. It is calculated by (total time spent viewing selected content/duration of content).
In this ratings standard measure, the ratings for programmes are based on the actual content duration excluding any advertisement and promotion time within the scheduled programme slot.
Rating ($) is not available in cubes
Rating ($) is a ratings standard measure
12.21. Rating (%)The total viewing time for a target segment for the selected content divided by the total possible viewing time of the target segment.
Rating (%) is not available in cubes
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
52
12.22. ReachReach is the number of unique subscribers who have consumed at least 1 second of the selected content.
12.23. Recording ReachThe Recording Reach represents the number of subscribers who recorded the content. At least 50% of the scheduled programme slot must have been recorded for the recording to count.
Recording Reach is not available in cubes
12.24. Share of Viewing TimeThe Share of Viewing Time is reported as a percentage. It represents the amount of time the target subscriber segment spent viewing the selected channel(s) from the selected period (based upon the air date/time) compared to the time the target subscriber segment spent consuming any channel based content from the same period (of air date/time). If no target subscriber segment is selected then the universe/whole audience is used.
Share of Viewing Time is not available in cubes
12.25. Subscriber Conversion RateThe number of subscribers who watched the promo and went on to watch the content compared to the number of subscribers who watched the promo.
Expressed as a %
Subscriber Conversion Rate is not available in cubes
12.26. Successful Session CountThe count of successful sessions in the selected dimensions. It excludes slow, failed and very short sessions and hence represents the number of sessions in which viewing is considered to have taken place.
12.27. Total RevenueThe revenue generated from the selected dimensions over the selected period.
12.28. Total Viewing TimeThe Total Viewing Time of the selected dimensions in the selected period.
12.29. Unique Device CountThe Unique Device Count represents the number of unique devices that have consumed the selected content (i.e. have had successful sessions).
12.30. Unique Purchaser CountThe number of unique subscribers that have made a purchase of the selected products.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
53
13. Standard data import types
13.1. Adverts dataThe Adverts API is part of the Commercial slots API and loads advertisements
13.1.1. Optional data feedsField Name Type Notesadvertiser_label varchar(255
)The name of the advertiser
agency_label varchar(255)
The name of the agency associated with this advert
brand_label varchar(255)
The brand being advertised
external_ad_programme_ref
varchar(255)
A unique identifier for the programme in which the advert appears, provided through seperate programme schedule provisioning. This ID is also used to identify duplicate ad programmes when the advert is repeated on this or other channels. Omitting this ID will result in all scheduled ads being considered unique, i.e. No repeats will be identified.
language varchar(255)
The language the advert was broadcast in
product_label varchar(255)
The product being advertised
13.1.2. Mandatory data feedsField Name Type Notescampaign_label varchar(255
)The name of the campaign associated with this advert
copyline_label varchar(255)
The copyline for this advert
13.2. Android SDK dataThe MiriMON Android SDK
13.2.1. Optional data feedsField Name Typ
eNotes
application_log_pointcontent_ready_to_playcoredata_completedata_errordata_overrundata_startingdata_underrun
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
54
Field Name Type
Notes
loginlogoutmetadata_durationmetadata_identitymetadata_initialiseplayback_acceleratedplayback_errorplayback_pausedplayback_progressplayback_resumedplayback_seekplayback_stalledplayback_start_requestedplayback_startedplayback_stop_requestedplayer_versionstatistics_bitratestatistics_frame_errors
13.3. CDNs dataThe CDN API loads information on different CDNs in use
13.3.1. Mandatory data feedsField Name Type Notescdn_label varchar(255
)The CDN's label/ name, used to identify the CDN in output from the Insight platform.
external_cdn_ref
varchar(255)
A unique identifier for this content delivery network. This might be the CDN's name. The same identifier must be used when referring to the CDN in all import files.
13.4. Channel and programme playback dataThe Channel and Programme Playback API is used to register the playback of programmes that should also be counted towards channel viewing, for example catch-up TV services that are run on-demand but are associated with linear TV channels.
13.4.1. Optional data feedsField Name Type Notesaverage_bitrate integer Average bitrate of
session, in Mb/schannel_audio_language varchar(255) The
channel_audio_language is the audio stream language that the subscriber has selected to watch the channel
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
55
Field Name Type Notesin
end_cause_string session_end_cause_type
The session's end cause (one of UNKNOWN, UPDOWN, END_OF_ASSET, TERMINATED_BY_USER, TERMINATED_BY_APPS)
external_cdn_ref varchar(255) A unique identifier for the CDN used to deliver this session provided through seperate CDN provisioning.
external_device_connection_type_ref
varchar(255) A unique identifier for the type of connection used to deliver this session provided through seperate device connection type provisioning.
external_external_consumption_method_ref_ref
varchar(255) A reference to the consumption method to be reported for this session
external_geography_ref varchar(255) A unique identifier for the location in which this session started provided through seperate geography provisioning.
external_isp_ref varchar(255) A unique identifier for the ISP used to deliver this session provided through seperate ISP provisioning.
is_service_outage boolean Is this session chunk part of a complete service outage? When omitted is_service_outage will be defaulted to false. For example: The DVB-T signal was lost true : The service has
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
56
Field Name Type Notescompletely failed during this session chunk. false: The service successfully delivered during part or all of this session chunk (some errors may have occured, these are reporting in player_error_count and player_error_seconds)
playback_speed decimal Playback speed as a percentage of normal (real time playback).
player_buffer_count integer Number of times the player paused/skipped while waiting for content to buffer, during this session chunk.
player_buffer_seconds integer Number of seconds during the session chunk that were affected by player buffering.
player_error_count integer Number of player errors during the session chunk (typically resulting from missing or corrupt content)
player_error_seconds integer Number of seconds during the session chunk that were affected by player errors.
service_outage_cause_string varchar(255) The cause of this service outage (only required when is_service_outage=true)
start_audio_abs integer Time from user request to starting audio playback, in ms.
start_av_abs integer Time from user request to starting
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
57
Field Name Type Notesaudio and video playback, in ms.
start_cause_string session_start_cause_type
The session start cause. One of UNKNOWN, INT_AUTO_VIEWING, INT_AUTO_RECORDING, INT_AUTO_STARTUP, INT_AUTO_SERVICE, INT_AUTO_APPLICATION, INT_AUTO_OTHER, INT_AUTO_RETRY, REMOTE_USER_INPUT, REMOTE_USER_UPDOWN, REMOTE_USER_FAVOURITE, REMOTE_USER_CHANNEL, REMOTE_USER_BANNER, REMOTE_USER_GUIDE, REMOTE_USER_OTHER, APP_USER_INPUT, APP_USER_UPDOWN, APP_USER_FAVOURITE, APP_USER_CHANNEL, APP_USER_BANNER, APP_USER_GUIDE, APP_USER_OTHER, PANEL_USER_INPUT, PANEL_USER_UPDOWN, or DEVICE_AUTO_OTHER,
start_offset integer The offset within the catch-up that this session chunk started from, in seconds.
start_overall integer Time from user request to starting
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
58
Field Name Type Notesplayback, in ms.
start_result_string session_start_result_type
The session's start result (one of UNKNOWN, SUCCESS, FAILURE, SLOW, or INTERRUPTED)
start_video_abs integer Time from user request to starting video playback, in ms.
std_tz_offset integer The standard time zone is the timezone that the results will be displayed in.
13.4.2. Mandatory data feedsField Name Type Notesexternal_channel_ref varchar(255
)A unique identifier for a channel provided through separate channel provisioning.
external_device_ref varchar(255)
A unique identifier for a device that the subscriber owns that is provided through separate device provisioning.
external_programme_ref varchar(255)
A unique identifier for a programme provided through separate VOD provisioning.
full_session_id varchar(255)
If available, a unique identifier for the session. If not available, concatenate the device_id with the date and time to produce a unique record.
is_complete boolean When reporting ongoing sessions that have not yet completed, set this flag to false.
is_first_session_chunk boolean Where sessions are grouped into multiple chunks (for example at different speeds) these flags are used to indicate the first and last chunks in a session.
is_last_session_chunk boolean Where sessions are grouped into multiple chunks (for example at different speeds) these flags are used to indicate the first and last chunks in a session.
local_tz_offset integer The timezone offset from UTC to local time that applied when session chunk was consumed.
session_chunk_id varchar(255)
If available, a unique identifier for the session chunk. If not available, concatenate the device_id with the
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
59
Field Name Type Notesdate and time to produce a unique record.
utc_consume_start_epoch
integer Time consumption was started for this session chunk in seconds since the Unix epoch.
utc_consume_stop_epoch integer Time consumption for this session chunk was stopped in seconds since the Unix epoch. If the session chunk is ongoing, then use the last known time the session was still being played. Ongoing session are indicated by setting the 'is_complete' to False in the common_session_chunk element.
13.5. Channel playback dataThe Channel Playback API logs playaback of linear channels, including timeshifted content
13.5.1. Optional data feedsField Name Type Notesaverage_bitrate integer Average bitrate of
session, in Mb/schannel_audio_language varchar(255) The
channel_audio_language is the audio stream language that the subscriber has selected to watch the channel in
end_cause_string session_end_cause_type
The session's end cause (one of UNKNOWN, UPDOWN, END_OF_ASSET, TERMINATED_BY_USER, TERMINATED_BY_APPS)
external_cdn_ref varchar(255) A unique identifier for the CDN used to deliver this session provided through seperate CDN provisioning.
external_device_connection_type_ref
varchar(255) A unique identifier for the type of connection used to deliver this session provided through seperate device
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
60
Field Name Type Notesconnection type provisioning.
external_external_consumption_method_ref_ref
varchar(255) A reference to the consumption method to be reported for this session
external_geography_ref varchar(255) A unique identifier for the location in which this session started provided through seperate geography provisioning.
external_isp_ref varchar(255) A unique identifier for the ISP used to deliver this session provided through seperate ISP provisioning.
is_service_outage boolean Is this session chunk part of a complete service outage? When omitted is_service_outage will be defaulted to false. For example: The DVB-T signal was lost true : The service has completely failed during this session chunk. false: The service successfully delivered during part or all of this session chunk (some errors may have occured, these are reporting in player_error_count and player_error_seconds)
playback_speed decimal Playback speed as a percentage of normal (real time playback).
player_buffer_count integer Number of times the player paused/skipped
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
61
Field Name Type Noteswhile waiting for content to buffer, during this session chunk.
player_buffer_seconds integer Number of seconds during the session chunk that were affected by player buffering.
player_error_count integer Number of player errors during the session chunk (typically resulting from missing or corrupt content)
player_error_seconds integer Number of seconds during the session chunk that were affected by player errors.
service_outage_cause_string varchar(255) The cause of this service outage (only required when is_service_outage=true)
start_audio_abs integer Time from user request to starting audio playback, in ms.
start_av_abs integer Time from user request to starting audio and video playback, in ms.
start_cause_string session_start_cause_type
The session start cause. One of UNKNOWN, INT_AUTO_VIEWING, INT_AUTO_RECORDING, INT_AUTO_STARTUP, INT_AUTO_SERVICE, INT_AUTO_APPLICATION, INT_AUTO_OTHER, INT_AUTO_RETRY, REMOTE_USER_INPUT, REMOTE_USER_UPDOWN, REMOTE_USER_FAVOURITE,
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
62
Field Name Type NotesREMOTE_USER_CHANNEL, REMOTE_USER_BANNER, REMOTE_USER_GUIDE, REMOTE_USER_OTHER, APP_USER_INPUT, APP_USER_UPDOWN, APP_USER_FAVOURITE, APP_USER_CHANNEL, APP_USER_BANNER, APP_USER_GUIDE, APP_USER_OTHER, PANEL_USER_INPUT, PANEL_USER_UPDOWN, or DEVICE_AUTO_OTHER,
start_overall integer Time from user request to starting playback, in ms.
start_result_string session_start_result_type
The session's start result (one of UNKNOWN, SUCCESS, FAILURE, SLOW, or INTERRUPTED)
start_video_abs integer Time from user request to starting video playback, in ms.
std_tz_offset integer The standard time zone is the timezone that the results will be displayed in.
timeshift integer The session chunk's delay between air and consumption time. E.g. some STBs provide the ability to perform in-memory (non-PVR) 'trick play', allowing the user to watch content that is slightly
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
63
Field Name Type Notestimeshifted. Typically timeshift values should be small for live sessions.
13.5.2. Mandatory data feedsField Name Type Notesexternal_channel_ref varchar(255
)A unique identifier for a channel provided through separate channel provisioning.
external_device_ref varchar(255)
A unique identifier for a device that the subscriber owns that is provided through separate device provisioning.
full_session_id varchar(255)
If available, a unique identifier for the session. If not available, concatenate the device_id with the date and time to produce a unique record.
is_complete boolean When reporting ongoing sessions that have not yet completed, set this flag to false.
is_first_session_chunk boolean Where sessions are grouped into multiple chunks (for example at different speeds) these flags are used to indicate the first and last chunks in a session.
is_last_session_chunk boolean Where sessions are grouped into multiple chunks (for example at different speeds) these flags are used to indicate the first and last chunks in a session.
local_tz_offset integer The timezone offset from UTC to local time that applied when session chunk was consumed.
session_chunk_id varchar(255)
If available, a unique identifier for the session chunk. If not available, concatenate the device_id with the date and time to produce a unique record.
utc_consume_start_epoch
integer Time consumption was started for this session chunk in seconds since the Unix epoch.
utc_consume_stop_epoch integer Time consumption for this session chunk was stopped in seconds since the Unix epoch. If the session chunk is ongoing, then use the last known time the session was still being played. Ongoing session are indicated by setting the 'is_complete' to False in the common_session_chunk element.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
64
13.6. Channels dataThe channels API defines import routines for linear TV channels
13.6.1. Optional data feedsField Name Type Notesappreciation_index
integer An indicator of the public’s appreciation for this channel variant. A score out of 100.
definition varchar(255)
Screen definition this channel variant is delivered in.
epg_digits varchar(255)
Digits used to select this channel in the EPG
is_exclusive boolean Is the channel exclusive for or notis_free bolean Is the channel paid for or notmedia_format varchar(255
)Media format this channel variant is delivered over.
protection varchar(255)
Protection or access control used with this channel variant.
provider varchar(255)
The entity or organisation that produces this channel group
uri varchar(255)
If available a unique identifier for the channel, e.g. DVB Triplet or URL
13.6.2. Mandatory data feedsField Name Type Notesexternal_channel_ref
varchar(255)
A unique identifier for the channel. Typically this would be the channel URI. The same identifier must be used when referring to the channel variant in all import files.
full_label varchar(255)
Where one channel is available in multiple variants (e.g. regional, HD/SD) they can be grouped together under a common label, otherwise the channel group label is always the same as the variant label.
full_label (variant) varchar(255)
The full name of this channel variant.
short_label varchar(255)
The shortened channel group name or call sign, may be the same as the long name
short_label (variant) varchar(255)
The shortened channel variant name or call sign. If short name doesn't exist, use long name.
13.7. Commercial slots dataThe commercial slots API specified the ads and promos shown on channels, typically in an as-run format
13.7.1. Optional data feedsField Name Type Notesadvertisement advertisement_typ
eEither advertisment or promotion must be specified
break_name_label varchar(255) The name of the commericial breakbreak_type_label varchar(255) The type of commercial break for
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
65
Field Name Type Notesthis advert. One of "Unknown", "Before Show Break", "Mid Show Break", "End Break" or "Billboard Break".
external_channel_id
varchar(255) A unique identifier for a channel provided through separate channel provisioning.
promotion promotion_type Either advertisment or promotion must be specified
spot_cost integer The cost of the advert's spotspot_number integer The spot number of the
advertisement within the commercial break
std_tz_offset integer The timezone offset from UTC to standard reporting timezone in seconds.
13.7.2. Mandatory data feedsField Name Type Notesutc_air_start_epoch
integer
Time of advert slot start in seconds since the Unix epoch (e.g. since 1970/01/01 00:00:00 UTC)
utc_air_stop_epoch integer
Time of advert slot stop in seconds since the Unix epoch.
13.8. Consumption methods dataThe consumption methods API defines different consumption methods (e.g. Live, PVR, OTT) that should be measured
13.8.1. Optional data feedsField Name Type Notesfull_method_label
varchar(255)
The longer, more descriptive label e.g. (Local PVR, Video-On-Demand). If not supplied, external_consumption_method_id will be used
method_label varchar(255)
The short label that will be displayed (and also used for grouping) e.g. (Live, PVR, VOD, Catch-up). If not supplied, external_consumption_method_id will be used
13.8.2. Mandatory data feedsField Name Type Notesexternal_consumption_method_id
varchar(255)
An external identifier, for use when referring to this consumption_method in other import files.
13.9. Demographics dataThe demographics API defines different demographic options for subscribers.
13.9.1. Optional data feedsField Name Type Notesethnicity varchar(255
)The subscriber’s ethnicity.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
66
Field Name Type Noteshouse_adult_female_count
integer Number of adult females in subscriber's household
house_adult_male_count integer Number of adult males in subscriber's household
house_child_female_count integer Number of child males in subscriber's household
house_child_male_count integer Number of child females in subscriber's household
house_income_group varchar(255)
The household's income group.
subscriber_age_group varchar(255)
The subscriber’s age group.
subscriber_gender varchar(255)
The subscriber’s gender.
subscriber_income_group varchar(255)
The subscriber’s income group.
13.9.2. Mandatory data feedsField Name
Type
Notes
external_demographic_ref
varchar(255)
An optional unique identifier f
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
67
Field Name
Type
Notes
or a given demographic. If no unique identifier exists t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
68
Field Name
Type
Notes
hen one can be created by concatenating the unique dem
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
69
Field Name
Type
Notes
ographic elements. The same identifier must be used wh
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
70
Field Name
Type
Notes
en referring to this demographic in all import files.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
71
13.10. Device Connections Types dataThe device connections API defines different connection types, e.g. (DTH, IPTV, OTT)
13.10.1. Mandatory data feedsField Name
Type
Notes
device_connection_type_label
varchar(255)
The name of the type of connection used to delive
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
72
Field Name
Type
Notes
r a session.
external_device_connection_type_ref
varchar(255)
A unique identifier used to identify the ty
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
73
Field Name
Type
Notes
pe of connection used to deliver a session. If no obvious
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
74
Field Name
Type
Notes
identifier is present the connection name can be used.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
75
Field Name
Type
Notes
The same identifier must be used when referring to the d
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
76
Field Name
Type
Notes
evice connection type in all import files.
13.11. Devices dataThe device API is used to load detailed information on each device
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
77
13.11.1. Optional data feedsField Name
Type
Notes
application_installation_ref
varchar(255)
The application installation id for data collection on
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
78
Field Name
Type
Notes
this device. For example, this could be the Apple ID a
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
79
Field Name
Type
Notes
ssociated with an app using the Genius Digital iOS SDK
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
80
Field Name
Type
Notes
. The same identifier must be used when referring to the
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
81
Field Name
Type
Notes
application installation in all import files.
connected
integer
Number of t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
82
Field Name
Type
Notes
_count
imes this device has connected
first_connect_epoch
integer
The date this device fir
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
83
Field Name
Type
Notes
st connected to the network
is_hd
boolean
Flag indicating this devi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
84
Field Name
Type
Notes
ce supports HD output.
is_pvr
boolean
Flag indicating this device s
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
85
Field Name
Type
Notes
upports PVR functionality.
last_connect_epoch
integer
The date this device last
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
86
Field Name
Type
Notes
connected to the network
mac_address
list of mac_types
List of device's MAC addres
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
87
Field Name
Type
Notes
ses.
manufacturer_firmware_label
varchar(255)
Firmware version, as provided by the manufactur
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
88
Field Name
Type
Notes
er.
manufacturer_label
varchar(255)
The full manufacturer of this device
middleware_t
varchar(255)
The type of mid
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
89
Field Name
Type
Notes
ype_label
dleware in use.
middleware_version_label
varchar(255)
The version of middleware in use.
mode
varc
Mode
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
90
Field Name
Type
Notes
l_label
har(255)
l number
operator
varchar(255)
The operator providing this device.
operat
varcha
Firmwa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
91
Field Name
Type
Notes
or_firmware_version_label
r(255)
re version, as provided by the operator/integrator. F
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
92
Field Name
Type
Notes
or example, the firmware release produced by an operat
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
93
Field Name
Type
Notes
or/integrator in addition to the default manufacture
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
94
Field Name
Type
Notes
r’s firmware.
os_label
varchar(255)
The device's OS.
os_version
varchar(255)
The device OS version.
r v M
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
95
Field Name
Type
Notes
ange_label
archar(255)
anufacturer's range of this device model
revision_l
varchar(25
Revision of
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
96
Field Name
Type
Notes
abel
5)
this device model
serial_number
varchar(255)
Serial number of device
short_manu
varchar(25
The abbrevi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
97
Field Name
Type
Notes
facturer_label
5)
ated manufacturer of this device
tuner_count
integer
Number of tuners thi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
98
Field Name
Type
Notes
s device supports.
type_label
varchar(255)
Device type description label
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
99
13.11.2. Mandatory data feedsField Name
Type
Notes
external_device_ref
varchar(255)
A unique identifier for a device. This is typically se
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
100
Field Name
Type
Notes
t to be a smart card ID, serial number, or MAC address.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
101
Field Name
Type
Notes
The same identifier must be used when referring to the d
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
102
Field Name
Type
Notes
evice in all import files.
13.12. EPG dataThe EPG API loads programme schedules
13.12.1. Optional data feedsField Name
Type
Notes
country_of_
varchar(255
The Country o
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
103
Field Name
Type
Notes
origin
) f Origin of the programme
episode_label
varchar(255)
Episode title
episode_num
integer
Episode numb
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
104
Field Name
Type
Notes
ber
er
external_channel_ref
varchar(255)
A unique identifier for a channel provided throug
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
105
Field Name
Type
Notes
h separate channel provisioning.
external_program
varchar(255)
Identifier use to id
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
106
Field Name
Type
Notes
me_ref
entify repeated programmes. If no obvious unique ident
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
107
Field Name
Type
Notes
ifier exists one can be generated by concatenating uni
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
108
Field Name
Type
Notes
que elements (programme_label, series_number, epis
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
109
Field Name
Type
Notes
ode_number, etc…). Omitting this ID will result in all
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
110
Field Name
Type
Notes
scheduled programmes being considered unique, i.e. N
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
111
Field Name
Type
Notes
o repeats will be identified. Note that this ID is diffe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
112
Field Name
Type
Notes
rent from the programme ID that is used to identify ca
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
113
Field Name
Type
Notes
tch-up and VOD programmes provided through VOD pro
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
114
Field Name
Type
Notes
visioning.
genre
varchar(255)
Programme genre
language
varchar(255)
The primary language of t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
115
Field Name
Type
Notes
he content
parental_rating
varchar(255)
MPAA parental rating
programme_schedul
list of programme_sc
List of programme sc
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
116
Field Name
Type
Notes
e hedules
hedules for the specified channel.
series_number
integer
Series number
std_
inte
The t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
117
Field Name
Type
Notes
tz_offset
ger
imezone offset from UTC to the standard reporting t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
118
Field Name
Type
Notes
imezone that applied when programmed was aired.
synop
varch
Progr
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
119
Field Name
Type
Notes
sis
ar
amme synopsis
13.12.2. Mandatory data feedsField Name
Type
Notes
programme_label
varchar(255)
Programme title
utc_air
integer
Time pro
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
120
Field Name
Type
Notes
_start_epoch
gramme was started in seconds since the Unix epoch.
ut
in
Ti
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
121
Field Name
Type
Notes
c_air_stop_epoch
teger
me programme was stopped in seconds since the Unix epo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
122
Field Name
Type
Notes
ch.
13.13. Geographies dataThe geographies API loads geographical references for subscribers and devices
13.13.1. Optional data feedsField Name
Type
Notes
latitude
decimal
Decimal value of latitude
longit
decima
Decima
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
123
Field Name
Type
Notes
ude
l l value of longitude
postcode
varchar(255)
Postal or zipcode
13.13.2. Mandatory data feedsField Name
Type
Notes
ci
va
Ci
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
124
Field Name
Type
Notes
ty
rchar(255)
ty within the region
country
varchar(255)
Country
external_geograp
varchar(255)
A unique identier
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
125
Field Name
Type
Notes
hy_ref
for a location. If no obvious unique identifier exists o
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
126
Field Name
Type
Notes
ne can be generated by concatenating unique elements
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
127
Field Name
Type
Notes
(latitude, longituded, house number, postcode, etc
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
128
Field Name
Type
Notes
…). The same identifier must be used when referring to t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
129
Field Name
Type
Notes
he geography in all import files.
region
varchar(255)
Region within the coun
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
130
Field Name
Type
Notes
try e.g. County or State
tz_location_abbr
varchar(255)
Timezone abbreviation
13.14. iOS SDK dataThe MiriMON iOS SDK
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
131
13.14.1. Optional data feedsField Name
Type
Notes
application_log_pointcontent_ready_to_playcor
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
132
Field Name
Type
Notes
edata_completedata_errordata_overrundata_star
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
133
Field Name
Type
Notes
tingdata_underrunloginlogoutmetadata_duration
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
134
Field Name
Type
Notes
metadata_identitymetadata_initialiseplayback_a
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
135
Field Name
Type
Notes
cceleratedplayback_errorplayback_pausedplayba
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
136
Field Name
Type
Notes
ck_progressplayback_resumedplayback_seekplayb
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
137
Field Name
Type
Notes
ack_stalledplayback_start_requestedplayback_st
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
138
Field Name
Type
Notes
artedplayback_stop_requestedplayer_versionsta
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
139
Field Name
Type
Notes
tistics_bitratestatistics_frame_errors
13.15. ISPs dataThe ISPs API defines different ISPs to be measured
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
140
13.15.1. Mandatory data feedsField Name
Type
Notes
external_isp_ref
varchar(255)
Typically the ISPs name, unless a unique identifier is
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
141
Field Name
Type
Notes
available.
isp_label
varchar(255)
The ISP's name, used to identify the ISP in ou
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
142
Field Name
Type
Notes
tput from the Insight platform.
13.16. JavaScript SDK dataThe MiriMON JavaScript SDK
13.16.1. Optional data feedsField Name
Type
Notes
app
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
143
Field Name
Type
Notes
lication_log_pointcontent_ready_to_playcoredat
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
144
Field Name
Type
Notes
a_completedata_errordata_overrundata_starting
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
145
Field Name
Type
Notes
data_underrunloginlogoutmetadata_durationmeta
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
146
Field Name
Type
Notes
data_identitymetadata_initialiseplayback_accel
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
147
Field Name
Type
Notes
eratedplayback_errorplayback_pausedplayback_p
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
148
Field Name
Type
Notes
rogressplayback_resumedplayback_seekplayback_
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
149
Field Name
Type
Notes
stalledplayback_start_requestedplayback_starte
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
150
Field Name
Type
Notes
dplayback_stop_requestedplayer_versionstatist
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
151
Field Name
Type
Notes
ics_bitratestatistics_frame_errors
13.17. Local content playback dataThe local content playback API logs playback from any content that have been stored locally, PVR, Push Download, Progressive Download etc...
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
152
13.17.1. Optional data feedsField Name
Type
Notes
average_bitrate
integer
Average bitrate of session, in Mb/s
channel_audio_
varchar(255)
The channel_aud
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
153
Field Name
Type
Notes
language
io_language is the audio stream language that the su
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
154
Field Name
Type
Notes
bscriber has selected to watch the channel in
end_cau
session
The sess
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
155
Field Name
Type
Notes
se_string
_end_cause_type
ion's end cause (one of UNKNOWN, UPDOWN, END_OF_ASSE
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
156
Field Name
Type
Notes
T, TERMINATED_BY_USER, TERMINATED_BY_APPS)
exter
varch
A uni
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
157
Field Name
Type
Notes
nal_cdn_ref
ar(255)
que identifier for the CDN used to deliver this session
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
158
Field Name
Type
Notes
provided through seperate CDN provisioning.
exter
varch
A uni
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
159
Field Name
Type
Notes
nal_device_connection_type_ref
ar(255)
que identifier for the type of connection used to delive
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
160
Field Name
Type
Notes
r this session provided through seperate device conn
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
161
Field Name
Type
Notes
ection type provisioning.
external_external_cons
varchar(255)
A reference to the consum
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
162
Field Name
Type
Notes
umption_method_ref_ref
ption method to be reported for this session
external
varchar(
A unique
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
163
Field Name
Type
Notes
_geography_ref
255)
identifier for the location in which this session star
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
164
Field Name
Type
Notes
ted provided through seperate geography provisioni
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
165
Field Name
Type
Notes
ng.
external_isp_ref
varchar(255)
A unique identifier for the ISP used to deliver this
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
166
Field Name
Type
Notes
session provided through seperate ISP provisioning
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
167
Field Name
Type
Notes
.is_service_outage
boolean
Is this session chunk part of a complete service outa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
168
Field Name
Type
Notes
ge? When omitted is_service_outage will be defaulted
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
169
Field Name
Type
Notes
to false. For example: The DVB-T signal was lost true :
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
170
Field Name
Type
Notes
The service has completely failed during this session
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
171
Field Name
Type
Notes
chunk. false: The service successfully delivered duri
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
172
Field Name
Type
Notes
ng part or all of this session chunk (some errors may hav
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
173
Field Name
Type
Notes
e occured, these are reporting in player_error_coun
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
174
Field Name
Type
Notes
t and player_error_seconds)
is_service_outage
boolean
Is this session chunk pa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
175
Field Name
Type
Notes
rt of a complete service outage? When omitted is_serv
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
176
Field Name
Type
Notes
ice_outage will be defaulted to false. For example: Th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
177
Field Name
Type
Notes
e DVB-T signal was lost true : The service has complete
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
178
Field Name
Type
Notes
ly failed during this session chunk. false: The servic
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
179
Field Name
Type
Notes
e successfully delivered during part or all of this sessi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
180
Field Name
Type
Notes
on chunk (some errors may have occured, these are repo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
181
Field Name
Type
Notes
rting in player_error_count and player_error_seco
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
182
Field Name
Type
Notes
nds)
playback_speed
decimal
Playback speed as a percentage of normal (real ti
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
183
Field Name
Type
Notes
me playback).
player_buffer_count
integer
Number of times the player paused/skip
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
184
Field Name
Type
Notes
ped while waiting for content to buffer, during this se
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
185
Field Name
Type
Notes
ssion chunk.
player_buffer_seconds
integer
Number of seconds during the session chu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
186
Field Name
Type
Notes
nk that were affected by player buffering.
player_er
integer
Number of p
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
187
Field Name
Type
Notes
ror_count
layer errors during the session chunk (typically resu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
188
Field Name
Type
Notes
lting from missing or corrupt content)
player_erro
integer
Number of sec
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
189
Field Name
Type
Notes
r_seconds
onds during the session chunk that were affected by pl
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
190
Field Name
Type
Notes
ayer errors.
service_outage_cause_string
varchar(255)
The cause of this service outage (only re
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
191
Field Name
Type
Notes
quired when is_service_outage=true)
start_audio_
integer
Time from use
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
192
Field Name
Type
Notes
abs
r request to starting audio playback, in ms.
start_av
integer
Time from
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
193
Field Name
Type
Notes
_abs
user request to starting audio and video playback, i
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
194
Field Name
Type
Notes
n ms.
start_cause_string
session_start_cause_type
The session start cause. One of UNKNOWN, INT_AUT
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
195
Field Name
Type
Notes
O_VIEWING, INT_AUTO_RECORDING, INT_AUTO_STARTUP
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
196
Field Name
Type
Notes
, INT_AUTO_SERVICE, INT_AUTO_APPLICATION, INT_AU
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
197
Field Name
Type
Notes
TO_OTHER, INT_AUTO_RETRY, REMOTE_USER_INPUT, REM
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
198
Field Name
Type
Notes
OTE_USER_UPDOWN, REMOTE_USER_FAVOURITE, REMOTE_
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
199
Field Name
Type
Notes
USER_CHANNEL, REMOTE_USER_BANNER, REMOTE_USER_G
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
200
Field Name
Type
Notes
UIDE, REMOTE_USER_OTHER, APP_USER_INPUT, APP_USE
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
201
Field Name
Type
Notes
R_UPDOWN, APP_USER_FAVOURITE, APP_USER_CHANNEL,
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
202
Field Name
Type
Notes
APP_USER_BANNER, APP_USER_GUIDE, APP_USER_OTHER
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
203
Field Name
Type
Notes
, PANEL_USER_INPUT, PANEL_USER_UPDOWN, or DEVICE_
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
204
Field Name
Type
Notes
AUTO_OTHER,
start_offset
integer
The session chunk's start offset in seco
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
205
Field Name
Type
Notes
nds within the local content.
start_overall
integer
Time from user request
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
206
Field Name
Type
Notes
to starting playback, in ms.
start_result_string
session_start_result_
The session's start resu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
207
Field Name
Type
Notes
type
lt (one of UNKNOWN, SUCCESS, FAILURE, SLOW, or INTERR
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
208
Field Name
Type
Notes
UPTED)
start_video_abs
integer
Time from user request to starting video play
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
209
Field Name
Type
Notes
back, in ms.
std_tz_offset
integer
The standard time zone is the timezone tha
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
210
Field Name
Type
Notes
t the results will be displayed in.
utc_air_start_epo
integer
The consumption sta
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
211
Field Name
Type
Notes
ch
rt date-time of this session chunk.
utc_air_stop_ep
integer
The consumption e
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
212
Field Name
Type
Notes
och
nd date-time of this session chunk. If this is not yet kn
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
213
Field Name
Type
Notes
own (for example, until the playback finishes) then set
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
214
Field Name
Type
Notes
is_complete to false and provided the maximum consu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
215
Field Name
Type
Notes
me time that has currently been reached. Then, once th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
216
Field Name
Type
Notes
e stop time is known, repeat this element in a subseque
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
217
Field Name
Type
Notes
nt import file with the final stop time and is_complete t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
218
Field Name
Type
Notes
rue.
13.17.2. Mandatory data feedsField Name
Type
Notes
external_device_ref
varchar(255)
A unique identifier for a device tha
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
219
Field Name
Type
Notes
t the subscriber owns that is provided through separa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
220
Field Name
Type
Notes
te device provisioning.
full_session_id
varchar(255)
If available, a unique identifi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
221
Field Name
Type
Notes
er for the session. If not available, concatenate the de
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
222
Field Name
Type
Notes
vice_id with the date and time to produce a unique reco
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
223
Field Name
Type
Notes
rd.
is_complete
boolean
When reporting ongoing sessions that have not yet
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
224
Field Name
Type
Notes
completed, set this flag to false.
is_first_session_c
boolean
Where sessions are g
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
225
Field Name
Type
Notes
hunk
rouped into multiple chunks (for example at differen
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
226
Field Name
Type
Notes
t speeds) these flags are used to indicate the first and l
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
227
Field Name
Type
Notes
ast chunks in a session.
is_last_session_chunk
boolean
Where sessions are grouped in
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
228
Field Name
Type
Notes
to multiple chunks (for example at different speeds)
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
229
Field Name
Type
Notes
these flags are used to indicate the first and last chunk
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
230
Field Name
Type
Notes
s in a session.
local_content_ref
varchar(255)
The identifier of the local content Spec
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
231
Field Name
Type
Notes
ific to the recording device. Does not need to be unique
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
232
Field Name
Type
Notes
across devices e.g. filename.
local_tz_offset
integer
The timezone offset fro
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
233
Field Name
Type
Notes
m UTC to local time that applied when session chunk wa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
234
Field Name
Type
Notes
s consumed.
session_chunk_id
varchar(255)
If available, a unique identifier for the ses
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
235
Field Name
Type
Notes
sion chunk. If not available, concatenate the device_i
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
236
Field Name
Type
Notes
d with the date and time to produce a unique record.
13.18. Packages dataThe Package API loads different packages of TV channels
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
237
13.18.1. Optional data feedsField Name
Type
Notes
external_channel_refs
list of external_channel_ids
List of channels in the package.
operator
varchar(255)
The name of the opera
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
238
Field Name
Type
Notes
tor providing the package.
13.18.2. Mandatory data feedsField Name
Type
Notes
external_pa
varchar(255
A unique ide
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
239
Field Name
Type
Notes
ckage_ref
) ntifier referencing a package that the subscriber cur
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
240
Field Name
Type
Notes
rently receives. If no obvious identifier is present th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
241
Field Name
Type
Notes
en the package name is typically used. The same identifi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
242
Field Name
Type
Notes
er must be used when referring to the package in all impo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
243
Field Name
Type
Notes
rt files.
package_label
varchar(255)
Name of the package
13.19. Programme playback dataThe Programme playback API registers playback of individual programmes that are NOT associated with a specific TV channel
13.19.1. Optional data feedsField Name
Type
Notes
averag
intege
Averag
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
244
Field Name
Type
Notes
e_bitrate
r e bitrate of session, in Mb/s
end_cause_string
session_end_cause_typ
The session's end cause (
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
245
Field Name
Type
Notes
e one of UNKNOWN, UPDOWN, END_OF_ASSET, TERMINATED_B
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
246
Field Name
Type
Notes
Y_USER, TERMINATED_BY_APPS)
external_cdn_ref
varchar(255)
A unique identifier fo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
247
Field Name
Type
Notes
r the CDN used to deliver this session provided throug
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
248
Field Name
Type
Notes
h seperate CDN provisioning.
external_device_con
varchar(255)
A unique identifier fo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
249
Field Name
Type
Notes
nection_type_ref
r the type of connection used to deliver this session pr
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
250
Field Name
Type
Notes
ovided through seperate device connection type prov
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
251
Field Name
Type
Notes
isioning.
external_external_consumption_method
varchar(255)
A reference to the consumption method to b
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
252
Field Name
Type
Notes
_ref_ref
e reported for this session
external_geography_ref
varchar(255)
A unique identifier for th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
253
Field Name
Type
Notes
e location in which this session started provided thr
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
254
Field Name
Type
Notes
ough seperate geography provisioning.
external_is
varchar(255
A unique ide
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
255
Field Name
Type
Notes
p_ref
) ntifier for the ISP used to deliver this session provide
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
256
Field Name
Type
Notes
d through seperate ISP provisioning.
playback_spee
decimal
Playback speed
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
257
Field Name
Type
Notes
d as a percentage of normal (real time playback).
playe
integ
Numbe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
258
Field Name
Type
Notes
r_buffer_count
er
r of times the player paused/skipped while waiting for
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
259
Field Name
Type
Notes
content to buffer, during this session chunk.
player
intege
Number
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
260
Field Name
Type
Notes
_buffer_seconds
r of seconds during the session chunk that were affecte
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
261
Field Name
Type
Notes
d by player buffering.
player_error_count
integer
Number of player errors during
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
262
Field Name
Type
Notes
the session chunk (typically resulting from missing
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
263
Field Name
Type
Notes
or corrupt content)
player_error_seconds
integer
Number of seconds during the sess
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
264
Field Name
Type
Notes
ion chunk that were affected by player errors.
servic
varcha
The cau
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
265
Field Name
Type
Notes
e_outage_cause_string
r(255)
se of this service outage (only required when is_serv
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
266
Field Name
Type
Notes
ice_outage=true)
start_audio_abs
integer
Time from user request to startin
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
267
Field Name
Type
Notes
g audio playback, in ms.
start_av_abs
integer
Time from user request to sta
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
268
Field Name
Type
Notes
rting audio and video playback, in ms.
start_cause_s
session_start
The session sta
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
269
Field Name
Type
Notes
tring
_cause_type
rt cause. One of UNKNOWN, INT_AUTO_VIEWING, INT_AUT
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
270
Field Name
Type
Notes
O_RECORDING, INT_AUTO_STARTUP, INT_AUTO_SERVICE
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
271
Field Name
Type
Notes
, INT_AUTO_APPLICATION, INT_AUTO_OTHER, INT_AUTO
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
272
Field Name
Type
Notes
_RETRY, REMOTE_USER_INPUT, REMOTE_USER_UPDOWN, R
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
273
Field Name
Type
Notes
EMOTE_USER_FAVOURITE, REMOTE_USER_CHANNEL, REMO
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
274
Field Name
Type
Notes
TE_USER_BANNER, REMOTE_USER_GUIDE, REMOTE_USER_
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
275
Field Name
Type
Notes
OTHER, APP_USER_INPUT, APP_USER_UPDOWN, APP_USER
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
276
Field Name
Type
Notes
_FAVOURITE, APP_USER_CHANNEL, APP_USER_BANNER, A
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
277
Field Name
Type
Notes
PP_USER_GUIDE, APP_USER_OTHER, PANEL_USER_INPUT
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
278
Field Name
Type
Notes
, PANEL_USER_UPDOWN, or DEVICE_AUTO_OTHER,
start_
intege
The off
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
279
Field Name
Type
Notes
offset
r set within the VOD that this session chunk started fr
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
280
Field Name
Type
Notes
om, in seconds.
start_overall
integer
Time from user request to starting pl
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
281
Field Name
Type
Notes
ayback, in ms.
start_result_string
session_start_result_type
The session's start result (one of UNKN
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
282
Field Name
Type
Notes
OWN, SUCCESS, FAILURE, SLOW, or INTERRUPTED)
start_
intege
Time fr
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
283
Field Name
Type
Notes
video_abs
r om user request to starting video playback, in ms.
st
in
Th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
284
Field Name
Type
Notes
d_tz_offset
teger
e standard time zone is the timezone that the results w
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
285
Field Name
Type
Notes
ill be displayed in.
13.19.2. Mandatory data feedsField Name
Type
Notes
external_device_re
varchar(255)
A unique identifier f
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
286
Field Name
Type
Notes
f or a device that the subscriber owns that is provided t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
287
Field Name
Type
Notes
hrough separate device provisioning.
external_pro
varchar(255)
The programme
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
288
Field Name
Type
Notes
gramme_ref
this VOD session is playing. A unique identifier of a
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
289
Field Name
Type
Notes
programme that has been provided through seperate VO
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
290
Field Name
Type
Notes
D provisioning.
full_session_id
varchar(255)
If available, a unique identifier for t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
291
Field Name
Type
Notes
he session. If not available, concatenate the device_i
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
292
Field Name
Type
Notes
d with the date and time to produce a unique record.
is_
boo
Whe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
293
Field Name
Type
Notes
complete
lean
n reporting ongoing sessions that have not yet comple
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
294
Field Name
Type
Notes
ted, set this flag to false.
is_first_session_chunk
boolean
Where sessions are grouped
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
295
Field Name
Type
Notes
into multiple chunks (for example at different speed
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
296
Field Name
Type
Notes
s) these flags are used to indicate the first and last chu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
297
Field Name
Type
Notes
nks in a session.
is_last_session_chunk
boolean
Where sessions are grouped into mult
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
298
Field Name
Type
Notes
iple chunks (for example at different speeds) these fl
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
299
Field Name
Type
Notes
ags are used to indicate the first and last chunks in a se
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
300
Field Name
Type
Notes
ssion.
local_tz_offset
integer
The timezone offset from UTC to local time th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
301
Field Name
Type
Notes
at applied when session chunk was consumed.
session_c
varchar(2
If available
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
302
Field Name
Type
Notes
hunk_id
55)
, a unique identifier for the session chunk. If not availa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
303
Field Name
Type
Notes
ble, concatenate the device_id with the date and time
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
304
Field Name
Type
Notes
to produce a unique record.
utc_consume_start_epoc
integer
Time consumption was star
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
305
Field Name
Type
Notes
h ted for this session chunk in seconds since the Unix ep
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
306
Field Name
Type
Notes
och.
utc_consume_stop_epoch
integer
Time consumption for this session chunk was stop
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
307
Field Name
Type
Notes
ped in seconds since the Unix epoch. If the session chun
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
308
Field Name
Type
Notes
k is ongoing, then use the last known time the session w
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
309
Field Name
Type
Notes
as still being played. Ongoing session are indicated b
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
310
Field Name
Type
Notes
y setting the 'is_complete' to False in the common_ses
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
311
Field Name
Type
Notes
sion_chunk element.
13.20. Promos dataThe Promos API logs playback of promos in commercial breaks
13.20.1. Optional data feedsField Name
Type
Notes
agency_label
varchar(255)
The name of the a
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
312
Field Name
Type
Notes
gency associated with this advert
campaign_label
varchar(255)
The name of the camp
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
313
Field Name
Type
Notes
aign associated with this advert
external_ad_progr
varchar(255)
A unique identifier
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
314
Field Name
Type
Notes
amme_id
for the programme in which the advert appears, provid
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
315
Field Name
Type
Notes
ed through seperate programme schedule provisionin
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
316
Field Name
Type
Notes
g. This ID is also used to identify duplicate ad program
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
317
Field Name
Type
Notes
mes when the advert is repeated on this or other channe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
318
Field Name
Type
Notes
ls. Omitting this ID will result in all scheduled ads be
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
319
Field Name
Type
Notes
ing considered unique, i.e. No repeats will be identifie
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
320
Field Name
Type
Notes
d.
language
varchar(255)
The language the advert was broadcast in
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
321
13.20.2. Mandatory data feedsField Name
Type
Notes
copyline_label
varchar(255)
The copyline for this advert
13.21. Purchasables dataThe purchasables API stored information on TVOD purchasable items
13.21.1. Optional data feedsField Name
Type
Notes
asset_
intege
The num
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
322
Field Name
Type
Notes
count
r ber off assets associated with this purchasable e.g.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
323
Field Name
Type
Notes
the number of programmes/channels.
genre
varchar(255)
Genre associate
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
324
Field Name
Type
Notes
d with this purchasable
sub_type
varchar(255)
Further description of the pu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
325
Field Name
Type
Notes
rchasable. e.g. Bundle, Series or Single.
total_con
integer
Sum of the
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
326
Field Name
Type
Notes
tent_duration
duration of all assets in this purchasable
type
varchar(25
Where there
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
327
Field Name
Type
Notes
5)
are mutiple purchasables use this to specify a categor
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
328
Field Name
Type
Notes
y
13.21.2. Mandatory data feedsField Name
Type
Notes
external_purchasable_ref
varchar(255)
A unique identifier referencing an ent
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
329
Field Name
Type
Notes
ity that the subscriber can purchase. If no obvious ide
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
330
Field Name
Type
Notes
ntifier is present then the purchasable name concaten
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
331
Field Name
Type
Notes
ated with the launch time/date, genre etc. can be used
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
332
Field Name
Type
Notes
. The same identifier must be used when referring to the
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
333
Field Name
Type
Notes
purchasable in all import files.
launch_epoch
varchar(255)
The date this entity wa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
334
Field Name
Type
Notes
s first made available for purchase. (use date first seen
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
335
Field Name
Type
Notes
if not provided with this)
purchasable_label
varchar(255)
Name of this purchasable ent
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
336
Field Name
Type
Notes
ity.
13.22. Purchases dataThe purchases API stored information on specific purchases of purchasable items
13.22.1. Optional data feedsField Name
Type
Notes
effective_duration
integer
Where purchasables are avalabl
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
337
Field Name
Type
Notes
e for a limited time, specify the time in seconds here
eff
int
Tim
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
338
Field Name
Type
Notes
ective_from_epoch
eger
e content associated with this purchase become availa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
339
Field Name
Type
Notes
ble for consumption to the subscriber in seconds sinc
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
340
Field Name
Type
Notes
e the Unix epoch.
purchase_source
varchar(255)
The source of where the purchase took
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
341
Field Name
Type
Notes
place. For example: Android/iOS app, Website
std_tz_
integer
The time
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
342
Field Name
Type
Notes
offset
zone offset from UTC to the standard reporting time
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
343
Field Name
Type
Notes
zone that applied when purchase was made.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
344
13.22.2. Mandatory data feedsField Name
Type
Notes
external_purchasable_ref
varchar(255)
A unique identifier referencing an entity that the s
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
345
Field Name
Type
Notes
ubscriber can purchase, provided through seperate p
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
346
Field Name
Type
Notes
urchasable provisioning.
external_purchase_ref
varchar(255)
A unique idetifier refere
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
347
Field Name
Type
Notes
ncing a purchase event of a subscriber. If no obvious id
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
348
Field Name
Type
Notes
entifier is present then the purchasable id concatena
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
349
Field Name
Type
Notes
ted with the subscriber id and purchase time/date can
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
350
Field Name
Type
Notes
be used. The same identifier must be used when referrin
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
351
Field Name
Type
Notes
g to the purchase in all import files.
external_subscri
varchar(255)
A unique identifie
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
352
Field Name
Type
Notes
ber_ref
r referencing an individual subscriber, provided th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
353
Field Name
Type
Notes
rough seperate subscriber provisioning.
local_tz_
integer
The timezo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
354
Field Name
Type
Notes
offset
ne offset from UTC to local time that applied when pur
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
355
Field Name
Type
Notes
chase was made.
purchase_epoch
varchar(255)
Time of purchase in seconds since the U
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
356
Field Name
Type
Notes
nix epoch.
purchase_price
decimal
The price paid for this particular purchas
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
357
Field Name
Type
Notes
e.
13.23. Saving local content from channels dataThe saving local content from channel API registers recording content from a broadcast channel to disk
13.23.1. Optional data feedsField Name
Type
Notes
channel_audio_language
varchar(255)
he channel_audio_language tha
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
358
Field Name
Type
Notes
t will be associated with this local content if/when it i
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
359
Field Name
Type
Notes
s consumed, unless the playback_local_content impo
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
360
Field Name
Type
Notes
rt file provides an overide. channel_audio_language
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
361
Field Name
Type
Notes
is the audio stream language that the subscriber has
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
362
Field Name
Type
Notes
selected to watch the channel in.
default_consumpti
varchar(255)
The consumption met
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
363
Field Name
Type
Notes
on_method_ref
hod that will be associated with this local content if/ w
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
364
Field Name
Type
Notes
hen it is consumed, unless the playback_local_conte
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
365
Field Name
Type
Notes
nt import file provides an override.
std_tz_offset
integer
The timezone offs
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
366
Field Name
Type
Notes
et from UTC to the standard reporting timezone that
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
367
Field Name
Type
Notes
applied when recording was made.
13.23.2. Mandatory data feedsField Name
Type
Notes
externa
varchar
A uniqu
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
368
Field Name
Type
Notes
l_channel_ref
(255)
e identifier for a channel provided through separate c
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
369
Field Name
Type
Notes
hannel provisioning.
external_device_ref
varchar(255)
A unique identifier for a devic
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
370
Field Name
Type
Notes
e that the subscriber owns that is provided through se
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
371
Field Name
Type
Notes
perate device provisioning.
is_complete
boolean
Flag indicating whethe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
372
Field Name
Type
Notes
r the recording is still ongoing or not.
local_content
varchar(255)
The identifier o
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
373
Field Name
Type
Notes
_ref
f the recording. Specific to the recording device. Doe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
374
Field Name
Type
Notes
s not need to be unique across devices e.g. filename.
lo
in
Th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
375
Field Name
Type
Notes
cal_tz_offset
teger
e timezone offset from UTC to local time that applied
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
376
Field Name
Type
Notes
when recording was made.
utc_air_start_epoch
integer
Time recording was started i
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
377
Field Name
Type
Notes
n seconds since the Unix epoch.
utc_air_stop_epoch
integer
Time recording was sto
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
378
Field Name
Type
Notes
pped in seconds since the Unix epoch.
utc_save_start
integer
Time recording w
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
379
Field Name
Type
Notes
_epoch
as started in seconds since the Unix epoch.
utc_save_
integer
Time recor
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
380
Field Name
Type
Notes
stop_epoch
ding was stopped in seconds since the Unix epoch.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
381
13.24. Saving local content from channels and programmes data
The saving local content from channel and programme API registers the saving of local content that is associated with both and channel AND a programme to disk
13.24.1. Optional data feedsField Name
Type
Notes
default_channel_audio_language
varchar(255)
he channel_audio_language that will be asso
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
382
Field Name
Type
Notes
ciated with this local content if/when it is consumed,
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
383
Field Name
Type
Notes
unless the playback_local_content import file provi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
384
Field Name
Type
Notes
des an overide. channel_audio_language is the audio
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
385
Field Name
Type
Notes
stream language that the subscriber has selected to
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
386
Field Name
Type
Notes
watch the channel in.
default_consumption_method_
varchar(255)
The consumption method that will
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
387
Field Name
Type
Notes
ref
be associated with this local content if/ when it is con
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
388
Field Name
Type
Notes
sumed, unless the playback_local_content import fil
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
389
Field Name
Type
Notes
e provides an override.
std_tz_offset
integer
The timezone offset from UTC
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
390
Field Name
Type
Notes
to the standard reporting timezone that applied when
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
391
Field Name
Type
Notes
recording was made.
13.24.2. Mandatory data feedsField Name
Type
Notes
external_channel_
varchar(255)
A unique identifier
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
392
Field Name
Type
Notes
ref
for a channel provided through separate channel prov
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
393
Field Name
Type
Notes
isioning.
external_device_ref
varchar(255)
A unique identifier for a device that the su
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
394
Field Name
Type
Notes
bscriber owns that is provided through seperate devi
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
395
Field Name
Type
Notes
ce provisioning.
external_programme_ref
varchar(255)
A unique identifier for a programme
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
396
Field Name
Type
Notes
provided through separate programme provisioning.
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
397
Field Name
Type
Notes
is_complete
boolean
Flag indicating whether the recording is still ongoin
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
398
Field Name
Type
Notes
g or not.
local_content_ref
varchar(255)
The identifier of the recording. Specific to th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
399
Field Name
Type
Notes
e recording device. Does not need to be unique across d
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
400
Field Name
Type
Notes
evices e.g. filename.
local_tz_offset
integer
The timezone offset from UTC t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
401
Field Name
Type
Notes
o local time that applied when recording was made.
utc_
inte
Time
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
402
Field Name
Type
Notes
save_start_epoch
ger
recording was started in seconds since the Unix epoch
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
403
Field Name
Type
Notes
.utc_save_stop_epoch
integer
Time recording was stopped in seconds since the Unix
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
404
Field Name
Type
Notes
epoch.
13.25. Saving local content from programmes dataThe saving local content programme API registers the saving of local content that is associated with a programme but NOT with a channel to disk, this is typically VOD
13.25.1. Optional data feedsField Name
Type
Notes
default_consumption_me
varchar(255)
The consumption method th
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
405
Field Name
Type
Notes
thod_ref
at will be associated with this local content if/ when it
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
406
Field Name
Type
Notes
is consumed, unless the playback_local_content imp
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
407
Field Name
Type
Notes
ort file provides an override.
std_tz_offset
integer
The timezone offset fro
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
408
Field Name
Type
Notes
m UTC to the standard reporting timezone that applie
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
409
Field Name
Type
Notes
d when recording was made.
13.25.2. Mandatory data feedsField Name
Type
Notes
external_dev
varchar(255)
A unique iden
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
410
Field Name
Type
Notes
ice_ref
tifier for a device that the subscriber owns that is pro
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
411
Field Name
Type
Notes
vided through seperate device provisioning.
extern
varcha
A uniq
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
412
Field Name
Type
Notes
al_programme_ref
r(255)
ue identifier for a programme provided through separa
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
413
Field Name
Type
Notes
te programme provisioning.
is_complete
boolean
Flag indicating whether
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
414
Field Name
Type
Notes
the recording is still ongoing or not.
local_content_
varchar(255)
The identifier of
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
415
Field Name
Type
Notes
ref
the recording. Specific to the recording device. Does
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
416
Field Name
Type
Notes
not need to be unique across devices e.g. filename.
loc
int
The
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
417
Field Name
Type
Notes
al_tz_offset
eger
timezone offset from UTC to local time that applied w
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
418
Field Name
Type
Notes
hen recording was made.
utc_save_start_epoch
integer
Time recording was started in
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
419
Field Name
Type
Notes
seconds since the Unix epoch.
utc_save_stop_epoch
integer
Time recording was stop
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
420
Field Name
Type
Notes
ped in seconds since the Unix epoch.
13.26. Subscriber information dataThe subscriber information API stores detailed information on the subscribers
13.26.1. Optional data feedsField Name
Type
Notes
d v A
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
421
Field Name
Type
Notes
emographic_external_ref
archar(255)
n optional unique identifier for demographics provid
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
422
Field Name
Type
Notes
ed through separate demographic provisioning.
devi
List
An op
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
423
Field Name
Type
Notes
ce_external_refs
of device_external_ids
tional list of unique identifiers for any devices that t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
424
Field Name
Type
Notes
he subscriber owns that are provided through seperat
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
425
Field Name
Type
Notes
e device provisioning.
home_location_external_re
varchar(255)
An optional unique identifier
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
426
Field Name
Type
Notes
f for the subscriber's home location provided through
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
427
Field Name
Type
Notes
seperate geography provisioning.
label
varchar(255)
Label used to iden
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
428
Field Name
Type
Notes
tify the subscriber in any output from the insight pla
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
429
Field Name
Type
Notes
tform
package_external_refs
List of package_external_ids
An optional list of unique identifiers referenci
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
430
Field Name
Type
Notes
ng any packages that the subscriber currently receiv
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
431
Field Name
Type
Notes
es, provided through separate package provisioning
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
432
Field Name
Type
Notes
.
13.26.2. Mandatory data feedsField Name
Type
Notes
external_subscriber_ref
varchar(255)
A unique identifier referencing a subs
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
433
Field Name
Type
Notes
criber, typically the subscriber's account number or
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
434
Field Name
Type
Notes
equivalent. The same identifier must be used when refe
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
435
Field Name
Type
Notes
rring to the subscriber in all import files.
13.27. VOD dataThe VOD API stored programme information for VOD assets that are not associated with a channel
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
436
13.27.1. Optional data feedsField Name
Type
Notes
country_of_origin
varchar(255)
The Country of Origin of the programme
episode_labe
varchar(255)
Episode title
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
437
Field Name
Type
Notes
lepisode_number
integer
Episode number
genre
varchar(255)
Programme genre
language
varchar(255)
The primary langua
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
438
Field Name
Type
Notes
ge of the content
parental_rating
varchar(255)
MPAA parental rating
series_numbe
integer
Series number
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
439
Field Name
Type
Notes
rsynopsis
varchar
Programme synopsis
13.27.2. Mandatory data feedsField Name
Type
Notes
external_program
varchar(255)
A unique identifie
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
440
Field Name
Type
Notes
me_ref
r referencing a programme that the subscriber can rec
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
441
Field Name
Type
Notes
eive as VOD. If no obvious unique identifier exists one c
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
442
Field Name
Type
Notes
an be generated by concatenating unique elements (pr
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
443
Field Name
Type
Notes
ogramme_label, series_number, episode_number, etc
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
444
Field Name
Type
Notes
…). The same identifier must be used when referring to t
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
445
Field Name
Type
Notes
he VOD programme in all import files.
programme_label
varchar(255)
Programme title
© Genius Digital 2013-14, all rights reservedCommercial in Confidence
446
© Genius Digital 2013-14, all rights reservedCommercial in Confidence