Skip to content

messaging-system

User-facing views related to document namespace messaging-system; see https://github.com/mozilla-services/mozilla-pipeline-schemas/tree/generated-schemas/schemas/messaging-system

Source Directory

cfr

Historical Pings for messaging-system/cfr

messaging_system.cfr

A historical view of pings sent for the messaging-system/cfr document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
bucket_id String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
impression_id A UUID representing this user. Note that it's not client_id, nor can it be used to link to a client_id String Yes
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
profile_creation_date Integer Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
shield_id [DEPRECATED]: use `experiments` instead. A semicolon separated string to store a list of Shield study IDs String Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
source Added to reduce validation exceptions: see #1787882 String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable cfr_v1

Source Directory | View Definition | Metadata File


cfr_exact_mau28_by_dimensions

Cfr Exact Mau28 By Dimensions

messaging_system.cfr_exact_mau28_by_dimensions

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
release_channel String Yes
country String Yes
country_name String Yes
locale String Yes
version String Yes
mau Integer Yes
wau Integer Yes
dau Integer Yes
whats_new_mau Integer Yes
whats_new_wau Integer Yes
whats_new_dau Integer Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived cfr_exact_mau28_by_dimensions_v1

Source Directory | View Definition | Metadata File


cfr_users_daily

Cfr Users Daily

messaging_system.cfr_users_daily

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
impression_id String Yes
client_id String Yes
seen_whats_new Boolean Yes
release_channel String Yes
locale String Yes
country String Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived cfr_users_daily_v1

Source Directory | View Definition | Metadata File


cfr_users_last_seen

Cfr Users Last Seen

messaging_system.cfr_users_last_seen

Please provide a description for the query

Schema
Column Description Type Nullable
days_since_seen Integer Yes
days_since_seen_whats_new Integer Yes
days_seen_bits Integer Yes
days_seen_whats_new_bits Integer Yes
submission_date Date Yes
impression_id String Yes
client_id String Yes
seen_whats_new Boolean Yes
release_channel String Yes
locale String Yes
country String Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived cfr_users_last_seen_v1

Source Directory | View Definition | Metadata File


event_types

Event Types

messaging_system.event_types

Please provide a description for the query

Schema
Column Description Type Nullable
category String Yes
event String Yes
first_timestamp Timestamp Yes
numeric_index Integer Yes
index String Yes
event_properties Record No
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived event_types_v1

Source Directory | View Definition | Metadata File


events_daily

Events Daily

messaging_system.events_daily

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
client_id String Yes
sample_id Integer Yes
events String Yes
app_version String Yes
os String Yes
addon_version String Yes
locale String Yes
normalized_channel String Yes
city String Yes
country String Yes
subdivision1 String Yes
experiments Record No
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived events_daily_v1

Source Directory | View Definition | Metadata File


infobar

Historical Pings for messaging-system/infobar

messaging_system.infobar

A historical view of pings sent for the messaging-system/infobar document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
browser_session_id A mirror of the browser sessionId, as defined in https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/schemas/telemetry/main/main.4.schema.json String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable infobar_v1

Source Directory | View Definition | Metadata File


moments

Historical Pings for messaging-system/moments

messaging_system.moments

A historical view of pings sent for the messaging-system/moments document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
bucket_id String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
impression_id A UUID representing this user. Note that it's not client_id, nor can it be used to link to a client_id String Yes
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
profile_creation_date Integer Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable moments_v1

Source Directory | View Definition | Metadata File


onboarding

Historical Pings for messaging-system/onboarding

messaging_system.onboarding

A historical view of pings sent for the messaging-system/onboarding document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
profile_creation_date Integer Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
shield_id [DEPRECATED]: use `experiments` instead. A semicolon separated string to store a list of Shield study IDs String Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
browser_session_id A mirror of the browser sessionId, as defined in https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/schemas/telemetry/main/main.4.schema.json String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
attribution Record Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable onboarding_v1

Source Directory | View Definition | Metadata File


onboarding_exact_mau28_by_dimensions

Onboarding Exact Mau28 By Dimensions

messaging_system.onboarding_exact_mau28_by_dimensions

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
release_channel String Yes
country String Yes
country_name String Yes
locale String Yes
version String Yes
mau Integer Yes
wau Integer Yes
dau Integer Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived onboarding_exact_mau28_by_dimensions_v1

Source Directory | View Definition | Metadata File


onboarding_users_daily

Onboarding Users Daily

messaging_system.onboarding_users_daily

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
client_id String Yes
release_channel String Yes
locale String Yes
country String Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived onboarding_users_daily_v1

Source Directory | View Definition | Metadata File


onboarding_users_last_seen

Onboarding Users Last Seen

messaging_system.onboarding_users_last_seen

Please provide a description for the query

Schema
Column Description Type Nullable
days_since_seen Integer Yes
days_seen_bits Integer Yes
submission_date Date Yes
client_id String Yes
release_channel String Yes
locale String Yes
country String Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived onboarding_users_last_seen_v1

