| 3 | eventType | EventType | The type of this event
| optional | EventType.VIEW |
| 1 | eventId | string | Unique id associated with this specific event.
You must make sure this is globally unqiue: ophan will only process one event per eventId.
| required | |
| 9 | viewId | string | The id of this page view. Defaults to the same as event Id which is fine for events of type View.
However, AD_LOAD events must set this to be the same as the viewId of the of the page view on which
this ad is shown.
| optional | |
| 22 | ageMsLong | i64 | This is for reporting offline events.
The number of milliseconds ago that the event occurred. (We deliberately don't
use an absolute timestamp to avoid issues with clocks on mobile devices being incorrect)
This number should be zero or a positive number, never negative (that would mean in the future!).
If an event has just happened, set this value to 0.
| optional | |
| 2 | ageMs | i32 | DEPRECATED - use ageMsLong instead
The i32 type is a 32-bit signed integer, so can only represent up to 2^31 milliseconds (24.9 days) of age
without overflow - if a device is offline longer than a month we would get some weird 'future' events.
| optional | 0 |
| 4 | path | string | Represents the page that has been displayed.
For content pages, this should the exact content api path with a "/" prefix.
For other pages, this should be the path of the corresponding web page on theguardian.com.
This is mandatory if eventType is VIEW.
| optional | |
| 5 | OBSOLETE_previousPath | string | DEPRECATED - use referrer
The referring path, i.e. the path representing a page displyed on the app on
which the user clicked a link to arrive at this page.
| optional | |
| 6 | OBSOLETE_referringSource | source.Source | DEPRECATED - use referrer
The means by which the user arrived at this page.
| optional | |
| 7 | pushNotificationId | string | An id which we can link back to Pushy.
| optional | |
| 8 | adLoad | ads.RenderedAd | Details about a rendered ad.
Only applicable if eventType is AD_LOAD.
| optional | |
| 10 | benchmark | benchmark.BenchmarkData | Contains benchmark data.
Only applicable if eventType is PERFORMANCE.
| optional | |
| 11 | networkOperation | benchmark.NetworkOperationData | Contains performance data for network based operations.
Only applicable if eventType is NETWORK.
| optional | |
| 12 | attentionMs | i64 | Attention time spent on this page view in milliseconds
Only applicable if eventType is INTERACTION.
| optional | |
| 13 | scrollDepth | ScrollDepth | Details of how far through a page a user has scrolled
Only applicable if eventType is INTERACTION.
| optional | |
| 14 | media | media.MediaPlayback | If populated, this event includes data about media playback
| optional | |
| 15 | ab | abtest.AbTestInfo | If populated, this event includes data about ab tests that the user was a member of
| optional | |
| 16 | interaction | interaction.Interaction | If populated, this event includes data about in-app interactions.
| optional | |
| 17 | referrer | referrer.Referrer | If populated, contains information about the referrer/previous page in the apps.
| optional | |
| 18 | url | url.Url | Represents the url of the page that has been displayed.
Only applicable if eventType is VIEW.
| optional | |
| 19 | renderedComponents | list<string> | If populated, contains information about the components present on the view.
Only applicable if eventType is VIEW.
| optional | |
| 20 | componentEvent | componentevent.ComponentEvent | If populated, this event includes data about components
| optional | |
| 21 | acquisition | acquisition.Acquisition | If populated, this event includes data about an acquisition
| optional | |
| 23 | inPageClick | inpageclick.InPageClick | If populated, this event includes data about a click that did not result in a page transition
| optional | |