Activity Stream
User-facing views related to document namespace activity-stream; see https://github.com/mozilla-services/mozilla-pipeline-schemas/tree/generated-schemas/schemas/activity-stream
events
Historical Pings for activity-stream/events
activity_stream.events
A historical view of pings sent for the
activity-stream/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
| Column | Description | Type | Nullable |
|---|---|---|---|
| action_position | A zero based integer indicating the position of this event | Integer | Yes |
| 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 |
| locale | 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 | |
| page | String | Yes | |
| profile_creation_date | Integer | Yes | |
| region | 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 |
| session_id | A UUID representing an Activity Stream session. This can be used to do table joins between `sessions` and `events` in Activity Stream. Note that `n/a` denotes that the session is not applicable in the context. | String | Yes |
| shield_id | [DEPRECATED]: use `experiments` instead. A semicolon separated string to store a list of Shield study IDs | String | Yes |
| source | String | Yes | |
| submission_timestamp | Time when the ingestion edge server accepted this message | Timestamp | Yes |
| user_prefs | An encoded integer representing user's preferences of Activity Stream | Integer | Yes |
| value | A string that describes the context about this event | String | 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 |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_stable | events_v1 |
Source Directory | View Definition | Metadata File
impression_stats
Historical Pings for activity-stream/impression-stats
activity_stream.impression_stats
A historical view of pings sent for the
activity-stream/impression-stats
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
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_stable | impression_stats_v1 |
Source Directory | View Definition | Metadata File
impression_stats_by_experiment
Impression Stats By Experiment
activity_stream.impression_stats_by_experiment
Please provide a description for the query
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_bi | impression_stats_by_experiment_v1 |
| moz-fx-data-shared-prod | spoc_tile_ids |
Source Directory | View Definition | Metadata File
impression_stats_flat
Impression Stats Flat
activity_stream.impression_stats_flat
Please provide a description for the query
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_bi | impression_stats_flat_v1 |
| moz-fx-data-shared-prod | spoc_tile_ids |
Source Directory | View Definition | Metadata File
on_save_recs
Historical Pings for activity-stream/on-save-recs
activity_stream.on_save_recs
A historical view of pings sent for the
activity-stream/on-save-recs
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
| Column | Description | Type | Nullable |
|---|---|---|---|
| additional_properties | A JSON string containing any payload properties not present in the schema | String | Yes |
| document_id | The document ID specified in the URI when the client sent this message | String | Yes |
| events | Record | No | |
| 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 | |
| metadata | Record | Yes | |
| model | An identifier for the machine learning model used to generate the recommendations | String | 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 |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_stable | on_save_recs_v1 |
Source Directory | View Definition | Metadata File
pocket_button
Historical Pings for activity-stream/pocket-button
activity_stream.pocket_button
A historical view of pings sent for the
activity-stream/pocket-button
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
| Column | Description | Type | Nullable |
|---|---|---|---|
| additional_properties | A JSON string containing any payload properties not present in the schema | String | Yes |
| document_id | The document ID specified in the URI when the client sent this message | String | Yes |
| events | Record | No | |
| 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 | |
| metadata | Record | Yes | |
| model | (In the case of actions related to on-save recs) An identifier for the machine learning model used to generate the recommendations. | String | 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 | |
| pocket_logged_in_status | A boolean for whether the user was logged-in to the Pocket Firefox integration when they performed the indicated action(s). True = logged in. | Boolean | 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 |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_stable | pocket_button_v1 |
Source Directory | View Definition | Metadata File
sessions
Historical Pings for activity-stream/sessions
activity_stream.sessions
A historical view of pings sent for the
activity-stream/sessions
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
| 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 |
| locale | 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 | |
| page | String | Yes | |
| perf | Record | Yes | |
| profile_creation_date | Profile age in days since Unix epoch | 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 |
| session_duration | The duration of this session in milliseconds. The session begins at `perf.visibility_event_rcvd_ts` and ends when the page is navigated away | Integer | Yes |
| session_id | A UUID representing an Activity Stream session. This can be used to do table joins between `sessions` and `events` in Activity Stream. Note that `n/a` denotes that the session is not applicable in the context. | String | 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 |
| user_prefs | An encoded integer representing user's preferences of Activity Stream | Integer | 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 |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_stable | sessions_v1 |
Source Directory | View Definition | Metadata File
spoc_fills
Historical Pings for activity-stream/spoc-fills
activity_stream.spoc_fills
A historical view of pings sent for the
activity-stream/spoc-fills
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
| 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 |
| 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 | |
| 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 |
| shield_id | [DEPRECATED]: use `experiments` instead. A semicolon separated string to store a list of Shield study IDs | String | Yes |
| spoc_fills | Record | No | |
| 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 |
| Project | Dataset | Table |
|---|---|---|
| moz-fx-data-shared-prod | activity_stream_stable | spoc_fills_v1 |
Source Directory | View Definition | Metadata File
tile_id_types
Tile Id Types
activity_stream.tile_id_types
Please provide a description for the query
| Column | Description | Type | Nullable |
|---|---|---|---|
| tile_id | Integer | Yes | |
| type | String | Yes |
| Project | Dataset | Table |
|---|---|---|
| pocket-tiles | pocket_tiles_data | tile_id_types |
Source Directory | View Definition | Metadata File