Skip to content
This repository has been archived by the owner on Jun 23, 2023. It is now read-only.

Latest commit

 

History

History
214 lines (199 loc) · 8.22 KB

analytics-submission.md

File metadata and controls

214 lines (199 loc) · 8.22 KB

Daily Analytics Submission

API Pattern: Submission

HTTP Request and Response

  • Submit Mobile Analytics: POST https://<FQDN>/submission/mobile-analytics

Parameters

  • FQDN: Target-environment specific CNAME of the Mobile Submission CloudFront distribution
  • Authorization required and signatures NOT provided - see API security
  • Extensibility: new Key-Value Pairs can be added to the request without breaking request processing

Scenario

Mobile clients collect and send app analytics periodically (roughly once per 24h) to the backend.

Submit Mobile Analytics

iOS Request Payload Example

{
  "metadata" : {
    "operatingSystemVersion" : "iPhone OS 13.5.1 (17F80)",
    "latestApplicationVersion" : "3.0",
    "deviceModel" : "iPhone11,2",
    "postalDistrict" : "A1",
    "localAuthority" : "E09000012"
  },
  "analyticsWindow" : {
    "endDate" : "2020-07-28T22:59:00Z",
    "startDate" : "2020-07-27T23:00:00Z"
  },
  "metrics" : {
    "cumulativeDownloadBytes": 1,
    "cumulativeUploadBytes": 1,
    "cumulativeCellularDownloadBytes": 1,
    "cumulativeCellularUploadBytes": 1,
    "cumulativeWifiDownloadBytes": 1,
    "cumulativeWifiUploadBytes": 1,
    "receivedVoidTestResult": 1,
    "isIsolatingBackgroundTick": 1,
    "receivedPositiveTestResult": 1,
    "receivedNegativeTestResult": 1,
    "encounterDetectionPausedBackgroundTick": 1,
    "totalBackgroundTasks": 1,
    "runningNormallyBackgroundTick": 1,
    "completedOnboarding": 1,
    "receivedVoidTestResultEnteredManually": 1,
    "receivedPositiveTestResultEnteredManually": 1,
    "receivedNegativeTestResultEnteredManually": 1,
    "receivedVoidTestResultViaPolling": 1,
    "receivedPositiveTestResultViaPolling": 1,
    "receivedNegativeTestResultViaPolling": 1,
    "isIsolatingForTestedPositiveBackgroundTick": 1,
    "receivedRiskyContactNotification": 1,
    "startedIsolation": 1,
    "receivedActiveIpcToken": 1,
    "haveActiveIpcTokenBackgroundTick": 1,
    "selectedIsolationPaymentsButton": 1,
    "launchedIsolationPaymentsApplication": 1,
    "receivedPositiveLFDTestResultEnteredManually": 1,
    "isIsolatingForTestedLFDPositiveBackgroundTick": 1,
    "totalExposureWindowsNotConsideredRisky": 1,
    "totalExposureWindowsConsideredRisky": 1,
    "hasRiskyContactNotificationsEnabledBackgroundTick": 1,
    "totalRiskyContactReminderNotifications": 1,
    "receivedUnconfirmedPositiveTestResult": 1,
    "isIsolatingForUnconfirmedTestBackgroundTick": 1,
    "launchedTestOrdering": 1,
    "didHaveSymptomsBeforeReceivedTestResult": 1,
    "didRememberOnsetSymptomsDateBeforeReceivedTestResult": 1,
    "receivedPositiveSelfRapidTestResultEnteredManually": 1,
    "isIsolatingForTestedSelfRapidPositiveBackgroundTick": 1,
    "totalAlarmManagerBackgroundTasks": 1,
    "missingPacketsLast7Days": 1,
    "askedToShareExposureKeysInTheInitialFlow": 1,
    "consentedToShareExposureKeysInTheInitialFlow": 1,
    "totalShareExposureKeysReminderNotifications": 1,
    "consentedToShareExposureKeysInReminderScreen": 1,
    "successfullySharedExposureKeys": 1,
    "didSendLocalInfoNotification": 1,
    "didAccessLocalInfoScreenViaNotification": 1,
    "didAccessLocalInfoScreenViaBanner":  1,
    "isDisplayingLocalInfoBackgroundTick": 1,
    "positiveLabResultAfterPositiveLFD": 1,
    "negativeLabResultAfterPositiveLFDWithinTimeLimit": 1,
    "negativeLabResultAfterPositiveLFDOutsideTimeLimit": 1,
    "positiveLabResultAfterPositiveSelfRapidTest": 1,
    "negativeLabResultAfterPositiveSelfRapidTestWithinTimeLimit": 1,
    "negativeLabResultAfterPositiveSelfRapidTestOutsideTimeLimit": 1,
    "optedOutForContactIsolation": 1,
    "optedOutForContactIsolationBackgroundTick": 1,
    "appIsUsableBackgroundTick": 1,
    "appIsContactTraceableBackgroundTick": 1,
    "appIsUsableBluetoothOffBackgroundTick": 1,
    "completedV2SymptomsQuestionnaire": 1,
    "completedV2SymptomsQuestionnaireAndStayAtHome": 1
  },
  "includesMultipleApplicationVersions" : false
}

