| Key | Field | Type | Description | Requiredness | Default value |
| 1 | url | url.Url | Web: The "raw" value in here is the value of
document.referrer as reported by the browser
Native app: If this is populated, we will use it.
If it is not populated, it will be synthesised using
the nativeAppSource field.
| optional | |
| 4 | component | string | the component that was clicked on for this referral,
if the previous page was served by the guardian
| optional | |
| 10 | linkName | link.LinkName | The link name associated with the element clicked.
| optional | |
| 5 | platform | platform.Platform | the platform of the referrer,
if the previous page was served by the guardian
| optional | |
| 6 | viewId | string | the viewId of the referrer,
if the previous page was served by the guardian
| optional | |
| 7 | email | string | if this was from a guardian email, what email it was
| optional | |
| 8 | nativeAppSource | source.Source | If this referral was from a native app, the source of the referral
| optional | |
| 9 | google | googlereferral.GoogleReferral | If this referral was from google, and we have additional data on the query string,
the values we got.
| optional | |
| 11 | tagIdFollowed | string | | optional | |
| 12 | appReferral | AppReferral | | optional | |
| 13 | capiId | string | The Guardian Content API (CAPI) Id of the referring content. Uniquely identifies Content, even if its URL is
updated. Changing a content's url is generally avoided, but may be done for SEO reasons (eg Coronavirus explainer).
See also 'Evolving URLs': https://docs.google.com/document/d/1s6xsGHcQOgdPBTbGYwqTXuCz90e3lHKOnkBFW6yCvqY/edit#
| optional | |