Skip to content

Updates for CITP Pioneer study schema #634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Oct 29, 2020
Merged

Updates for CITP Pioneer study schema #634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8ae1b94
schema and test data for CITP's Pioneer study, fails test of bq_metad…
akohlbre Oct 22, 2020
fe69104
add defaults, and prettify
akohlbre Oct 22, 2020
a0863ac
number -> integer
akohlbre Oct 22, 2020
c5fb6c6
add deletion and enrollment schemas from pioneer-debug
akohlbre Oct 22, 2020
cf9bd99
add forgotten toplevel schemas
akohlbre Oct 22, 2020
72b6b97
namespace rename to pioneer-citp-news-disinfo, and ping to measurements
akohlbre Oct 23, 2020
c5d91d5
add schema field for reporting generated survey id
akohlbre Oct 28, 2020
2fc0a8e
add field to pioneer-citp measurements
akohlbre Oct 29, 2020
b926634
add schema field for reporting generated survey id
akohlbre Oct 28, 2020
bc44cf7
add field to pioneer-citp measurements
akohlbre Oct 29, 2020
d726770
Merge branch 'master' of github.com:akohlbre/mozilla-pipeline-schemas
akohlbre Oct 29, 2020
afd7242
deprecate and replace old field, add description for survey id field
akohlbre Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 13 additions & 23 deletions schemas/pioneer-citp-news-disinfo/measurements/measurements.1.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@
"additionalProperties": false,
"properties": {
"dayOfWeek": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"destinationDomain": {
Expand All @@ -34,9 +32,6 @@
"type": "string"
},
"timeOfDay": {
"maximum": 20,
"minimum": 0,
"multipleOf": 4,
"type": "integer"
}
},
Expand Down Expand Up @@ -77,8 +72,6 @@
"additionalProperties": false,
"properties": {
"dayOfWeek": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"laterSharedCount": {
Expand All @@ -88,8 +81,6 @@
"type": "integer"
},
"pageCategory": {
"maximum": 2,
"minimum": 0,
"type": "integer"
},
"prevExposedCount": {
Expand All @@ -99,9 +90,6 @@
"type": "string"
},
"timeOfDay": {
"maximum": 20,
"minimum": 0,
"multipleOf": 4,
"type": "integer"
},
"totalAttention": {
Expand Down Expand Up @@ -148,21 +136,16 @@
"audience": {
"enum": [
"public",
"restricted"
"restricted",
"unknown"
],
"type": "string"
},
"classification": {
"enum": [
"pol news",
"nonpol news",
"other"
],
"description": "deprecated, use pageClassification",
"type": "string"
},
"dayOfWeek": {
"maximum": 6,
"minimum": 0,
"type": "integer"
},
"domain": {
Expand All @@ -171,11 +154,14 @@
"numShares": {
"type": "integer"
},
"pageClassification": {
"type": "integer"
},
"timeOfDay": {
"maximum": 20,
"minimum": 0,
"multipleOf": 4,
"type": "integer"
},
"visitReferrer": {
"type": "string"
}
},
"type": "object"
Expand All @@ -189,6 +175,10 @@
}
},
"type": "object"
},
"WebScience.SurveyId": {
"description": "ID sent to Qualtrics, for associating survey responses with telemetry data",
"type": "string"
Copy link
Contributor

@acmiyaguchi acmiyaguchi Oct 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good practice to document the use of this field using the description property, which will get inserted into the BigQuery schema.

}
},
"type": "object"
Expand Down
53 changes: 16 additions & 37 deletions templates/pioneer-citp-news-disinfo/measurements/measurements.1.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"WebScience.SurveyId": {
"type": "string",
"description": "ID sent to Qualtrics, for associating survey responses with telemetry data"
},
"WebScience.Measurements.PageNavigation": {
"type": "object",
"properties": {
Expand All @@ -19,22 +23,9 @@
"type": "object",
"properties": {
"referrerDomain": { "type": "string" },
"dayOfWeek": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"timeOfDay": {
"type": "integer",
"multipleOf": 4,
"minimum": 0,
"maximum": 20
},
"pageCategory": {
"type": "integer",
"minimum": 0,
"maximum": 2
},
"dayOfWeek": { "type": "integer" },
"timeOfDay": { "type": "integer" },
"pageCategory": { "type": "integer" },
"numVisits": { "type": "integer" },
"totalAttention": { "type": "integer" },
"totalScroll": { "type": "integer" },
Expand Down Expand Up @@ -71,25 +62,18 @@
"properties": {
"domain": { "type": "string" },
"classification": {
"type": "string",
"enum": ["pol news", "nonpol news", "other"]
"type": "string",
"description": "deprecated, use pageClassification"
},
"pageClassification": { "type": "integer"},
"visitReferrer": { "type": "string" },
"audience": {
"type": "string",
"enum": ["public", "restricted"]
"enum": ["public", "restricted", "unknown"]
},
"numShares": { "type": "integer" },
"dayOfWeek": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"timeOfDay": {
"type": "integer",
"minimum": 0,
"maximum": 20,
"multipleOf": 4
}
"dayOfWeek": { "type": "integer" },
"timeOfDay": { "type": "integer" }
},
"additionalProperties": false
}
Expand All @@ -116,13 +100,8 @@
"properties": {
"sourceDomain": { "type": "string" },
"destinationDomain": { "type": "string" },
"dayOfWeek": { "type": "integer", "minimum": 0, "maximum": 6 },
"timeOfDay": {
"type": "integer",
"multipleOf": 4,
"minimum": 0,
"maximum": 20
},
"dayOfWeek": { "type": "integer" },
"timeOfDay": { "type": "integer" },
"numExposures": { "type": "integer" },
"laterSharedCount": { "type": "integer" },
"laterVisitedCount": { "type": "integer" }
Expand Down
10 changes: 7 additions & 3 deletions validation/pioneer-citp-news-disinfo/measurements.1.sample.pass.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"WebScience.SurveyId": "f85b22d6-b0a6-419f-820a-75f28c1a8af3",
"WebScience.Measurements.PageNavigation": {
"numUntrackedVisits": 500,
"trackedVisitsByDomain": [
Expand Down Expand Up @@ -30,16 +31,18 @@
"trackedShares": [
{
"domain": "nytimes.com",
"classification": "pol news",
"pageClassification": 0,
"audience": "public",
"visitReferrer": "google.com",
"numShares": 5,
"dayOfWeek": 2,
"timeOfDay": 20
},
{
"domain": "nytimes.com",
"classification": "nonpol news",
"pageClassification": 1,
"audience": "restricted",
"visitReferrer": "google.com",
"numShares": 3,
"dayOfWeek": 2,
"timeOfDay": 20
Expand All @@ -52,7 +55,8 @@
"trackedShares": [
{
"domain": "nytimes.com",
"classification": "other",
"pageClassification": 2,
"visitReferrer": "google.com",
"audience": "public",
"numShares": 2,
"dayOfWeek": 2,
Expand Down