Android Request Payload Example

{
  "metadata" : {
    "operatingSystemVersion" : "29",
    "latestApplicationVersion" : "3.0",
    "deviceModel" : "HUAWEI LDN-L21",
    "postalDistrict" : "A1",
    "localAuthority" : "E09000012"
  },
  "analyticsWindow" : {
    "endDate" : "2020-07-28T22:59:00Z",
    "startDate" : "2020-07-27T23:00:00Z"
  },
  "metrics" : {
    "cumulativeDownloadBytes": 1,
    "cumulativeUploadBytes": 1,
    "receivedVoidTestResult": 1,
    "isIsolatingBackgroundTick": 1,
    "receivedPositiveTestResult": 1,
    "receivedNegativeTestResult": 1,
    "encounterDetectionPausedBackgroundTick": 1,
    "totalBackgroundTasks": 1,
    "runningNormallyBackgroundTick": 1,
    "completedOnboarding": 1,
    "receivedVoidTestResultEnteredManually": 1,
    "receivedPositiveTestResultEnteredManually": 1,
    "receivedNegativeTestResultEnteredManually": 1,
    "receivedVoidTestResultViaPolling": 1,
    "receivedPositiveTestResultViaPolling": 1,
    "receivedNegativeTestResultViaPolling": 1,
    "isIsolatingForTestedPositiveBackgroundTick": 1,
    "receivedRiskyContactNotification": 1,
    "startedIsolation": 1,
    "receivedActiveIpcToken": 1,
    "haveActiveIpcTokenBackgroundTick": 1,
    "selectedIsolationPaymentsButton": 1,
    "launchedIsolationPaymentsApplication": 1,
    "receivedPositiveLFDTestResultEnteredManually": 1,
    "isIsolatingForTestedLFDPositiveBackgroundTick": 1,
    "totalExposureWindowsNotConsideredRisky": 1,
    "totalExposureWindowsConsideredRisky": 1,
    "hasRiskyContactNotificationsEnabledBackgroundTick": 1,
    "totalRiskyContactReminderNotifications": 1,
    "receivedUnconfirmedPositiveTestResult": 1,
    "isIsolatingForUnconfirmedTestBackgroundTick": 1,
    "launchedTestOrdering": 1,
    "didHaveSymptomsBeforeReceivedTestResult": 1,
    "didRememberOnsetSymptomsDateBeforeReceivedTestResult": 1,
    "receivedPositiveSelfRapidTestResultEnteredManually": 1,
    "isIsolatingForTestedSelfRapidPositiveBackgroundTick": 1,
    "totalAlarmManagerBackgroundTasks": 1,
    "missingPacketsLast7Days": 1,
    "askedToShareExposureKeysInTheInitialFlow": 1,
    "consentedToShareExposureKeysInTheInitialFlow": 1,
    "totalShareExposureKeysReminderNotifications": 1,
    "consentedToShareExposureKeysInReminderScreen": 1,
    "successfullySharedExposureKeys": 1,
    "didSendLocalInfoNotification": 1,
    "didAccessLocalInfoScreenViaNotification": 1,
    "didAccessLocalInfoScreenViaBanner":  1,
    "isDisplayingLocalInfoBackgroundTick": 1,
    "positiveLabResultAfterPositiveLFD": 1,
    "negativeLabResultAfterPositiveLFDWithinTimeLimit": 1,
    "negativeLabResultAfterPositiveLFDOutsideTimeLimit": 1,
    "positiveLabResultAfterPositiveSelfRapidTest": 1,
    "negativeLabResultAfterPositiveSelfRapidTestWithinTimeLimit": 1,
    "negativeLabResultAfterPositiveSelfRapidTestOutsideTimeLimit": 1,
    "optedOutForContactIsolation": 1,
    "optedOutForContactIsolationBackgroundTick": 1,
    "appIsUsableBackgroundTick": 1,
    "appIsContactTraceableBackgroundTick": 1,
    "appIsUsableBluetoothOffBackgroundTick": 1,
    "completedV2SymptomsQuestionnaire": 1,
    "completedV2SymptomsQuestionnaireAndStayAtHome": 1
  },
  "includesMultipleApplicationVersions" : false
}

Validation

  • date & time in ISO-8601 YYYY-MM-DD'T'hh:mm:ssZ format
  • All fields under metadata and analyticsWindow are mandatory except the following:
    • localAuthority
  • All fields under metrics are optional except the following:
    • completedOnboarding
    • encounterDetectionPausedBackgroundTick
    • isIsolatingBackgroundTick
    • receivedNegativeTestResult
    • receivedPositiveTestResult
    • receivedVoidTestResult
    • runningNormallyBackgroundTick
    • totalBackgroundTasks
  • The following fields are optional, but are only expected from iOS devices
    • cumulativeCellularDownloadBytes
    • cumulativeCellularUploadBytes
    • cumulativeWifiDownloadBytes
    • cumulativeWifiUploadBytes

HTTP Response Codes

Status Code Description
200 OK Submission processed
400 Bad Request Bad request could not process payload

##Notes

To preserve user privacy, smaller postal districts in analytics submissions are aggregated before persisting and forwarding. See Privacy Filtering.