CleverTap events for iOS / Apple TV
  • 31 Jul 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

CleverTap events for iOS / Apple TV

  • Dark
    Light
  • PDF

Article summary

After integrating with the Tools CMS, the CleverTap system will begin tracking the following user events and corresponding properties on iOS and Apple TV.  

S.NEvent NamePropertiesEvent is triggered when the user...
1Signed Up
  • registrationType
  • appVersion
  • platform
Registers with your app by email / Google/ Facebook / Apple on iOS app.
The option to log in with an email or mobile number is available as a native key.
2Watched
  • seasonNumber
  • bitRate
  • actorName
  • contentDuration
  • contentGenre
  • episodeNumber
  • playSource    
  • networkType    
  • contentId
  • showName    
  • bufferCount    
  • contentTitle
  • subtitles    
  • platform    
  • contentType   
  • watchedTime    
  • playbackType    
  • directorName    
  • Stream    
  • bufferTime
  • contentId
  • contentTitle
Watches content for at least 2 minutes.
An event is triggered to update the stream time every 30 seconds.
3Page Viewed
  • platform
  • pageName
  • lastPageName
  • appVersion
Opens a specific screen in the app.
4View Plans
  • Platform
  • pageType (Not added)
Lands on the View Plans page.
5

Login

  • registrationType    
  • appVersion
  • platform
Logs in to the app.
6Logout
  • platform

Logs out of the app.

7Searched
  • keyword
  • platform
Enters any keywords into the search bar.
8


Added to Watchlist

  • contentId    
  • contentDuration(Not for show)    
  • contentType    
  • platform    
  • playbackType(not for show)
  • contentGenre    
  • actorName    
  • directorName
  • networkType
  • contentTitle

Adds a video / program to their watchlist.

9Removed All From Watchlist
  • contentId
  • contentDuration(Not for show)
  • contentType
  • contentTitle  
  • platform    
  • playbackType(not for show)
  • contentGenre
  • actorName
  • directorName
  • networkType
Clears their Watchlist page.
10Play Started


  • seasonNumber
  • playSource
  • networkType
  • contentId
  • bitRate    
  • showName
  • bufferCount
  • contentTitle
  • actorName    
  • subtitles    
  • platform    
  • Rating (Not added)
  • contentDuration    
  • contentType
  • watchedTime    
  • contentGenre
  • playbackType
  • directorName    
  • freeOrPaid (not added)
  • episodeNumber    
  • Stream    
  • bufferTime 

Initiates watching a content.

11Media Error
  • playErrorEventData
  • listeningTime (Not added)        
  • seasonNumber
  • playSource
  • networkType    
  • contentId
  • bitRate
  • showName
  • bufferCount
  • contentTitle
  • actorName
  • subtitles
  • platform    
  • contentDuration
  • contentType
  • watchedTime    
  • contentGenre
  • playbackType
  • directorName    
  • episodeNumber
  • Stream
  • bufferTime
This event logs error occurrences during runtime.
12Player BitRate changed
  • quality
  • watchSource
This event captures the stream quality and watch source (iOS here).
13

Shared

  • medium            
  • seasonNumber(video only)
  • singerName(audio only)
  • networkType    
  • contentId
This event records the number of times a media was shared.
14

Subscription Initiated



  • userId    
  • discountedAmount    
  • paymentHandler
  • platform    
  • source
  • planType    
  • paymentplan    
  • transactionId 
  • country
  • planStartDate
  • currency
  • planEndDate


Subscribes to a plan and the payment is processed, the subscription status is updated to "completed", and the subscription date starts.

15

Download Initiated

  • seasonNumber(video only)    
  • singerName(audio only)    
  • networkType    
  • contentId
  • bitRate    
  • showName(video only)       
  • contentTitle
  • actorName(video only)    
  • musicDirectorName(audio only)    
  • platform    
  • contentDuration    
  • contentType        
  • contentGenre    
  • playbackType    
  • directorName(video only)    
  • episodeNumber(video only) 

Starts downloading a content.


16

Download Completed


  • seasonNumber(video only)    
  • singerName(audio only)    
  • networkType    
  • contentId
  • bitRate    
  • showName(video only)        
  • contentTitle
  • actorName(video only)    
  • musicDirectorName(audio only)    
  • platform    
  • contentDuration    
  • contentType        
  • contentGenre    
  • playbackType    
  • directorName(video only)    
  • episodeNumber(video only)

Completes downloading a content.


17

Download Bitrate Changed (Properties New)

  • platform 
  • quality
Switches to a specific bitrate quality of a video.
18

Cast


  • seasonNumber         
  • networkType    
  • contentId
  • bitRate    
  • showName        
  • contentTitle
  • actorName    
  • castType    
  • platform    
  • contentDuration   
  • contentType        
  • contentGenre    
  • playbackType    
  • directorName    
  • episodeNumber

This event records the cast & crew information, season number, bitrate of the video streamed, and more as listed in the Properties column in left.


19Free Plan Email Captured

Logs the "Email required" prompt on contents associated with the Free Plan

Note:


The CleverTap dashboard does not support viewing the following events as they are not integrated with the app's functionality. Instead, information regarding these events is collected and managed on the Tools' backend.

  • Subscription End New
  • Subscription Renewed Manually
  • Subscription Renewed Automatically
  • Subscription Suspended
  • Subscription Cancelled New

Related topics

CleverTap Overview for Developers

CleverTap iOS Integration Guide


Was this article helpful?