Source Directory | View Definition | Metadata File


personalization_experiment

Historical Pings for messaging-system/personalization-experiment

messaging_system.personalization_experiment

A historical view of pings sent for the messaging-system/personalization-experiment document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
boolean_client_context_features Record Yes
client_context_features Record Yes
document_id The document ID specified in the URI when the client sent this message String Yes
features_array_used_in_score_computation Float No
impression_id String Yes
metadata Record Yes
model_version Float Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
study_addon_version String Yes
study_variation String Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable personalization_experiment_v1

Source Directory | View Definition | Metadata File


snippets

Historical Pings for messaging-system/snippets

messaging_system.snippets

A historical view of pings sent for the messaging-system/snippets document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
profile_creation_date Integer Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
shield_id [DEPRECATED]: use `experiments` instead. A semicolon separated string to store a list of Shield study IDs String Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
source A string describing the source of this event String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable snippets_v1

Source Directory | View Definition | Metadata File


snippets_exact_mau28_by_dimensions

Snippets Exact Mau28 By Dimensions

messaging_system.snippets_exact_mau28_by_dimensions

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
release_channel String Yes
country String Yes
country_name String Yes
locale String Yes
version String Yes
mau Integer Yes
wau Integer Yes
dau Integer Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived snippets_exact_mau28_by_dimensions_v1

Source Directory | View Definition | Metadata File


snippets_users_daily

Snippets Users Daily

messaging_system.snippets_users_daily

Please provide a description for the query

Schema
Column Description Type Nullable
submission_date Date Yes
client_id String Yes
release_channel String Yes
locale String Yes
country String Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived snippets_users_daily_v1

Source Directory | View Definition | Metadata File


snippets_users_last_seen

Snippets Users Last Seen

messaging_system.snippets_users_last_seen

Please provide a description for the query

Schema
Column Description Type Nullable
days_since_seen Integer Yes
days_seen_bits Integer Yes
submission_date Date Yes
client_id String Yes
release_channel String Yes
locale String Yes
country String Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_derived snippets_users_last_seen_v1

Source Directory | View Definition | Metadata File


spotlight

Historical Pings for messaging-system/spotlight

messaging_system.spotlight

A historical view of pings sent for the messaging-system/spotlight document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
browser_session_id A mirror of the browser sessionId, as defined in https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/schemas/telemetry/main/main.4.schema.json String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable spotlight_v1

Source Directory | View Definition | Metadata File


undesired_events

Historical Pings for messaging-system/undesired-events

messaging_system.undesired_events

A historical view of pings sent for the messaging-system/undesired-events document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
impression_id A UUID representing this user. Note that it's not client_id, nor can it be used to link to a client_id String Yes
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
profile_creation_date Integer Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
shield_id [DEPRECATED]: use `experiments` instead. A semicolon separated string to store a list of Shield study IDs String Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable undesired_events_v1

Source Directory | View Definition | Metadata File


whats_new_panel

Historical Pings for messaging-system/whats-new-panel

messaging_system.whats_new_panel

A historical view of pings sent for the messaging-system/whats-new-panel document type.

This view is guaranteed to contain only complete days (per submission_timestamp) and to contain only one row per distinct document_id within a given date.

Clustering fields: normalized_channel, sample_id

Schema
Column Description Type Nullable
additional_properties A JSON string containing any payload properties not present in the schema String Yes
addon_version String Yes
client_id String Yes
document_id The document ID specified in the URI when the client sent this message String Yes
event An event identifier String Yes
event_context A string that describes the context about this event String Yes
experiments An object to record all active experiments, experiments IDs are stored as keys, and the value object stores the branch information. Example: {"experiment_1": {"branch": "control"}, "experiment_2": {"branch": "treatment"}}. This deprecates the "shield_id" used in activity-stream and messaging-system. Record No
locale String Yes
message_id String Yes
metadata Record Yes
normalized_app_name Set to "Other" if this message contained an unrecognized app name String Yes
normalized_channel Set to "Other" if this message contained an unrecognized channel name String Yes
normalized_country_code An ISO 3166-1 alpha-2 country code String Yes
normalized_os Set to "Other" if this message contained an unrecognized OS name String Yes
normalized_os_version String Yes
profile_creation_date Integer Yes
release_channel String Yes
sample_id Hashed version of client_id (if present) useful for partitioning; ranges from 0 to 99 Integer Yes
submission_timestamp Time when the ingestion edge server accepted this message Timestamp Yes
version String Yes
browser_session_id A mirror of the browser sessionId, as defined in https://github.com/mozilla-services/mozilla-pipeline-schemas/blob/main/schemas/telemetry/main/main.4.schema.json String Yes
Referenced Tables
Project Dataset Table
moz-fx-data-shared-prod messaging_system_stable whats_new_panel_v1

Source Directory | View Definition | Metadata File