Reference

analytics.conf_namespace

  • namespace

Configuration settings related to Namespaces.

Layer: Core Dataset
Category: Configuration
Status: Published

Primary Key: env, env_namespace
Other Unique Key(s): env_namespace
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = conf_namespace.env_namespace;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.

analytics.conf_retailer

  • namespace
  • retailer

Configuration settings related to Retailers.

Layer: Core Dataset
Category: Configuration
Status: Published

Primary Key: env_namespace, retailer_id
Other Unique Key(s): None
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = conf_retailer.env_namespace;
dim_retailer on dim_retailer.env_namespace = conf_retailer.env_namespace and dim_retailer.retailer_id = conf_retailer.retailer_id and dim_retailer.is_current;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
global_suppress_flagSTRINGFlag to indicate Retailer is to be excluded from reporting (eg test data).
ads_requested_capNUMERICMax number of Product Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed).
reserved_search_termsSTRINGNot in use.
period_start_dateSTRINGNot in use.
banner_ads_requested_capNUMERICMax number of Banner Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed).
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution.
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
attribution_time_frameNUMERICDetermines how many days of attribution results should be stored for the first model.
attribution_time_frame_2NUMERICDetermines how many days of attribution results should be stored for the second model.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.

analytics.conf_supplier

  • namespace

Configuration settings related to Suppliers.

Layer: Core Dataset
Category: Configuration
Status: Published

Primary Key: env_namespace, supplier_id
Other Unique Key(s): None
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = conf_supplier.env_namespace;
dim_supplier on dim_supplier.env_namespace = conf_supplier.env_namespace and dim_supplier.supplier_id = conf_supplier.supplier_id and dim_supplier.is_current;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.

analytics.currency_aud

  • namespace
  • retailer

Current conversion rates between the base currency (AUD) to other common currencies. ISO 4217 currency codes used.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: currency
Other Unique Key(s): None
Partition: None

Foreign Key(s):
None

Column NameData TypeDescription
currencySTRINGCurrency being converted (ISO 4217 currency code).
valueFLOATConversion rate to apply.
baseSTRINGCurrency being converted into (AUD).

analytics.currency_usd

  • namespace
  • retailer

Current conversion rates between the base currency (USD) to other common currencies. ISO 4217 currency codes used.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: currency
Other Unique Key(s): None
Partition: None

Foreign Key(s):
None

Column NameData TypeDescription
currencySTRINGCurrency being converted (ISO 4217 currency code).
valueFLOATConversion rate to apply.
baseSTRINGCurrency being converted into (USD).

analytics.dim_campaign

  • namespace
  • retailer

Campaign master data dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: campaign_id, row_version, env_namespace
Other Unique Key(s): campaign_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_campaign.env_namespace;
dim_placement on dim_placement.env_namespace = dim_campaign.env_namespace and dim_placement.placement_id = dim_campaign.placement_id;
dim_team on dim_team.env_namespace = dim_campaign.env_namespace and dim_team.team_id = dim_campaign.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = dim_campaign.env_namespace and dim_wallet.wallet_id = dim_campaign.wallet_id;
dim_catalog on dim_catalog.env_namespace = dim_campaign.env_namespace and dim_catalog.catalog_id = dim_campaign.first_catalog_id and dim_catalog.is_current;

Column NameData TypeDescription
campaign_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
placement_idSTRINGInternal identifier of the Placement (from the source system).
first_catalog_idSTRINGFirst Catalog id.
campaign_nameSTRINGName of the Campaign.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_start_date_utcTIMESTAMPCurrently the same as campaign_start_date since all data is in UTC.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_end_date_utcTIMESTAMPCurrently the same as campaign_end_date since all data is in UTC.
valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
is_ftaSTRINGFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
catalog_idsSTRINGCatalog ids.
search_termsSTRINGComma separated list of SearchTerms targeted by the Campaign.
has_search_termsBOOLEANFlag to indicate if the Campaign is targeting SearchTerms.
catalog_productsSTRINGThe Catalog's Products within the Campaign.
placementsSTRINGThe Campaign's selected Placement.
currency_codeSTRINGISO 4217 currency code
fta_costNUMERICTotal amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign.
max_cost_per_clickNUMERICThe maximum cost per click set for the Campaign.
max_total_spendNUMERICThe maximum total spend set for the Campaign.
max_daily_spendNUMERICThe maximum daily spend set for the Campaign.
impression_goalNUMERICThe maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend.
total_spendNUMERICTotal AdSpend to date for the Campaign.
retailer_ad_spend_typeSTRINGType of spending if Retailer Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend).
supplier_ad_spend_typeSTRINGType of spending if Supplier Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend).
budgetNUMERICThe Campaign's budget as set by the Campaign's manager.
targeted_filtersSTRINGThe filters selected by an advertiser that their campaign will appear for. Used for fixed tenancy campaigns.
location_filtersSTRINGFilters on the campaign specific to a location if a location filter class is created.
filter_whitelistsSTRINGThe filters selected by an advertiser that the campaign can appear for. The campaign will only appear where eligible regardless of the advertiser's selection.
cross_sell_settingsSTRINGThe cross-sell targeting selection in the campaign.
upsell_settingsSTRINGThe Upsell targeting selection in the campaign if applicable.
categoriesSTRINGComma separated list of Categories targeted by the Campaign.
catalog_countINTEGERNumber of Catalogs being targeted by the Campaign.
last_spend_dateDATEMost recent date that AdSpend was incurred by the Supplier.
product_type_codeSTRINGProduct type code.
namespaceSTRINGName of the Namespace.
user_idSTRINGInternal identifier of the User (from the source system).
user_emailSTRINGUser's email address.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
created_atTIMESTAMPDate the record was created in the source system.
created_at_utcTIMESTAMPCurrently the same as created_at since all data is in UTC.
updated_atTIMESTAMPDate the record was updated in the source system.
updated_at_utcTIMESTAMPCurrently the same as updated_at since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
cta_textSTRINGCTA text.
suggested_search_termsSTRINGSuggested search terms.
has_suggested_search_termsBOOLEANFlag to indicate that any suggested search terms exist.
product_group_listSTRINGThe list of product group ids from Epsilon Digital
targeted_keywordsRECORDSuggested search terms Keywords
has_negative_keywordsBOOLEANFlag to indicate that any negative search terms exist.
negative_keywordsRECORDNegative search terms Keywords
has_keywordsBOOLEANFlag to indicate that any targeted keyword exist.
suggested_keywordsRECORDSuggested Keywords Keywords
targeted_categoriesSTRINGList of Targetted Categories
has_categoriesBOOLEANFlag to indicate that any targeted category exist.
promoted_productsRECORDList of advertised Products
negative_categoriesSTRINGList of Excluded Categories
has_negative_categoriesBOOLEANFlag to indicate that any targeted category exist.

analytics.dim_campaign_attr

  • namespace
  • retailer

Campaign custom attributes (certain retailers only).

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: campaign_id, row_version, env_namespace
Other Unique Key(s): campaign_attr_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_campaign_attr.env_namespace;
dim_campaign on dim_campaign.env_namespace = dim_campaign_attr.env_namespace and dim_campaign.campaign_id = dim_campaign_attr.campaign_id and dim_campaign.row_version = dim_campaign_attr.row_version;

Column NameData TypeDescription
campaign_attr_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
attr1STRINGCampaign user defined attribute value 1.
attr2STRINGCampaign user defined attribute value 2.
attr3STRINGCampaign user defined attribute value 3.
attr4STRINGCampaign user defined attribute value 4.
attr5STRINGCampaign user defined attribute value 5.
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.dim_catalog

  • namespace
  • retailer

Catalog master data dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: catalog_id, row_version
Other Unique Key(s): catalog_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_catalog.env_namespace;
dim_retailer on dim_retailer.env_namespace = dim_catalog.env_namespace and dim_retailer.retailer_id = dim_catalog.retailer_id and dim_retailer.is_current;
currency_aud on currency_aud.currency = dim_catalog.currency_code;
currency_usd on currency_usd.currency = dim_catalog.currency_code;

Column NameData TypeDescription
catalog_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_nameSTRINGName of the Catalog.
currency_codeSTRINGISO 4217 currency code
retailer_nameSTRINGName of the Retailer.
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
is_visibleBOOLEANFlag to indicate if the catalog is visible in the source system.
grace_window_daysNUMERICConfigured grace window lookback period value in days or part thereof.

analytics.dim_category

  • namespace
  • retailer

Category dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: env_namespace, retailer_id, category_id, namespace
Other Unique Key(s): category_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_category.env_namespace;
dim_retailer on dim_retailer.env_namespace = dim_category.env_namespace and dim_retailer.retailer_id = dim_category.retailer_id and dim_retailer.is_current;

Column NameData TypeDescription
category_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
category_idSTRINGCategory being targeted.
namespaceSTRINGName of the Namespace.
category_labelSTRINGLabel for the Category (more descriptive than the typical id provided).
cat_level_1STRINGLevel 1 component of the category_label (delimited by >).
cat_level_2STRINGLevel 2 component of the category_label (delimited by >).
cat_level_3STRINGLevel 3 component of the category_label (delimited by >).
cat_level_4STRINGLevel 4 component of the category_label (delimited by >).
cat_level_5STRINGLevel 5 component of the category_label (delimited by >).
cat_level_6STRINGLevel 6 component of the category_label (delimited by >).
cat_level_7STRINGLevel 7 component of the category_label (delimited by >).
category_label_countINTEGERCount(category_label) across env_namespace, retailer_id, category_id.
source_nameSTRINGSource name.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).

analytics.dim_env_namespace

  • namespace
  • retailer

Namespace dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: env, env_namespace
Other Unique Key(s): env_namespace_key
Partition: None

Foreign Key(s):
None

Column NameData TypeDescription
env_namespace_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
zone_idSTRINGTimezone (TZ) identifier standardised by IANA time zone database.
local_hourNUMERICLocal hour.
enable_okta_loginBOOLEANFlag to indicate if okta login is enabled.
enable_credit_cardBOOLEANFlag to indicate if credit card transactions are enabled.
enabled_spend_typesSTRINGSpend types enabled in the system.
banner_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on banner campaigns.
banner_enable_tracking_tagsBOOLEANFlag to indicate if tracking tags are enabled on banner campaigns.
banner_enable_filter_targetingBOOLEANFlag to indicate if filter targeting is enabled on banner campaigns.
banner_enable_filter_whitelistingBOOLEANFlag to indicate if filter whitelisting is enabled on banner campaigns.
display_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on display campaigns.
display_enable_tracking_tagsBOOLEANFlag to indicate if tracking tags are enabled on display campaigns.
display_enable_filter_targetingBOOLEANFlag to indicate if filter targeting is enabled on display campaigns.
display_enable_filter_whitelistingBOOLEANFlag to indicate if filter whitelisting is enabled on display campaigns.
wildcard_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on wildcard campaigns.
wildcard_enable_tracking_tagsBOOLEANFlag to indicate if tracking tags are enabled on wildcard campaigns.
wildcard_enable_filter_targetingBOOLEANFlag to indicate if filter targeting is enabled on wildcard campaigns.
wildcard_enable_filter_whitelistingBOOLEANFlag to indicate if filter whitelisting is enabled on wildcard campaigns.
brand_page_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on brand page campaigns.
brand_page_enable_tracking_tagsBOOLEANFlag to indicate if tracking tags are enabled on brand page campaigns.
brand_page_enable_filter_targetingBOOLEANFlag to indicate if filter targeting is enabled on brand page campaigns.
brand_page_enable_filter_whitelistingBOOLEANFlag to indicate if filter whitelisting is enabled on brand page campaigns.
shotgun_banner_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on shotgun banner campaigns.
shotgun_banner_enable_tracking_tagsBOOLEANFlag to indicate if tracking tags are enabled on shotgun banner campaigns.
shotgun_banner_enable_filter_targetingBOOLEANFlag to indicate if filter targeting is enabled on shotgun banner campaigns.
shotgun_banner_enable_filter_whitelistingBOOLEANFlag to indicate if filter whitelisting is enabled on shotgun banner campaigns.
disabled_demographicsSTRINGDisabled Demographics.
disabled_economy_levelBOOLEANFlag to indicate if economy level is disabled.
enable_category_min_bidBOOLEANFlag to indicate if category minimum bid is enabled.
include_retailer_t_and_cBOOLEANFlag to indicate if Retailer Terms and Conditions is included.
disabled_strategy_typesSTRINGDisabled Strategy Types.
enable_advanced_reportsBOOLEANFlag to indicate if advanced reports are enabled.
enable_reporting_upc_fixBOOLEANFlag to indicate if reporting UPC fix is enabled.
can_group_products_by_codeBOOLEANFlag to indicate if products can be grouped by code.
default_reporting_periodSTRINGDefault reporting period.
enable_offsite_campaignsBOOLEANFlag to indicate if offsite Campaigns are enabled.
enable_search_term_min_bidBOOLEANFlag to indicate if search term minimum bid is enabled.
enable_campaign_templatesBOOLEANFlag to indicate if Campaign templates is enabled.
enable_language_selectionBOOLEANFlag to indicate if language selection is enabled.
enable_product_tag_managerBOOLEANFlag to indicate if product tag manager is enabled.
enable_daily_spend_rolloverBOOLEANFlag to indicate if daily spend rollover is enabled.
product_metadata_selectionBOOLEANFlag to indicate if metadata selection is enabled.
catalog_selection_reportingBOOLEANFlag to indicate if Catalog selection reporting is enabled.
enable_campaign_duplicationBOOLEANFlag to indicate if campaign duplication is enabled.
enable_powered_by_citrus_iconBOOLEANFlag to indicate if Powered by Citrus is enabled.
enable_retailer_team_managerBOOLEANFlag to indicate if Retailer Team Manager is enabled.
enabled_search_term_measuresSTRINGFlag to indicate if search term measures is enabled.
max_banner_slots_per_campaignINTEGERMaximum banner slots per Campaign.
enable_report_table_filteringBOOLEANFlag to indicate if report table filtering enabled.
enable_supplier_edit_team_infoBOOLEANFlag to indicate if the platform enable Suppliers to edit team info.
disabled_search_term_match_typeBOOLEANFlag to indicate if search term match type is disabled.
enable_search_term_collectionsBOOLEANFlag to indicate if search term collections is enabled.
enable_supplier_wallet_editingBOOLEANFlag to indicate if the platform enables Supplier to edit the wallets.
enable_external_user_managementBOOLEANFlag to indicate if external user management is enabled.
enable_retailer_user_managementBOOLEANFlag to indicate if Retailer user management is enabled.
enable_retailer_wallet_creationBOOLEANFlag to indicate if the platform enables Retailers to create wallets.
enable_supplier_wallet_creationBOOLEANFlag to indicate if the platform enables Supplier to create wallets.
enable_retailer_impression_shareBOOLEANFlag to indicate if Retailer impression share is enabled.
enable_single_campaign_reportingBOOLEANFlag to indicate if single Campaign reporting is enabled.
enable_supplier_impression_shareBOOLEANFlag to indicate if Supplier impression share is enabled.
enable_external_assets_managementBOOLEANFlag to indicate if external assets management is enabled.
enable_retailer_wallet_managementBOOLEANFlag to indicate if Retailer wallet management is enabled.
enable_supplier_wallet_daily_budgetBOOLEANFlag to indicate if Supplier wallet daily budget is enabled.
enable_campaign_media_spend_documentBOOLEANFlag to indicate if Campaign media spend document is enabled.
enable_retailer_campaign_managementBOOLEANFlag to indicate if Retailer Campaign management is enabled.
enable_retailer_wallet_external_id_fieldBOOLEANFlag to indicate if Retailer wallet external ID is enabled.
enable_supplier_wallet_external_id_fieldBOOLEANFlag to indicate if Supplier wallet external ID is enabled.
enable_retailer_restricted_team_creationBOOLEANFlag to indicate if Retailer restricted team creation is enabled.
enable_report_table_filtering_by_product_tagBOOLEANFlag to indicate if report table filtering by product tag is enabled.
enable_retailer_wallet_credit_limit_managementBOOLEANFlag to indicate if Retailer wallet credit limit management is enabled.
enable_retailer_to_view_supplier_campaign_reportsBOOLEANFlag to indicate if the platform enables Retailer to view the Campaign report of Suppliers.

analytics.dim_placement

  • namespace
  • retailer

Placement dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: env_namespace, placement_id
Other Unique Key(s): placement_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_placement.env_namespace;

Column NameData TypeDescription
placement_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
placement_idSTRINGInternal identifier of the Placement (from the source system).
ad_gen_idSTRINGAd gen id.
archivedSTRINGArchived status of the Placement.
display_nameSTRINGDisplay name of the Placement.
campaign_targetSTRINGCampaign target.
catalog_idsSTRINGCatalog ids.
campaign_typesSTRINGList of applicable campaign types.
namespaceSTRINGName of the Namespace.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
enable_search_term_suggestionsBOOLEANEnable search term suggestions feature flag.
allow_custom_search_termsBOOLEANAllow custom search term term feature flag.
search_term_typeSTRINGCustom search term type (if applicable).
search_term_type_labelSTRINGCustom search term type label (if applicable).
allow_targeted_categories_modified_by_userBOOLEANFeature flag for whether targeted categories are allowed to be modified by user.
allow_targeted_locations_modified_by_userBOOLEANFeature flag for whether targeted locations are allowed to be modified by user.

analytics.dim_product

  • namespace
  • retailer

Product dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: normalised_product_code, product_code,catalog_id
Other Unique Key(s): product_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_product.env_namespace;
dim_retailer on dim_retailer.env_namespace = dim_product.env_namespace and dim_retailer.retailer_id = dim_product.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = dim_product.env_namespace and dim_catalog.catalog_id = dim_product.catalog_id and dim_catalog.is_current;
currency_aud on currency_aud.currency = dim_product.currency_code;
currency_usd on currency_usd.currency = dim_product.currency_code;

Column NameData TypeDescription
product_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
product_nameSTRINGName of the Product.
product_typeSTRINGType of the Product.
product_image_urlSTRINGURL to an image of the Product for the Ad.
retailer_nameSTRINGName of the Retailer.
currency_codeSTRINGISO 4217 currency code
product_tagsSTRINGTags associated with the Product.
brandSTRINGBrand of the Product.
google_product_taxonomySTRINGGoogle taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
seller_idSTRINGSeller that the Product is applicable for.
seller_nameSTRINGName of the Seller id.
upcSTRINGUPC of the Product.
inventorySTRINGHow much of the Product is in stock.
namespaceSTRINGName of the Namespace.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
product_collectionSTRINGProduct collections represent the parent product of a given product code.
is_product_collectionBOOLEANFlag to indicate if product collection.

analytics.dim_retailer

  • namespace
  • retailer

Retailer dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: retailer_id, row_version
Other Unique Key(s): retailer_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_retailer.env_namespace;
currency_aud on currency_aud.currency = dim_retailer.currency_code;
currency_usd on currency_usd.currency = dim_retailer.currency_code;

Column NameData TypeDescription
retailer_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
retailer_nameSTRINGName of the Retailer.
team_typeSTRINGType of Team (RETAILER).
company_nameSTRINGCompany name of the Retailer.
business_identifierSTRINGImplementation specific generic label.
industrySTRINGIndustry of the Retailer.
currency_codeSTRINGISO 4217 currency code
ads_requested_capNUMERICMax number of Product Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed).
banner_ads_requested_capNUMERICMax number of Banner Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed).
reserved_search_termsSTRINGNot in use.
global_suppress_flagSTRINGFlag to indicate Retailer is to be excluded from reporting (eg test data).
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution.
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
attribution_time_frameNUMERICDetermines how many days of attribution results should be stored for the first model.
attribution_time_frame_2NUMERICDetermines how many days of attribution results should be stored for the second model.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
created_atTIMESTAMPDate the record was created in the source system.
created_at_utcTIMESTAMPCurrently the same as created_at since all data is in UTC.
updated_atTIMESTAMPDate the record was updated in the source system.
updated_at_utcTIMESTAMPCurrently the same as updated_at since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.dim_search_term

  • namespace
  • retailer

Search Term dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: env_namespace, retailer_id, search_term
Other Unique Key(s): search_term_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_search_term.env_namespace;
dim_retailer on dim_retailer.env_namespace = dim_search_term.env_namespace and dim_retailer.retailer_id = dim_search_term.retailer_id and dim_retailer.is_current;
currency_aud on currency_aud.currency = dim_search_term.currency_code;
currency_usd on currency_usd.currency = dim_search_term.currency_code;

Column NameData TypeDescription
search_term_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
num_ad_requestsINTEGERTotal number of Requests.
num_realised_adsINTEGERTotal number of Ads realised.
ad_request_rankINTEGERRank of the Search Term by total Requests.
ad_stat_rankINTEGERRank of the Search Term by total Ads realised.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.dim_supplier

  • namespace
  • retailer

Supplier dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: supplier_id, row_version, env_namespace
Other Unique Key(s): supplier_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_supplier.env_namespace;

Column NameData TypeDescription
supplier_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
supplier_nameSTRINGName of the Supplier.
team_typeSTRINGType of Team (SUPPLIER).
company_nameSTRINGCompany name of the Supplier.
business_identifierSTRINGImplementation specific generic label.
industrySTRINGIndustry of the Supplier.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
created_atTIMESTAMPDate the record was created in the source system.
created_at_utcTIMESTAMPCurrently the same as created_at since all data is in UTC.
updated_atTIMESTAMPDate the record was updated in the source system.
updated_at_utcTIMESTAMPCurrently the same as updated_at since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.dim_team

  • namespace
  • retailer

Team dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: team_id, row_version, env_namespace
Other Unique Key(s): team_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_team.env_namespace;

Column NameData TypeDescription
team_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
team_idSTRINGInternal identifier of the Team (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
team_nameSTRINGName of the Team.
team_typeSTRINGType of Team (RETAILER or SUPPLIER).
company_nameSTRINGCompany name of the Team.
business_identifierSTRINGImplementation specific generic label.
industrySTRINGIndustry of the Team.
user_idSTRINGInternal identifier of the User (from the source system).
last_campaign_created_idSTRINGInternal identifier of the Campaign last created by the Team (from the source system).
last_campaign_created_dateTIMESTAMPDate the Team created the most recent Campaign.
last_campaign_updated_idSTRINGInternal identifier of the Campaign last modified by the Team (from the source system).
last_campaign_updated_dateTIMESTAMPDate the Team updated the most recent Campaign.
total_campaignsINTEGERTotal number of Campaigns associated with Team (including inactive).
total_active_campaignsINTEGERTotal active Campaigns associated with the Team.
total_spendNUMERICTotal AdSpend to date for the Team across all Campaigns.
last_spend_dateDATEMost recent date that AdSpend was incurred by the Supplier.
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
created_atTIMESTAMPDate the record was created in the source system.
created_at_utcTIMESTAMPCurrently the same as created_at since all data is in UTC.
updated_atTIMESTAMPDate the record was updated in the source system.
updated_at_utcTIMESTAMPCurrently the same as updated_at since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
phoneSTRINGThe company phone number
company_websiteSTRINGThe company website
company_address_line_1STRINGThe company address
company_address_post_codeSTRINGPost code of the company address
contact_emailSTRINGEmail address of the company contact
seller_idSTRINGRetailer managed surrogate id for a supplier team

analytics.dim_user

  • namespace
  • retailer

User dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: user_id, row_version, env_namespace
Other Unique Key(s): user_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_user.env_namespace;

Column NameData TypeDescription
user_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
user_idSTRINGInternal identifier of the User (from the source system).
row_versionINTEGERTrack changes with new row versions (sequentially increasing number to indicate chronology).
adminSTRINGFlag if the User is an administrator.
emailSTRINGUser's email address.
user_nameSTRINGName of the User.
activatedBOOLEANFlag indicating that a User has activated their account.
system_permissionsSTRINGUser system permissions.
action_permissionSTRINGUser action permissions.
subject_permissionSTRINGUser subject permissions.
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
created_atTIMESTAMPDate the record was created in the source system.
created_at_utcTIMESTAMPCurrently the same as created_at since all data is in UTC.
updated_atTIMESTAMPDate the record was updated in the source system.
updated_at_utcTIMESTAMPCurrently the same as updated_at since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.dim_wallet

  • namespace
  • retailer

Wallet dimension.

Layer: Core Dataset
Category: Dimension
Status: Published

Primary Key: wallet_id, env_namespace
Other Unique Key(s): wallet_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = dim_wallet.env_namespace;
dim_team on dim_team.env_namespace = dim_wallet.env_namespace and dim_team.team_id = dim_wallet.wallet_team_id and dim_team.is_current;
currency_aud on currency_aud.currency = dim_wallet.currency_code;
currency_usd on currency_usd.currency = dim_wallet.currency_code;

Column NameData TypeDescription
wallet_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
wallet_team_idSTRINGInternal identifier of the Team (from the source system).
external_idSTRINGImplementation specific generic label.
wallet_nameSTRINGName of the Wallet.
team_nameSTRINGName of the Team.
archivedBOOLEANArchived status of the Wallet.
credit_limitNUMERICAmount the Wallet may go into credit.
currency_codeSTRINGISO 4217 currency code
default_walletBOOLEANFlag indicating if this is the default Wallet.
prepaid_balanceNUMERICPrepaid balance of the Wallet.
available_balanceNUMERICCurrent available balance of the Wallet.
total_purchased_creditsNUMERICTotal credits made to the Wallet.
latest_top_up_amountNUMERICAmount of the most recent credit applied to the Wallet.
earliest_top_up_amountNUMERICEarliest credit amount made against the Wallet.
largest_top_up_amountNUMERICLargest credit amount made against the Wallet.
smallest_top_up_amountNUMERICSmallest credit amount made against the Wallet.
average_top_up_amountNUMERICAverage of credits applied to the Wallet.
credit_limit_usdNUMERICcredit_limit in USD (current exchange rate only).
total_purchased_credits_usdNUMERICtotal_purchased_credits in USD (current exchange rate only).
available_balance_usdNUMERICavailable_balance in USD (current exchange rate only).
prepaid_balance_usdNUMERICprepaid_balance in USD (current exchange rate only).
latest_top_up_amount_usdNUMERIClatest_top_up_amount in USD (current exchange rate only).
earliest_top_up_amount_usdNUMERICearliest_top_up_amount in USD (current exchange rate only).
largest_top_up_amount_usdNUMERIClargest_top_up_amount in USD (current exchange rate only).
smallest_top_up_amount_usdNUMERICsmallest_top_up_amount in USD (current exchange rate only).
average_top_up_amount_usdNUMERICaverage_top_up_amount in USD (current exchange rate only).
active_campaign_countNUMERICNumber of currently active Campaigns associated to the Wallet.
active_campaign_max_total_spendNUMERICAggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet.
namespaceSTRINGName of the Namespace.
earliest_credit_dateTIMESTAMPMost recent date a credit was made to the Wallet.
earliest_credit_date_utcTIMESTAMPCurrently the same as earliest_credit_date since all data is in UTC.
latest_credit_dateTIMESTAMPDate of the most recent credit.
latest_credit_date_utcTIMESTAMPCurrently the same as latest_credit_date since all data is in UTC.
wallet_capture_dateTIMESTAMPDate the Wallet details were captured on.
wallet_capture_date_utcTIMESTAMPCurrently the same as wallet_capture_date since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
daily_limitNUMERICAmount the Wallet may go into credit in a day.
capped_available_balanceNUMERICCurrent capped available balance of the Wallet.

analytics.fact_ad_request

  • namespace
  • retailer

Request fact (full detail).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: request_trace_id, request_type
Other Unique Key(s): ad_request_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ad_request.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ad_request.env_namespace and dim_retailer.retailer_id = fact_ad_request.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_ad_request.env_namespace and dim_catalog.catalog_id = fact_ad_request.catalog_id and dim_catalog.is_current;
dim_placement on dim_placement.env_namespace = fact_ad_request.env_namespace and dim_placement.placement_id = fact_ad_request.placement_id;
dim_search_term on dim_search_term.env_namespace = fact_ad_request.env_namespace and dim_search_term.retailer_id = fact_ad_request.retailer_id and dim_search_term.search_term = fact_ad_request.search_term;
dim_category on dim_category.env_namespace=fact_ad_request.env_namespace and dim_category.category_id=fact_ad_request.category and dim_category.retailer_id = fact_ad_request.retailer_id;

Column NameData TypeDescription
ad_request_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
request_trace_idSTRINGRequest trace id.
request_typeINTEGERRequest type.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
customer_idSTRINGCustomer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution.
session_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
placement_idSTRINGInternal identifier of the Placement (from the source system).
realised_ad_idsSTRINGInternal identifiers of the Realised Ads associated to the Ad Request (ids from the source system).
ingressed_atTIMESTAMPTimestamp the Requests were received.
ingressed_at_utcTIMESTAMPCurrently the same as ingressed_at since all data is in UTC.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
reserved_search_term_flagSTRINGNot in use.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
slot_idsSTRINGSlot ids.
categorySTRINGCategory being targeted.
product_type_codeSTRINGProduct type code.
locationSTRINGLocation.
namespaceSTRINGName of the Namespace.
experiment_idSTRINGNot in use.
num_ads_consideredNUMERICTotal number of Ad candidates that were considered by relevancy algorithms.
num_ads_servedNUMERICTotal number of Ads that were served back.
num_ads_requestedNUMERICTotal number of Ads that were requested by the Requests.
capped_num_ads_servedNUMERICTotal number of Ads that were served back with Cap applied per Request.
capped_num_ads_requestedNUMERICTotal number of Ads that were requested with Cap applied per Request.
capped_num_requests_serving_max_adsNUMERICTotal number of Requests where the Capped number of Ads requested was served in full.
num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_ad_requests_serving_no_adsNUMERICTotal number of Requests where no Ads were served.
num_ad_requests_serving_some_adsNUMERICTotal number of Requests where at least 1 Ad was served.
num_ad_requestsNUMERICTotal number of Requests.
num_ad_requests_with_saturationNUMERICTotal number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested).
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
dtm_cookie_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser cookie, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).

analytics.fact_ad_request_agg

  • namespace
  • retailer

Request fact (aggregated).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, request_type, search_term, reserved_search_term_flag, generic_search_term, placement, platform, page_type, filter_mode, slot_ids, category, placement_id, namespace
Other Unique Key(s): ad_request_agg_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ad_request_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ad_request_agg.env_namespace and dim_retailer.retailer_id = fact_ad_request_agg.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_ad_request_agg.env_namespace and dim_catalog.catalog_id = fact_ad_request_agg.catalog_id and dim_catalog.is_current;
dim_placement on dim_placement.env_namespace = fact_ad_request_agg.env_namespace and dim_placement.placement_id = fact_ad_request_agg.placement_id;
dim_search_term on dim_search_term.env_namespace = fact_ad_request_agg.env_namespace and dim_search_term.retailer_id = fact_ad_request_agg.retailer_id and dim_search_term.search_term = fact_ad_request_agg.search_term;
dim_category on dim_category.env_namespace = fact_ad_request_agg.env_namespace and dim_category.category_id = fact_ad_request_agg.category and dim_category.retailer_id = fact_ad_request_agg.retailer_id

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_ad_request (group by env, namespace, env_namespace, ingressed_at, retailer_id, catalog_id, search_term, placement, platform, reserved_search_term_flag, generic_search_term, request_type,page_type, filter_mode, slot_ids,category, placement_id)

Column NameData TypeDescription
ad_request_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
ingressed_atDATEDate the Requests were received.
request_typeINTEGERRequest type.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
reserved_search_term_flagSTRINGNot in use.
generic_search_termSTRINGSame as SearchTerm except leading and trailing whitespace is removed to improve consolidation.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
slot_idsSTRINGSlot ids.
categorySTRINGCategory being targeted.
namespaceSTRINGName of the Namespace.
num_ads_consideredNUMERICTotal number of Ad candidates that were considered by relevancy algorithms.
num_ads_servedNUMERICTotal number of Ads that were served back.
num_ads_requestedNUMERICTotal number of Ads that were requested by the Requests.
capped_num_ads_servedNUMERICTotal number of Ads that were served back with Cap applied per Request.
capped_num_ads_requestedNUMERICTotal number of Ads that were requested with Cap applied per Request.
capped_num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_ad_requests_serving_no_adsNUMERICTotal number of Requests where no Ads were served.
num_ad_requests_serving_some_adsNUMERICTotal number of Requests where at least 1 Ad was served.
num_ad_requestsNUMERICTotal number of Requests.
num_ad_requests_with_saturationNUMERICTotal number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested).
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
placement_idSTRINGInternal identifier of the Placement (from the source system).

analytics.fact_ad_request_agg_ltz

  • namespace
  • retailer

Request fact (aggregated) in local timezone.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, request_type, search_term, reserved_search_term_flag, generic_search_term, placement, platform, page_type, filter_mode, slot_ids, category, placement_id, namespace
Other Unique Key(s): ad_request_agg_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ad_request_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ad_request_agg.env_namespace and dim_retailer.retailer_id = fact_ad_request_agg.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_ad_request_agg.env_namespace and dim_catalog.catalog_id = fact_ad_request_agg.catalog_id and dim_catalog.is_current;
dim_placement on dim_placement.env_namespace = fact_ad_request_agg.env_namespace and dim_placement.placement_id = fact_ad_request_agg.placement_id;
dim_search_term on dim_search_term.env_namespace = fact_ad_request_agg.env_namespace and dim_search_term.retailer_id = fact_ad_request_agg.retailer_id and dim_search_term.search_term = fact_ad_request_agg.search_term;
dim_category on dim_category.env_namespace = fact_ad_request_agg.env_namespace and dim_category.category_id = fact_ad_request_agg.category and dim_category.retailer_id = fact_ad_request_agg.retailer_id

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_ad_request (group by env, namespace, env_namespace, ingressed_at, retailer_id, catalog_id, search_term, placement, platform, reserved_search_term_flag, generic_search_term, request_type,page_type, filter_mode, slot_ids,category, placement_id)

Column NameData TypeDescription
ad_request_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
ingressed_atDATEDate the Requests were received in local timezone.
request_typeINTEGERRequest type.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
reserved_search_term_flagSTRINGNot in use.
generic_search_termSTRINGSame as SearchTerm except leading and trailing whitespace is removed to improve consolidation.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
slot_idsSTRINGSlot ids.
categorySTRINGCategory being targeted.
namespaceSTRINGName of the Namespace.
num_ads_consideredNUMERICTotal number of Ad candidates that were considered by relevancy algorithms.
num_ads_servedNUMERICTotal number of Ads that were served back.
num_ads_requestedNUMERICTotal number of Ads that were requested by the Requests.
capped_num_ads_servedNUMERICTotal number of Ads that were served back with Cap applied per Request.
capped_num_ads_requestedNUMERICTotal number of Ads that were requested with Cap applied per Request.
capped_num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_ad_requests_serving_no_adsNUMERICTotal number of Requests where no Ads were served.
num_ad_requests_serving_some_adsNUMERICTotal number of Requests where at least 1 Ad was served.
num_ad_requestsNUMERICTotal number of Requests.
num_ad_requests_with_saturationNUMERICTotal number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested).
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
placement_idSTRINGInternal identifier of the Placement (from the source system).

analytics.fact_enhanced_attribution

  • namespace
  • retailer

Enhanced Attribution (full detail, first model only).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, realised_ad_id, retailer_order_id, order_item_id, session_id, campaign_id, category_id, normalised_product_code, product_code, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level
Other Unique Key(s): enhanced_attribution_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution.campaign_id and dim_campaign.is_current;
dim_product on dim_product.env_namespace = fact_enhanced_attribution.env_namespace and dim_product.product_code = fact_enhanced_attribution.product_code ;
dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution.retailer_id and dim_search_term.search_term = fact_enhanced_attribution.search_term;
dim_category on dim_category.env_namespace = fact_enhanced_attribution.env_namespace and dim_category.category_id = fact_enhanced_attribution.category and dim_category.retailer_id = fact_enhanced_attribution.retailer_id;
dim_placement on dim_placement.env_namespace = fact_enhanced_attribution.env_namespace and dim_placement.placement = fact_enhanced_attribution.placement;
fact_realised_ad on fact_realised_ad.env_namespace = fact_enhanced_attribution.env_namespace and fact_realised_ad.realised_ad_id = fact_enhanced_attribution.realised_ad_id;
fact_order on on fact_order.env_namespace = fact_enhanced_attribution.env_namespace and fact_order.retailer_order_id = fact_enhanced_attribution.retailer_order_id and fact_order.order_item_id = fact_enhanced_attribution.retailer_order_id ;

Column NameData TypeDescription
enhanced_attribution_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
realised_ad_idSTRINGInternal identifier of the Realised Ad the Conversion is Attributed to.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
session_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
ingressed_atTIMESTAMPTimestamp the Requests were received.
impressioned_atTIMESTAMPTimestamp the impression occurred.
clicked_atTIMESTAMPTimestamp of the Click.
impressionedBOOLEANFlag indicating an impression.
clickedBOOLEANFlag indicating if clicked.
purchasedBOOLEANTotal number of purchases.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
category_idSTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
order_dateDATEDate of the Orders.
retailer_order_idSTRINGIdentifier of the Order the Conversion is Attributed to.
order_item_idSTRINGLine item of the Order the Conversion is Attributed to.
order_product_codeSTRINGOrder Product code.
order_normalised_productSTRINGNormalised Product code of the Order.
customer_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
row_typeSTRINGRow Type.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
placement_idSTRINGInternal identifier of the Placement (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_enhanced_attribution_2

  • namespace
  • retailer

Enhanced Attribution (full detail, second model only).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, realised_ad_id, retailer_order_id, order_item_id, session_id, campaign_id, category_id, normalised_product_code, product_code, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level
Other Unique Key(s): enhanced_attribution_2_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution_2.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution_2.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution_2.campaign_id and dim_campaign.is_current;
dim_product on dim_product.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_product.product_code = fact_enhanced_attribution_2.product_code ;
dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution_2.retailer_id and dim_search_term.search_term = fact_enhanced_attribution_2.search_term;
dim_category on dim_category.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_category.category_id = fact_enhanced_attribution_2.category and dim_category.retailer_id = fact_enhanced_attribution_2.retailer_id;
dim_placement on dim_placement.env_namespace = fact_enhanced_attribution_2.env_namespace and dim_placement.placement = fact_enhanced_attribution_2.placement;
fact_realised_ad on fact_realised_ad.env_namespace = fact_enhanced_attribution_2.env_namespace and fact_realised_ad.realised_ad_id = fact_enhanced_attribution_2.realised_ad_id;
fact_order on on fact_order.env_namespace = fact_enhanced_attribution_2.env_namespace and fact_order.retailer_order_id = fact_enhanced_attribution_2.retailer_order_id and fact_order.order_item_id = fact_enhanced_attribution_2.retailer_order_id;

Column NameData TypeDescription
enhanced_attribution_2_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
realised_ad_idSTRINGInternal identifier of the Realised Ad the Conversion is Attributed to.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
session_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
ingressed_atTIMESTAMPTimestamp the Requests were received.
impressioned_atTIMESTAMPTimestamp the impression occurred.
clicked_atTIMESTAMPTimestamp of the Click.
impressionedBOOLEANFlag indicating an impression.
clickedBOOLEANFlag indicating if clicked.
purchasedBOOLEANTotal number of purchases.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
category_idSTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
order_dateDATEDate of the Orders.
retailer_order_idSTRINGIdentifier of the Order the Conversion is Attributed to.
order_item_idSTRINGLine item of the Order the Conversion is Attributed to.
order_product_codeSTRINGOrder Product code.
order_normalised_productSTRINGNormalised Product code of the Order.
customer_idSTRINGCustomer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution.
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
row_typeSTRINGRow Type.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
placement_idSTRINGInternal identifier of the Placement (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_enhanced_attribution_agg

  • namespace
  • retailer

Enhanced Attribution (aggregated).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand,retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type, keyword, catalog_id
Other Unique Key(s): enhanced_attribution_agg_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution_agg.campaign_id and dim_campaign.is_current;
dim_product on dim_product.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_product.product_code = fact_enhanced_attribution_agg.product_code ;
dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_search_term.search_term = fact_enhanced_attribution_agg.search_term;
dim_category on dim_category.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_category.category_id = fact_enhanced_attribution_agg.category and dim_category.retailer_id = fact_enhanced_attribution_agg.retailer_id;
dim_placement on dim_placement.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_placement.placement = fact_enhanced_attribution_agg.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_enhanced_attribution (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id)
union
fact_enhanced_attribution_2 (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id)

Column NameData TypeDescription
enhanced_attribution_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
category_idSTRINGCategory being targeted.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
order_dateDATEDate of the Orders.
ingressed_atDATEDate the Ads were realised.
search_termSTRINGDEPRECATED. Please switch to using keyword.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
namespaceSTRINGName of the Namespace.
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
attribution_modelINTEGERIndicate if data is from first or second model.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_enhanced_attribution_agg_ltz

  • namespace
  • retailer

Enhanced Attribution (aggregated) in local timezone.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand,retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type, keyword, catalog_id
Other Unique Key(s): enhanced_attribution_agg_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_enhanced_attribution_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_retailer.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_campaign.campaign_id = fact_enhanced_attribution_agg.campaign_id and dim_campaign.is_current;
dim_product on dim_product.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_product.product_code = fact_enhanced_attribution_agg.product_code ;
dim_search_term on dim_search_term.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_search_term.retailer_id = fact_enhanced_attribution_agg.retailer_id and dim_search_term.search_term = fact_enhanced_attribution_agg.search_term;
dim_category on dim_category.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_category.category_id = fact_enhanced_attribution_agg.category and dim_category.retailer_id = fact_enhanced_attribution_agg.retailer_id;
dim_placement on dim_placement.env_namespace = fact_enhanced_attribution_agg.env_namespace and dim_placement.placement = fact_enhanced_attribution_agg.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_enhanced_attribution (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id)
union
fact_enhanced_attribution_2 (group by env, namespace, env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name,brand, retailer_taxonomy,halo_taxonomy,halo_taxonomy_level,order_date,ingressed_at,search_term, keyword,placement ,platform ,page_type,attribution_model,retailer_id ,order_type,catalog_id)

Column NameData TypeDescription
enhanced_attribution_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
category_idSTRINGCategory being targeted.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
order_dateDATEDate of the Orders.
ingressed_atDATEDate the Ads were realised in local timezone.
search_termSTRINGDEPRECATED. Please switch to using keyword.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
namespaceSTRINGName of the Namespace.
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
attribution_modelINTEGERIndicate if data is from first or second model.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_fta_campaign_spend

  • namespace
  • retailer

FTA Campaign Spend fact.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, team_id, wallet_id, search_term, catalog_id, product_code, bucket_date, bucket_date_key
Other Unique Key(s): fta_campaign_spend_key
Partition: bucket_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_fta_campaign_spend.env_namespace;
dim_campaign on dim_campaign.env_namespace = fact_fta_campaign_spend.env_namespace and dim_campaign.campaign_id = fact_fta_campaign_spend.campaign_id and dim_campaign.is_current;
dim_team on dim_team.env_namespace = fact_fta_campaign_spend.env_namespace and dim_team.team_id = fact_fta_campaign_spend.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = fact_fta_campaign_spend.env_namespace and dim_wallet.wallet_id = fact_fta_campaign_spend.wallet_id;
dim_catalog on dim_catalog.env_namespace = fact_fta_campaign_spend.env_namespace and dim_catalog.catalog_id = fact_fta_campaign_spend.catalog_id and dim_catalog.is_current;
dim_search_term on dim_search_term.env_namespace = fact_fta_campaign_spend.env_namespace and dim_search_term.retailer_id = fact_fta_campaign_spend.retailer_id and dim_search_term.search_term = fact_fta_campaign_spend.search_term;
dim_product on dim_product.env_namespace = fact_fta_campaign_spend.env_namespace and dim_product.product_code = fact_fta_campaign_spend.product_code;

Time Series Column: bucket_date

Column NameData TypeDescription
fta_campaign_spend_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
product_codeSTRINGProduct code.
bucket_dateDATEBucket date.
bucket_date_keyINTEGERUnique identifier of the row in this table (surrogate key).
namespaceSTRINGName of the Namespace.
bucketed_costNUMERICBucketed cost.
fta_costNUMERICTotal amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign.
catalog_cost_percentageNUMERICCatalog cost percentage.
num_of_search_termsINTEGERNumber of Search Terms.
num_of_productsINTEGERNumber of Products.
num_of_days_in_campaignINTEGERTotal number of days in the Campaign.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.fact_ledger

  • namespace
  • retailer

Ledger fact (full detail).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ledger_id
Other Unique Key(s): ledger_key
Partition: transaction_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ledger.env_namespace and dim_retailer.retailer_id = fact_ledger.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_ledger.env_namespace and dim_campaign.campaign_id = fact_ledger.campaign_id and dim_campaign.is_current;
dim_team on dim_team.env_namespace = fact_ledger.env_namespace and dim_team.team_id = fact_ledger.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = fact_ledger.env_namespace and dim_wallet.wallet_id = fact_ledger.wallet_id;

Column NameData TypeDescription
ledger_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ledger_idSTRINGInternal identifier of the Ledger transaction (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
transaction_dateTIMESTAMPDate of the transactions.
transaction_date_utcTIMESTAMPCurrently the same as transaction_date since all data is in UTC.
ledger_typeSTRINGDebit or Credit transaction type.
product_typeSTRINGType of the Product.
reasonSTRINGReason given for the transaction type.
namespaceSTRINGName of the Namespace.
amountNUMERICTotal of transaction amounts.
citrus_gross_marginNUMERICCitrus gross margin.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
reason_linkbackSTRINGLink back to what the transaction was for. E.g- Ids of the ads that were impressioned/clicked.

analytics.fact_ledger_agg

  • namespace
  • retailer

Ledger fact (aggregated into UTC+0 day buckets).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id
Other Unique Key(s): ledger_agg_key
Partition: transaction_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ledger_agg.env_namespace and dim_retailer.retailer_id = fact_ledger_agg.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_ledger_agg.env_namespace and dim_campaign.campaign_id = fact_ledger_agg.campaign_id and dim_campaign.is_current;
dim_team on dim_team.env_namespace = fact_ledger_agg.env_namespace and dim_team.team_id = fact_ledger_agg.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = fact_ledger_agg.env_namespace and dim_wallet.wallet_id = fact_ledger_agg.wallet_id;

Time Series Column: transaction_date

Aggregation Details:
Source tables(s):
fact_ledger (group by transaction_date ,date_key ,env ,namespace ,env_namespace ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id)

Column NameData TypeDescription
ledger_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
transaction_dateDATEDate of the transactions.
date_keyINTEGERUnique identifier of the row in this table (surrogate key).
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
ledger_typeSTRINGDebit or Credit transaction type.
product_ledgerSTRINGMore detailed transaction type.
namespaceSTRINGName of the Namespace.
reasonSTRINGReason given for the transaction type.
amountNUMERICTotal of transaction amounts.
transaction_countNUMERICTotal transaction count.
citrus_gross_marginNUMERICCitrus gross margin.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.fact_ledger_agg_2

  • namespace
  • retailer

Ledger fact (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: transaction_timestamp, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id
Other Unique Key(s): None
Partition: transaction_timestamp (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg_2.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ledger_agg_2.env_namespace and dim_retailer.retailer_id = fact_ledger_agg_2.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_ledger_agg_2.env_namespace and dim_campaign.campaign_id = fact_ledger_agg_2.campaign_id and dim_campaign.is_current;
dim_team on dim_team.env_namespace = fact_ledger_agg_2.env_namespace and dim_team.team_id = fact_ledger_agg_2.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = fact_ledger_agg_2.env_namespace and dim_wallet.wallet_id = fact_ledger_agg_2.wallet_id;

Time Series Column: transaction_date

Aggregation Details:
Source tables(s):
fact_ledger (env ,namespace ,env_namespace ,transaction_timestamp ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id)

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
transaction_timestampTIMESTAMPTimestamp of the transactions rounded up to the hour
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
ledger_typeSTRINGDebit or Credit transaction type.
product_ledgerSTRINGType of the Product.
reasonSTRINGReason given for the transaction type.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
citrus_gross_marginNUMERICTotal of Citrus gross margin
amountNUMERICTotal of transaction amounts.
transaction_countINTEGERTotal number of transactions.

analytics.fact_ledger_agg_2_ltz

  • namespace
  • retailer

Ledger fact (aggregated into local timezone hourly buckets). Only for current + previous 3 months.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: transaction_timestamp, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id
Other Unique Key(s): None
Partition: transaction_timestamp (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg_2.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ledger_agg_2.env_namespace and dim_retailer.retailer_id = fact_ledger_agg_2.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_ledger_agg_2.env_namespace and dim_campaign.campaign_id = fact_ledger_agg_2.campaign_id and dim_campaign.is_current;
dim_team on dim_team.env_namespace = fact_ledger_agg_2.env_namespace and dim_team.team_id = fact_ledger_agg_2.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = fact_ledger_agg_2.env_namespace and dim_wallet.wallet_id = fact_ledger_agg_2.wallet_id;

Time Series Column: transaction_date

Aggregation Details:
Source tables(s):
fact_ledger (env ,namespace ,env_namespace ,transaction_timestamp ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id)

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
transaction_timestampDATETIMEDatetime of the transactions rounded up to the hour in local timezone
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
ledger_typeSTRINGDebit or Credit transaction type.
product_ledgerSTRINGType of the Product.
reasonSTRINGReason given for the transaction type.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
citrus_gross_marginNUMERICTotal of Citrus gross margin
amountNUMERICTotal of transaction amounts.
transaction_countINTEGERTotal number of transactions.

analytics.fact_ledger_agg_ltz

  • namespace
  • retailer

Ledger fact (aggregated into local timezone day buckets).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id
Other Unique Key(s): ledger_agg_key
Partition: transaction_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_ledger_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_ledger_agg.env_namespace and dim_retailer.retailer_id = fact_ledger_agg.retailer_id and dim_retailer.is_current;
dim_campaign on dim_campaign.env_namespace = fact_ledger_agg.env_namespace and dim_campaign.campaign_id = fact_ledger_agg.campaign_id and dim_campaign.is_current;
dim_team on dim_team.env_namespace = fact_ledger_agg.env_namespace and dim_team.team_id = fact_ledger_agg.team_id and dim_team.is_current;
dim_wallet on dim_wallet.env_namespace = fact_ledger_agg.env_namespace and dim_wallet.wallet_id = fact_ledger_agg.wallet_id;

Time Series Column: transaction_date

Aggregation Details:
Source tables(s):
fact_ledger (group by transaction_date ,date_key ,env ,namespace ,env_namespace ,team_id ,wallet_id ,campaign_id ,ledger_type ,product_ledger ,reason ,retailer_id)

Column NameData TypeDescription
ledger_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
transaction_dateDATEDate of the transactions in local timezone.
date_keyINTEGERUnique identifier of the row in this table (surrogate key).
team_idSTRINGInternal identifier of the Team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
ledger_typeSTRINGDebit or Credit transaction type.
product_ledgerSTRINGMore detailed transaction type.
namespaceSTRINGName of the Namespace.
reasonSTRINGReason given for the transaction type.
amountNUMERICTotal of transaction amounts.
transaction_countNUMERICTotal transaction count.
citrus_gross_marginNUMERICCitrus gross margin.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.fact_order

  • namespace
  • retailer

Order fact (full detail).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: retailer_order_id, sequence_id, retailer_id, row_version, order_item_id, order_type
Other Unique Key(s): order_key
Partition: order_timestamp (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_order.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_order.env_namespace and dim_retailer.retailer_id = fact_order.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_order.env_namespace and dim_catalog.catalog_id = fact_order.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_order.env_namespace and dim_product.catalog_id = fact_order.catalog_id and dim_product.product_code = fact_order.product_code;

Column NameData TypeDescription
order_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
sequence_idNUMERICSequence id.
retailer_order_idSTRINGIdentifier for the Order from the Retailer.
row_versionNUMERICTrack changes with new row versions (sequentially increasing number to indicate chronology).
order_item_idSTRINGLine item of the Order.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
issuer_team_idSTRINGInternal identifier of the Team (from the source system).
namespaceSTRINGName of the Namespace.
order_timestampTIMESTAMPTimestamp of the Order.
order_timestamp_utcTIMESTAMPCurrently the same as order_timestamp since all data is in UTC.
order_dateDATEDate of the Orders.
order_date_utcDATECurrently the same as order_date since all data is in UTC.
order_date_keyINTEGERUnique identifier of the row in this table (surrogate key).
realised_ad_idSTRINGRealised Ad the Order is Attributed to (as set by external processes).
product_codeSTRINGProduct code.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
session_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
customer_idSTRINGCustomer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution.
currency_codeSTRINGISO 4217 currency code
order_typeSTRINGType of the Order.
quantityNUMERICQuantity of the Product ordered.
total_priceNUMERICTotal paid for the products ordered.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
dtm_cookie_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser cookie, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
seller_idSTRINGRetailer managed surrogate id for a supplier team
processed_atTIMESTAMPLast updated_at in the order

analytics.fact_order_agg

  • namespace
  • retailer

Order fact (aggregated).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, order_date, issuer_team_id, retailer_id, catalog_id, product_code, normalised_product_code, order_type
Other Unique Key(s): order_agg_key
Partition: order_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_order_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_order_agg.env_namespace and dim_retailer.retailer_id = fact_order_agg.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_order_agg.env_namespace and dim_catalog.catalog_id = fact_order_agg.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_order_agg.env_namespace and dim_product.catalog_id = fact_order_agg.catalog_id and dim_product.product_code = fact_order_agg.product_code;

Time Series Column: order_date

Aggregation Details:
Source tables(s):
fact_order (env ,env_namespace ,retailer_id ,catalog_id ,issuer_team_id ,order_date ,order_date_key ,product_code ,normalised_product_code ,currency_code ,namespace ,order_type)

Column NameData TypeDescription
order_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
issuer_team_idSTRINGInternal identifier of the Team (from the source system).
order_dateDATEDate of the Orders.
order_date_keyINTEGERUnique identifier of the row in this table (surrogate key).
product_codeSTRINGProduct code.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
currency_codeSTRINGISO 4217 currency code
namespaceSTRINGName of the Namespace.
order_typeSTRINGType of the Order.
quantityNUMERICQuantity of the Product ordered.
total_priceNUMERICTotal paid for the products ordered.
total_price_usdFLOATtotal_price in USD (current exchange rate only).
order_itemsNUMERICTotal number of items ordered.
ordersNUMERICNumber of Orders made.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.fact_order_agg_ltz

  • namespace
  • retailer

Order fact (aggregated in local timezone dates).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: env_namespace, order_date, issuer_team_id, retailer_id, catalog_id, product_code, normalised_product_code, order_type
Other Unique Key(s): order_agg_key
Partition: order_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_order_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_order_agg.env_namespace and dim_retailer.retailer_id = fact_order_agg.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_order_agg.env_namespace and dim_catalog.catalog_id = fact_order_agg.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_order_agg.env_namespace and dim_product.catalog_id = fact_order_agg.catalog_id and dim_product.product_code = fact_order_agg.product_code;

Time Series Column: order_date

Aggregation Details:
Source tables(s):
fact_order (env ,env_namespace ,retailer_id ,catalog_id ,issuer_team_id ,order_date ,order_date_key ,product_code ,normalised_product_code ,currency_code ,namespace ,order_type)

Column NameData TypeDescription
order_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
issuer_team_idSTRINGInternal identifier of the Team (from the source system).
order_dateDATEDate of the Orders in local timezone.
order_date_keyINTEGERUnique identifier of the row in this table (surrogate key).
product_codeSTRINGProduct code.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
currency_codeSTRINGISO 4217 currency code
namespaceSTRINGName of the Namespace.
order_typeSTRINGType of the Order.
quantityNUMERICQuantity of the Product ordered.
total_priceNUMERICTotal paid for the products ordered.
total_price_usdFLOATtotal_price in USD (current exchange rate only).
order_itemsNUMERICTotal number of items ordered.
ordersNUMERICNumber of Orders made.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.fact_realised_ad

  • namespace
  • retailer

Realised Ad fact (full detail).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: realised_ad_id
Other Unique Key(s): realised_ad_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad.env_namespace and dim_retailer.retailer_id = fact_realised_ad.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad.env_namespace and dim_catalog.catalog_id = fact_realised_ad.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad.env_namespace and dim_product.catalog_id = fact_realised_ad.catalog_id and dim_product.normalised_product_code = fact_realised_ad.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad.env_namespace and dim_supplier.supplier_id = fact_realised_ad.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad.env_namespace and dim_campaign.campaign_id = fact_realised_ad.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad.env_namespace and dim_search_term.retailer_id = fact_realised_ad.retailer_id and dim_search_term.search_term = fact_realised_ad.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad.env_namespace and dim_category.category_id = fact_realised_ad.category and dim_category.retailer_id = fact_realised_ad.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad.env_namespace and dim_placement.placement = fact_realised_ad.placement;
fact_order on fact_order.env_namespace = fact_realised_ad.env_namespace and fact_order.order_item_id = fact_realised_ad.order_item_id;

Column NameData TypeDescription
realised_ad_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
realised_ad_idSTRINGInternal identifier of the Realised Ad (from the source system)..
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
ingressed_atTIMESTAMPTimestamp the Requests were received.
ingressed_at_utcTIMESTAMPCurrently the same as ingressed_at since all data is in UTC.
purchased_atTIMESTAMPTimestamp of the purchase.
purchased_at_utcTIMESTAMPCurrently the same as purchased_at since all data is in UTC.
impressioned_atSTRINGString representation of the timestamp when the impression occurred.
impressioned_at_utcTIMESTAMPCurrently the same as impressioned_at since all data is in UTC.
clicked_atTIMESTAMPTimestamp of the Click.
clicked_at_utcTIMESTAMPCurrently the same as clicked_at since all data is in UTC.
served_atTIMESTAMPTimestamp when Ads served.
served_at_utcTIMESTAMPCurrently the same as served_at since all data is in UTC.
namespaceSTRINGName of the Namespace.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
product_codeSTRINGProduct code.
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
session_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser session, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
customer_idSTRINGCustomer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution.
target_product_codeSTRINGTarget Product code.
reserved_search_term_flagSTRINGNot in use.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
impressionedBOOLEANFlag indicating an impression.
clickedBOOLEANFlag indicating if clicked.
purchasedBOOLEANTotal number of purchases.
servedBOOLEANFlag indicating Ads were served.
click_invalidBOOLEANFlag indicating if the click was invalid.
impression_invalidBOOLEANFlag indicating if the impression was invalid.
campaign_team_idSTRINGInternal identifier of the Team (from the source system).
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
page_typeINTEGERLegacy, superseded by Placement.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impression_spendNUMERICAdSpend generated by impressions.
click_spendNUMERICAdSpend generated by clicks.
serve_spendNUMERICServe spend.
serve_priceNUMERICServe price.
impression_priceNUMERICPrice of an impression.
click_priceNUMERICClick Price.
amount_refunded_from_invalid_clickNUMERICRefund amount from invalid clicks.
amount_refunded_from_invalid_impressionNUMERICRefund amount from invalid impressions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
placement_idSTRINGInternal identifier of the Placement (from the source system).
product_type_codeSTRINGProduct type code.
locationSTRINGLocation.
order_item_idSTRINGLine item of the Order.
positionINTEGERPosition of the Ad.
experiment_idSTRINGNot in use.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
ad_requester_team_idSTRINGInternal identifier of the Team (from the source system).
email_serve_revenueNUMERICEmail serve revenue.
invalid_ad_revenueNUMERICTotal invalid revenue.
campaign_typeINTEGERType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
product_collectionSTRINGProduct collection (parent child sku).
cached_ad_idSTRINGInternal identifier of the Cached Ad (from the source system).
seller_idSTRINGInternal identifier of the Seller (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
is_ftaBOOLEANFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
keyword_match_typeSTRINGMethod used in matching the keyword to the user search term i.e. EXACT, PHRASE, etc.
impression_atTIMESTAMPTimestamp the impression occurred.
generic_search_termSTRINGSearch term with basic data cleaning applied.
dtm_cookie_idSTRINGCustomer identifier as provided by the Retailer (often tied to a browser cookie, but is implementation specific). Normally used for Attribution (so must be persistent across the attribution window).
ad_request_keySTRINGUnique identifier of the row in this table (surrogate key).
base_realised_ad_idSTRINGRealised Ad Id
boost_valueNUMERICProduct boosting value if provided by the retailer and used as part of the ad search.

analytics.fact_realised_ad_agg

  • namespace
  • retailer

Realised Ad fact (aggregated into UTC+0 day buckets).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id, placement_id, wallet_id, namespace, keyword
Other Unique Key(s): realised_ad_agg_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg.env_namespace and dim_product.catalog_id = fact_realised_ad_agg.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg.retailer_id and dim_search_term.search_term = fact_realised_ad_agg.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg.env_namespace and dim_category.category_id = fact_realised_ad_agg.category and dim_category.retailer_id = fact_realised_ad_agg.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg.env_namespace and dim_placement.placement = fact_realised_ad_agg.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id ,target_product_code ,keyword ,ad_requester_team_id)

Column NameData TypeDescription
realised_ad_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
ingressed_atDATEDate the Ads were realised.
namespaceSTRINGName of the Namespace.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED. Please switch to using keyword.
product_codeSTRINGProduct code.
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impression_spendNUMERICAdSpend generated by impressions.
click_spendNUMERICAdSpend generated by clicks.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
target_product_codeSTRINGTarget Product code.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
ad_requester_team_idSTRINGInternal identifier of the Team (from the source system).
email_serve_revenueNUMERICEmail serve revenue.
invalid_ad_revenueNUMERICTotal invalid revenue.
placement_idSTRINGInternal identifier of the Placement (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_realised_ad_agg_2

  • namespace
  • retailer

Realised Ad fact (aggregated, customer centric). Includes customer_id, but no breakdown by Campaign, Placement and Product.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, retailer_id, supplier_id, customer_id, search_term,category
Other Unique Key(s): realised_ad_agg_2_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_2.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_2.retailer_id and dim_retailer.is_current;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_2.supplier_id and dim_supplier.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_2.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_2.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_2.env_namespace and dim_category.category_id = fact_realised_ad_agg_2.category and dim_category.retailer_id = fact_realised_ad_agg_2.retailer_id;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad (customer_id ,env ,namespace ,env_namespace ,ingressed_at ,retailer_id ,supplier_id ,keyword ,search_term ,category)

Column NameData TypeDescription
realised_ad_agg_2_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
customer_idSTRINGCustomer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution.
ingressed_atDATEDate the Ads were realised.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
categorySTRINGCategory being targeted.
namespaceSTRINGName of the Namespace.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.

analytics.fact_realised_ad_agg_3

  • namespace
  • retailer

Realised Ad fact (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id
Other Unique Key(s): None
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id ,target_product_code ,keyword ,ad_requester_team_id)

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
ingressed_atTIMESTAMPTimestamp the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED and will be removed in the future. Please use keyword instead.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
placement_idSTRINGInternal identifier of the Placement (from the source system).
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_realised_ad_agg_3_live

  • namespace

Realised Ad fact (aggregated into UTC+0 hourly buckets). Only for current + previous 2 Days.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id
Other Unique Key(s): None
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
ingressed_atTIMESTAMPTimestamp the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED and will be removed in the future. Please use keyword instead.
generic_search_termSTRINGDEPRECATED and will be removed in the future. Please use keyword instead.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
attributable_impressionsNUMERICTotal aatributable impressions.
attributable_clicksNUMERICNumber of attributable Clicks.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
placement_idSTRINGInternal identifier of the Placement (from the source system)

analytics.fact_realised_ad_agg_3_ltz

  • namespace
  • retailer

Realised Ad fact (aggregated into local timezone hourly buckets). Only for current + previous 3 months.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id
Other Unique Key(s): None
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id ,target_product_code ,keyword ,ad_requester_team_id)

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
ingressed_atDATETIMEDatetime the Ads were realised in local timezone.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED and will be removed in the future. Please use keyword instead.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atDATETIMEDate the row was inserted into the source system.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
placement_idSTRINGInternal identifier of the Placement (from the source system).
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_realised_ad_agg_3_ltz_live

  • namespace

Realised Ad fact (aggregated into local timezone hourly buckets). Only for current + previous 2 days.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id
Other Unique Key(s): None
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_3.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_3.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_3.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_3.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_3.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_3.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_3.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_category.category_id = fact_realised_ad_agg_3.category and dim_category.retailer_id = fact_realised_ad_agg_3.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_3.env_namespace and dim_placement.placement = fact_realised_ad_agg_3.placement;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
ingressed_atDATETIMEDatetime the Ads were realised in local timezone.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED and will be removed in the future. Please use keyword instead.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atDATETIMEDate the row was inserted into the source system.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
attributable_impressionsNUMERICTotal aatributable impressions.
attributable_clicksNUMERICNumber of attributable Clicks.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
placement_idSTRINGInternal identifier of the Placement (from the source system)

analytics.fact_realised_ad_agg_4a

  • namespace
  • retailer

Realised Ad fact (aggregated by day). Based on fact_realised_ad with keyword and keyword_matchtype. Includes metrics aggregated at the search term level.

The main purpose of this dataset is to analyse the correlation of how end user search terms match with campaign defined keywords.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id, keyword, keyword_match_type
Other Unique Key(s): None
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_4a.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_4a.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_4a.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_4a.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_4a.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_category.category_id = fact_realised_ad_agg_4a.category and dim_category.retailer_id = fact_realised_ad_agg_4a.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_placement.placement = fact_realised_ad_agg_4a.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad ( env ,namespace ,env_namespace ,ingressed_at ,catalog_id ,campaign_id ,supplier_id ,keyword ,keyword_match_type ,product_code ,retailer_id ,slot_id ,placement ,platform ,ad_type ,target_product_code ,wallet_id ,search_term_metrics ,search_term)

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
ingressed_atDATEDate the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
slot_idSTRINGBanner SlotId as specified in the Ad Request.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
keyword_match_typeSTRINGMethod used in matching the keyword to the user search term i.e. EXACT, PHRASE, etc.
search_term_metricsRECORDMetrics for each search term
placement_idSTRINGInternal identifier of the Placement (from the source system).

analytics.fact_realised_ad_agg_4a_ltz

  • namespace
  • retailer

Realised Ad fact (aggregated by day). Based on fact_realised_ad with keyword and keyword_matchtype. Includes metrics aggregated at the search term level.
daily groups by retailer specified local timezone.

The main purpose of this dataset is to analyse the correlation of how end user search terms match with campaign defined keywords.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, placement_id, wallet_id, keyword, keyword_match_type
Other Unique Key(s): None
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg_4a.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_product.catalog_id = fact_realised_ad_agg_4a.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg_4a.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg_4a.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg_4a.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg_4a.retailer_id and dim_search_term.search_term = fact_realised_ad_agg_4a.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_category.category_id = fact_realised_ad_agg_4a.category and dim_category.retailer_id = fact_realised_ad_agg_4a.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg_4a.env_namespace and dim_placement.placement = fact_realised_ad_agg_4a.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad ( env ,namespace ,env_namespace ,ingressed_at ,catalog_id ,campaign_id ,supplier_id ,keyword ,keyword_match_type ,product_code ,retailer_id ,slot_id ,placement ,platform ,ad_type ,target_product_code ,wallet_id ,search_term_metrics ,search_term)

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
ingressed_atDATEDate the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
slot_idSTRINGBanner SlotId as specified in the Ad Request.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
keyword_match_typeSTRINGMethod used in matching the keyword to the user search term i.e. EXACT, PHRASE, etc.
search_term_metricsRECORDMetrics for each search term
placement_idSTRINGInternal identifier of the Placement (from the source system).

analytics.fact_realised_ad_agg_ltz

  • namespace
  • retailer

Realised Ad fact (aggregated into local timezone day buckets).

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code, ad_requester_team_id, placement_id, wallet_id, namespace, keyword
Other Unique Key(s): realised_ad_agg_key
Partition: ingressed_at (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_realised_ad_agg.env_namespace;
dim_retailer on dim_retailer.env_namespace = fact_realised_ad_agg.env_namespace and dim_retailer.retailer_id = fact_realised_ad_agg.retailer_id and dim_retailer.is_current;
dim_catalog on dim_catalog.env_namespace = fact_realised_ad_agg.env_namespace and dim_catalog.catalog_id = fact_realised_ad_agg.catalog_id and dim_catalog.is_current;
dim_product on dim_product.env_namespace = fact_realised_ad_agg.env_namespace and dim_product.catalog_id = fact_realised_ad_agg.catalog_id and dim_product.normalised_product_code = fact_realised_ad_agg.product_code;
dim_supplier on dim_supplier.env_namespace = fact_realised_ad_agg.env_namespace and dim_supplier.supplier_id = fact_realised_ad_agg.supplier_id and dim_supplier.is_current;
dim_campaign on dim_campaign.env_namespace = fact_realised_ad_agg.env_namespace and dim_campaign.campaign_id = fact_realised_ad_agg.campaign_id and dim_campaign.is_current;
dim_search_term on dim_search_term.env_namespace = fact_realised_ad_agg.env_namespace and dim_search_term.retailer_id = fact_realised_ad_agg.retailer_id and dim_search_term.search_term = fact_realised_ad_agg.search_term;
dim_category on dim_category.env_namespace = fact_realised_ad_agg.env_namespace and dim_category.category_id = fact_realised_ad_agg.category and dim_category.retailer_id = fact_realised_ad_agg.retailer_id;
dim_placement on dim_placement.env_namespace = fact_realised_ad_agg.env_namespace and dim_placement.placement = fact_realised_ad_agg.placement;

Time Series Column: ingressed_at

Aggregation Details:
Source tables(s):
fact_realised_ad (ingressed_at ,env ,namespace ,env_namespace ,catalog_id ,retailer_id ,supplier_id ,campaign_id ,ad_type ,search_term ,generic_search_term ,product_code ,content_standard_id ,slot_id ,category ,placement ,platform ,placement_id ,wallet_id ,target_product_code ,keyword ,ad_requester_team_id)

Column NameData TypeDescription
realised_ad_agg_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
ingressed_atDATEDate the Ads were realised in local timezone.
namespaceSTRINGName of the Namespace.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED. Please switch to using keyword.
product_codeSTRINGProduct code.
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impression_spendNUMERICAdSpend generated by impressions.
click_spendNUMERICAdSpend generated by clicks.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
target_product_codeSTRINGTarget Product code.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).
ad_requester_team_idSTRINGInternal identifier of the Team (from the source system).
email_serve_revenueNUMERICEmail serve revenue.
invalid_ad_revenueNUMERICTotal invalid revenue.
placement_idSTRINGInternal identifier of the Placement (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atDATETIMEDate the row was inserted into the source system.
keywordSTRINGThe word/phrase being targeted by the campaign - set by the advertiser.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

analytics.fact_report_request_tracking

  • namespace
  • retailer

CitrusAd client reporting usage fact.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: report_request_tracking_id
Other Unique Key(s): report_request_tracking_key
Partition: request_date (by DAY)

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_report_request_tracking.env_namespace;
dim_team on dim_team.env_namespace = fact_report_request_tracking.env_namespace and dim_team.team_id = fact_report_request_tracking.team_id and dim_team.is_current;
dim_user on dim_user.env_namespace = fact_report_request_tracking.env_namespace and dim_user.user_id = fact_report_request_tracking.user_id and dim_user.is_current;

Column NameData TypeDescription
report_request_tracking_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
report_request_tracking_idSTRINGInternal identifier of the Report Request (from the source system).
user_idSTRINGInternal identifier of the User (from the source system).
team_idSTRINGInternal identifier of the Team (from the source system).
report_typeSTRINGType of report.
cache_levelSTRINGCache level.
report_spanSTRINGSpan of report.
request_dateDATEDate of the report request.
request_date_keyINTEGERUnique identifier of the row in this table (surrogate key).
request_timeTIMESTAMPRequest time.
namespaceSTRINGName of the Namespace.
counts_towards_quotaBOOLEANFlag indicating of usage counts towards quota.
big_query_billed_bytesNUMERICTotal bytes billed.
big_query_execution_duration_secondsNUMERICTotal duration of all queries.
big_query_finished_polling_duration_secondsNUMERICTotal polling duration of all queries.
total_execution_duration_secondsNUMERICTotal execution duration of the report.
max_billed_bytes_per_dayNUMERICMax billed bytes per day.
max_billed_bytes_per_monthNUMERICMax billed bytes per month.
max_uncached_requests_per_dayNUMERICMax uncached requests per day.
max_uncached_requests_per_monthNUMERICMax uncached requests per month.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.fact_user_team

  • namespace
  • retailer

List of all Team Users.

Layer: Core Dataset
Category: Fact
Status: Published

Primary Key: user_id, team_id, env_namespace
Other Unique Key(s): user_team_key
Partition: None

Foreign Key(s):
dim_env_namespace on dim_env_namespace.env_namespace = fact_user_team.env_namespace;
dim_team on dim_team.env_namespace = fact_user_team.env_namespace and dim_team.team_id = fact_user_team.team_id and dim_team.is_current;
dim_user on dim_user.env_namespace = fact_user_team.env_namespace and dim_user.user_id = fact_user_team.user_id and dim_user.is_current;

Column NameData TypeDescription
user_team_keySTRINGUnique identifier of the row in this table (surrogate key).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
user_idSTRINGInternal identifier of the User (from the source system).
team_idSTRINGInternal identifier of the Team (from the source system).
role_idsSTRINGRole ids.
last_edit_dateTIMESTAMPDate of the last edit.
last_edit_date_utcTIMESTAMPCurrently the same as last_edit_date since all data is in UTC.
etl_created_atTIMESTAMPDate the row was inserted into this table (not the date the record was created in the source system).
etl_modified_atTIMESTAMPDate this row was last updated (not the date the record was updated in the source system).

analytics.log_status

  • namespace
  • retailer

Logging table. Records when this dataset has been updated (both start time and end time with status).

Layer: Core Dataset
Category: Logging
Status: Published

Primary Key: jobid, logging_datetime_utc, status
Other Unique Key(s): jobid
Partition: None

Foreign Key(s):
None

Column NameData TypeDescription
jobidSTRINGId for the Job being executed.
logging_datetime_utcDATETIMEDate and time the Job log entry was made.
job_nameSTRINGLabel indicating what core dataset the Job is for.
statusSTRINGIndicate if the Job is running or completed.
return_codeSTRINGIndicate if the completed status was successful (0) or failed (1).

reporting.ad_request__realised_ad_ltz_view

  • namespace

Union of ad_request_agg_view and realised_ad_agg_view (local timezone). Allows for convenient calculation of measures that require both Request and Realised Ad statistics (for example a ratio of impressions vs ads requested).

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to realised_ad_agg_view
Other Unique Key(s):
Partition: Refer to realised_ad_agg_view

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate when the ad request and realised ad data was ingested.
ad_typeINTEGERType identifier for the ad format or placement type.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
generic_search_termSTRINGGeneric version of the search term, if applicable.
reserved_search_term_flagSTRINGIndicates if the search term is a reserved keyword.
placementSTRINGSpecific placement or location of the ad.
platformSTRINGPlatform where the ad is served (e.g., web, mobile).
page_typeINTEGERIdentifier for the type of page the ad is displayed on.
filter_modeINTEGERMode of filtering applied to the ad request.
slot_idSTRINGIdentifier for the ad slot.
categorySTRINGCategory of the ad content.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the product catalog.
retailer_idSTRINGInternal identifier of the Retailer (from the source system).
retailer_nameSTRINGDisplay name of the Retailer.
retailer_industrySTRINGIndustry category of the retailer.
retailer_business_identifierSTRINGBusiness identifier for the retailer.
retailer_company_nameSTRINGCompany name of the retailer.
retailer_group_1STRINGFirst level group classification for the retailer.
retailer_group_2STRINGSecond level group classification for the retailer.
geo_regionSTRINGGeographical region of the ad request.
local_timezoneSTRINGLocal timezone of the ad request.
has_search_termINTEGERIndicates if a search term is present.
has_categoryINTEGERIndicates if a category is associated.
num_ads_consideredNUMERICNumber of ads considered for the request.
num_ads_servedNUMERICNumber of ads served.
num_ads_requestedNUMERICNumber of ads requested.
capped_num_ads_servedNUMERICCapped number of ads served.
capped_num_ads_requestedNUMERICCapped number of ads requested.
capped_num_requests_serving_max_adsNUMERICCapped number of requests serving the maximum number of ads.
num_requests_serving_max_adsNUMERICNumber of requests serving the maximum number of ads.
num_ad_requests_serving_no_adsNUMERICNumber of ad requests that served no ads.
num_ad_requests_serving_some_adsNUMERICNumber of ad requests that served some ads.
num_ad_requestsNUMERICTotal number of ad requests.
num_ad_requests_with_saturationNUMERICNumber of ad requests with saturation.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
campaign_nameSTRINGDisplay name of the Campaign.
supplier_idSTRINGIdentifier for the supplier.
supplier_nameSTRINGName of the supplier.
supplier_industrySTRINGIndustry category of the supplier.
supplier_business_identifierSTRINGBusiness identifier for the supplier.
supplier_company_nameSTRINGCompany name of the supplier.
product_codeSTRINGCode identifying the product.
content_standard_idSTRINGIdentifier for the content standard.
target_product_codeSTRINGTarget product code for the ad.
supplier_group_1STRINGFirst level group classification for the supplier.
supplier_group_2STRINGSecond level group classification for the supplier.
supplier_group_3STRINGThird level group classification for the supplier.
supplier_group_4STRINGFourth level group classification for the supplier.
sales_revenueNUMERICRevenue generated from sales.
ad_revenueNUMERICRevenue generated from ads.
ad_spendNUMERICAmount spent on ads.
impressionsNUMERICNumber of times ads were displayed.
clicksNUMERICNumber of times ads were clicked.
conversionsNUMERICNumber of conversions attributed to the ads.
unit_salesNUMERICNumber of units sold.
click_spendNUMERICAmount spent on clicks.
impression_spendNUMERICAmount spent per impression.
position_sumNUMERICSum of positions where the ad was displayed.
sales_revenue_usdFLOATRevenue generated from sales in USD.
ad_revenue_usdFLOATRevenue generated from ads in USD.
ad_spend_usdFLOATAmount spent on ads in USD.
placement_idSTRINGIdentifier for the ad placement.
wallet_idSTRINGIdentifier for the wallet associated with the ad.
last_event_loaded_atDATETIMEDate the row was inserted into the source system.
source_typeSTRINGName of source table.
SQL Query
select
  env,
  env_namespace,
  ingressed_at,
  ad_type,
  search_term,
  generic_search_term,
  reserved_search_term_flag,
  placement,
  platform,
  page_type,
  filter_mode,
  slot_id,
  category,
  catalog_id,
  catalog_name,
  retailer_id,
  retailer_name,
  retailer_industry,
  retailer_business_identifier,
  retailer_company_name,
  retailer_group_1,
  retailer_group_2,
  geo_region,
  local_timezone,
  has_search_term,
  has_category,
  num_ads_considered,
  num_ads_served,
  num_ads_requested,
  capped_num_ads_served,
  capped_num_ads_requested,
  capped_num_requests_serving_max_ads,
  num_requests_serving_max_ads,
  num_ad_requests_serving_no_ads,
  num_ad_requests_serving_some_ads,
  num_ad_requests,
  num_ad_requests_with_saturation,
  null as campaign_id,
  null as campaign_name, 
  null as supplier_id,
  null as supplier_name,
  null as supplier_industry,
  null as supplier_business_identifier,
  null as supplier_company_name,
  null as product_code,
  null as content_standard_id,
  null as target_product_code,
  null as supplier_group_1,
  null as supplier_group_2,
  null as supplier_group_3,
  null as supplier_group_4,
  null as sales_revenue,
  null as ad_revenue,
  null as ad_spend,
  null as impressions,
  null as clicks,
  null as conversions,
  null as unit_sales,
  null as click_spend,
  null as impression_spend,
  null as position_sum,
  null as sales_revenue_usd,
  null as ad_revenue_usd,
  null as ad_spend_usd,
  placement_id,
  null as wallet_id,
  null as last_event_loaded_at,
  &#39;ad_request_agg_ltz&#39; as source_type
from
  reporting.ad_request_agg_ltz_view
union all
select
  env,
  env_namespace,
  ingressed_at ,
  ad_type,
  search_term,
  generic_search_term,
  null as reserved_search_term_flag,
  placement,
  platform,
  null as page_type,
  null as filter_mode,
  slot_id,
  category,
  catalog_id,
  catalog_name,
  retailer_id,
  retailer_name,
  retailer_industry,
  retailer_business_identifier,
  retailer_company_name,
  retailer_group_1,
  retailer_group_2,
  geo_region,
  local_timezone,
  if(ifnull(search_term,&#39;&#39;) &lt;&gt; &#39;&#39;, 1, 0) as has_search_term,
  if(ifnull(category,&#39;&#39;)&lt;&gt; &#39;&#39;, 1, 0) as has_category,
  null as num_ads_considered,
  null as num_ads_served,
  null as num_ads_requested,
  null as capped_num_ads_served,
  null as capped_num_ads_requested,
  null as capped_num_requests_serving_max_ads,
  null as num_requests_serving_max_ads,
  null as num_ad_requests_serving_no_ads,
  null as num_ad_requests_serving_some_ads,
  null as num_ad_requests,
  null as num_ad_requests_with_saturation,
  campaign_id,
  campaign_name, 
  supplier_id,
  supplier_name,
  supplier_industry,
  supplier_business_identifier,
  supplier_company_name,
  product_code,
  content_standard_id,
  target_product_code,
  supplier_group_1,
  supplier_group_2,
  supplier_group_3,
  supplier_group_4,
  sales_revenue,
  ad_revenue,
  ad_spend,
  impressions,
  clicks,
  conversions,
  unit_sales,
  click_spend,
  impression_spend,
  position_sum,
  sales_revenue_usd,
  ad_revenue_usd,
  ad_spend_usd,
  placement_id,
  wallet_id,
  last_event_loaded_at,
  source_type
from
  reporting.realised_ad_agg_ltz_view

reporting.ad_request__realised_ad_view

  • retailer
  • namespace

Union of ad_request_agg_view and realised_ad_agg_view. Allows for convenient calculation of measures that require both Request and Realised Ad statistics (for example a ratio of impressions vs ads requested).

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to realised_ad_agg_view
Other Unique Key(s):
Partition: Refer to realised_ad_agg_view

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate when the ad request and realised ad data was ingested.
ad_typeINTEGERType identifier for the ad format or placement type.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
generic_search_termSTRINGGeneric version of the search term, if applicable.
reserved_search_term_flagSTRINGIndicates if the search term is a reserved keyword.
placementSTRINGSpecific placement or location of the ad.
platformSTRINGPlatform where the ad is served (e.g., web, mobile).
page_typeINTEGERIdentifier for the type of page the ad is displayed on.
filter_modeINTEGERMode of filtering applied to the ad request.
slot_idSTRINGIdentifier for the ad slot.
categorySTRINGCategory of the ad content.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the product catalog.
retailer_idSTRINGInternal identifier of the Retailer (from the source system).
retailer_nameSTRINGDisplay name of the Retailer.
retailer_industrySTRINGIndustry category of the retailer.
retailer_business_identifierSTRINGBusiness identifier for the retailer.
retailer_company_nameSTRINGCompany name of the retailer.
retailer_group_1STRINGFirst level group classification for the retailer.
retailer_group_2STRINGSecond level group classification for the retailer.
geo_regionSTRINGGeographical region of the ad request.
local_timezoneSTRINGLocal timezone of the ad request.
has_search_termINTEGERIndicates if a search term is present.
has_categoryINTEGERIndicates if a category is associated.
num_ads_consideredNUMERICNumber of ads considered for the request.
num_ads_servedNUMERICNumber of ads served.
num_ads_requestedNUMERICNumber of ads requested.
capped_num_ads_servedNUMERICCapped number of ads served.
capped_num_ads_requestedNUMERICCapped number of ads requested.
capped_num_requests_serving_max_adsNUMERICCapped number of requests serving the maximum number of ads.
num_requests_serving_max_adsNUMERICNumber of requests serving the maximum number of ads.
num_ad_requests_serving_no_adsNUMERICNumber of ad requests that served no ads.
num_ad_requests_serving_some_adsNUMERICNumber of ad requests that served some ads.
num_ad_requestsNUMERICTotal number of ad requests.
num_ad_requests_with_saturationNUMERICNumber of ad requests with saturation.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
campaign_nameSTRINGDisplay name of the Campaign.
supplier_idSTRINGIdentifier for the supplier.
supplier_nameSTRINGName of the supplier.
supplier_industrySTRINGIndustry category of the supplier.
supplier_business_identifierSTRINGBusiness identifier for the supplier.
supplier_company_nameSTRINGCompany name of the supplier.
product_codeSTRINGCode identifying the product.
content_standard_idSTRINGIdentifier for the content standard.
target_product_codeSTRINGTarget product code for the ad.
supplier_group_1STRINGFirst level group classification for the supplier.
supplier_group_2STRINGSecond level group classification for the supplier.
supplier_group_3STRINGThird level group classification for the supplier.
supplier_group_4STRINGFourth level group classification for the supplier.
sales_revenueNUMERICRevenue generated from sales.
ad_revenueNUMERICRevenue generated from ads.
ad_spendNUMERICAmount spent on ads.
impressionsNUMERICNumber of times ads were displayed.
clicksNUMERICNumber of times ads were clicked.
conversionsNUMERICNumber of conversions attributed to the ads.
unit_salesNUMERICNumber of units sold.
click_spendNUMERICAmount spent on clicks.
impression_spendNUMERICAmount spent per impression.
position_sumNUMERICSum of positions where the ad was displayed.
sales_revenue_usdFLOATRevenue generated from sales in USD.
ad_revenue_usdFLOATRevenue generated from ads in USD.
ad_spend_usdFLOATAmount spent on ads in USD.
placement_idSTRINGIdentifier for the ad placement.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
source_typeSTRINGName of source table.
SQL Query
select
  env,
  env_namespace,
  ingressed_at,
  ad_type,
  search_term,
  generic_search_term,
  reserved_search_term_flag,
  placement,
  platform,
  page_type,
  filter_mode,
  slot_id,
  category,
  catalog_id,
  catalog_name,
  retailer_id,
  retailer_name,
  retailer_industry,
  retailer_business_identifier,
  retailer_company_name,
  retailer_group_1,
  retailer_group_2,
  geo_region,
  local_timezone,
  has_search_term,
  has_category,
  num_ads_considered,
  num_ads_served,
  num_ads_requested,
  capped_num_ads_served,
  capped_num_ads_requested,
  capped_num_requests_serving_max_ads,
  num_requests_serving_max_ads,
  num_ad_requests_serving_no_ads,
  num_ad_requests_serving_some_ads,
  num_ad_requests,
  num_ad_requests_with_saturation,
  null as campaign_id,
  null as campaign_name, 
  null as supplier_id,
  null as supplier_name,
  null as supplier_industry,
  null as supplier_business_identifier,
  null as supplier_company_name,
  null as product_code,
  null as content_standard_id,
  null as target_product_code,
  null as supplier_group_1,
  null as supplier_group_2,
  null as supplier_group_3,
  null as supplier_group_4,
  null as sales_revenue,
  null as ad_revenue,
  null as ad_spend,
  null as impressions,
  null as clicks,
  null as conversions,
  null as unit_sales,
  null as click_spend,
  null as impression_spend,
  null as position_sum,
  null as sales_revenue_usd,
  null as ad_revenue_usd,
  null as ad_spend_usd,
  placement_id,
  null as wallet_id,
  null as last_event_loaded_at,
  &#39;ad_request_agg&#39; as source_type
from
  reporting.ad_request_agg_view
union all
select
  env,
  env_namespace,
  ingressed_at ,
  ad_type,
  search_term,
  generic_search_term,
  null as reserved_search_term_flag,
  placement,
  platform,
  null as page_type,
  null as filter_mode,
  slot_id,
  category,
  catalog_id,
  catalog_name,
  retailer_id,
  retailer_name,
  retailer_industry,
  retailer_business_identifier,
  retailer_company_name,
  retailer_group_1,
  retailer_group_2,
  geo_region,
  local_timezone,
  if(ifnull(search_term,&#39;&#39;) &lt;&gt; &#39;&#39;, 1, 0) as has_search_term,
  if(ifnull(category,&#39;&#39;)&lt;&gt; &#39;&#39;, 1, 0) as has_category,
  null as num_ads_considered,
  null as num_ads_served,
  null as num_ads_requested,
  null as capped_num_ads_served,
  null as capped_num_ads_requested,
  null as capped_num_requests_serving_max_ads,
  null as num_requests_serving_max_ads,
  null as num_ad_requests_serving_no_ads,
  null as num_ad_requests_serving_some_ads,
  null as num_ad_requests,
  null as num_ad_requests_with_saturation,
  campaign_id,
  campaign_name, 
  supplier_id,
  supplier_name,
  supplier_industry,
  supplier_business_identifier,
  supplier_company_name,
  product_code,
  content_standard_id,
  target_product_code,
  supplier_group_1,
  supplier_group_2,
  supplier_group_3,
  supplier_group_4,
  sales_revenue,
  ad_revenue,
  ad_spend,
  impressions,
  clicks,
  conversions,
  unit_sales,
  click_spend,
  impression_spend,
  position_sum,
  sales_revenue_usd,
  ad_revenue_usd,
  ad_spend_usd,
  placement_id,
  wallet_id,
  last_event_loaded_at,
  source_type
from
  reporting.realised_ad_agg_view

reporting.ad_request_agg

  • retailer
  • namespace

Request data (aggregated).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, ingressed_at, retailer_id, catalog_id, search_term, placement, platform, reserved_search_term_flag, generic_search_term, ad_type, page_type, filter_mode, slot_ids, category, has_search_term, has_category
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = ad_request_agg.env_namespace;
retailer on retailer.env_namespace = ad_request_agg.env_namespace and retailer.retailer_id = ad_request_agg.retailer_id;
catalog on catalog.env_namespace = ad_request_agg.env_namespace and catalog.catalog_id = ad_request_agg.catalog_id;
placement on placement.env_namespace = ad_request_agg.env_namespace and placement.placement_id = ad_request_agg.placement_id;
search_term on search_term.env_namespace = ad_request_agg.env_namespace and search_term.retailer_id = ad_request_agg.retailer_id and search_term.search_term = ad_request_agg.search_term;
category on category.env_namespace = ad_request_agg.env_namespace and category.category_id = ad_request_agg.category and category.retailer_id = ad_request_agg.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Requests were received.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
reserved_search_term_flagSTRINGNot in use.
generic_search_termSTRINGSame as SearchTerm except leading and trailing whitespace is removed to improve consolidation.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
page_typeINTEGERLegacy, superseded by Placement.
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
slot_idsSTRINGSlot ids.
categorySTRINGCategory being targeted.
has_search_termINTEGERFlag to indicate if the Request is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Request is targeting a Category.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
num_ads_consideredNUMERICTotal number of Ad candidates that were considered by relevancy algorithms.
num_ads_servedNUMERICTotal number of Ads that were served back.
num_ads_requestedNUMERICTotal number of Ads that were requested by the Requests.
capped_num_ads_servedNUMERICTotal number of Ads that were served back with Cap applied per Request.
capped_num_ads_requestedNUMERICTotal number of Ads that were requested with Cap applied per Request.
capped_num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_ad_requests_serving_no_adsNUMERICTotal number of Requests where no Ads were served.
num_ad_requests_serving_some_adsNUMERICTotal number of Requests where at least 1 Ad was served.
num_ad_requestsNUMERICTotal number of Requests.
num_ad_requests_with_saturationNUMERICTotal number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested).
placement_idSTRINGInternal identifier of the Placement (from the source system).
namespaceSTRINGName of the Namespace.

reporting.ad_request_agg_ltz_view

  • namespace

Request view (aggregated in local timezone). Decorated version of ad_request_agg.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to ad_request_agg
Other Unique Key(s):
Partition: Refer to ad_request_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
generic_search_termSTRINGSame as SearchTerm except leading and trailing whitespace is removed to improve consolidation.
reserved_search_term_flagSTRINGNot in use.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the Catalog.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
retailer_industrySTRINGIndustry of the Retailer.
retailer_business_identifierSTRINGImplementation specific generic label.
retailer_company_nameSTRINGCompany name of the Retailer.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
namespaceSTRINGName of the Namespace.
ad_type_nameSTRINGHuman readable name for the ad type
num_ads_consideredNUMERICTotal number of Ad candidates that were considered by relevancy algorithms.
num_ads_servedNUMERICTotal number of Ads that were served back.
num_ads_requestedNUMERICTotal number of Ads that were requested by the Requests.
capped_num_ads_servedNUMERICTotal number of Ads that were served back with Cap applied per Request.
capped_num_ads_requestedNUMERICTotal number of Ads that were requested with Cap applied per Request.
capped_num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_ad_requests_serving_no_adsNUMERICTotal number of Requests where no Ads were served.
num_ad_requests_serving_some_adsNUMERICTotal number of Requests where at least 1 Ad was served.
num_ad_requestsNUMERICTotal number of Requests.
num_ad_requests_with_saturationNUMERICTotal number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested).
placement_idSTRINGInternal identifier of the Placement (from the source system).
SQL Query
select
  far.env env,
  far.env_namespace env_namespace,
  far.ingressed_at as ingressed_at,
  far.ad_type,
  far.search_term as search_term,
  far.generic_search_term as generic_search_term,
  far.reserved_search_term_flag reserved_search_term_flag,
  far.placement placement,
  far.platform platform,
  far.page_type,
  far.filter_mode,
  far.slot_ids as slot_id,
  far.category as category,
  far.catalog_id catalog_id,
  dc.catalog_name as catalog_name,
  far.retailer_id as retailer_id,
  dr.retailer_name as retailer_name,
  dr.retailer_industry as retailer_industry,
  dr.retailer_business_identifier as retailer_business_identifier,
  dr.retailer_company_name as retailer_company_name,
  dr.retailer_group_1 as retailer_group_1,
  dr.retailer_group_2 as retailer_group_2,
  rn.geo_region as geo_region,
  rn.local_timezone as local_timezone,
  if(far.search_term is not null, 1, 0) as has_search_term,
  if(far.category is not null, 1, 0) as has_category,
  far.namespace namespace,
  ifnull(ad.ad_type_name, &#39;&#39;) ad_type_name,
  far.num_ads_considered,
  far.num_ads_served,
  far.num_ads_requested,
  far.capped_num_ads_served,
  far.capped_num_ads_requested,
  far.capped_num_requests_serving_max_ads,
  far.num_requests_serving_max_ads,
  far.num_ad_requests_serving_no_ads,
  far.num_ad_requests_serving_some_ads,
  far.num_ad_requests,
  far.num_ad_requests_with_saturation,
  far.placement_id
from
  reporting.ad_request_agg_ltz far
  left join reporting.catalog dc on far.catalog_id = dc.catalog_id 
                                                        and far.env_namespace = dc.env_namespace
  left join reporting.retailer dr on far.retailer_id = dr.retailer_id
                                                        and dr.env_namespace = far.env_namespace
  left join reporting.env_namespace rn on far.env_namespace = rn.env_namespace
  left join reporting.view_ad_type ad on far.ad_type = ad.ad_type
where
  far.ingressed_at &gt;= &#39;2000-01-01&#39;

reporting.ad_request_agg_view

  • retailer
  • namespace

Request view (aggregated). Decorated version of ad_request_agg.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to ad_request_agg
Other Unique Key(s):
Partition: Refer to ad_request_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
generic_search_termSTRINGSame as SearchTerm except leading and trailing whitespace is removed to improve consolidation.
reserved_search_term_flagSTRINGNot in use.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
filter_modeINTEGERThe filterMode used to structure the productFilters in the ad request. Defaults in OR_AND if not specified. (OR_AND, AND_OR).
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the Catalog.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
retailer_industrySTRINGIndustry of the Retailer.
retailer_business_identifierSTRINGImplementation specific generic label.
retailer_company_nameSTRINGCompany name of the Retailer.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
namespaceSTRINGName of the Namespace.
ad_type_nameSTRINGHuman readable name for the ad type
num_ads_consideredNUMERICTotal number of Ad candidates that were considered by relevancy algorithms.
num_ads_servedNUMERICTotal number of Ads that were served back.
num_ads_requestedNUMERICTotal number of Ads that were requested by the Requests.
capped_num_ads_servedNUMERICTotal number of Ads that were served back with Cap applied per Request.
capped_num_ads_requestedNUMERICTotal number of Ads that were requested with Cap applied per Request.
capped_num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_requests_serving_max_adsNUMERICTotal number of Requests where the number of Ads requested was served in full.
num_ad_requests_serving_no_adsNUMERICTotal number of Requests where no Ads were served.
num_ad_requests_serving_some_adsNUMERICTotal number of Requests where at least 1 Ad was served.
num_ad_requestsNUMERICTotal number of Requests.
num_ad_requests_with_saturationNUMERICTotal number of Requests that served at least 4 Ads or filled the entire Request (if < 4 were requested).
placement_idSTRINGInternal identifier of the Placement (from the source system).
SQL Query
select
  far.env env,
  far.env_namespace env_namespace,
  far.ingressed_at as ingressed_at,
  far.ad_type,
  far.search_term as search_term,
  far.generic_search_term as generic_search_term,
  far.reserved_search_term_flag reserved_search_term_flag,
  far.placement placement,
  far.platform platform,
  far.page_type,
  far.filter_mode,
  far.slot_ids as slot_id,
  far.category as category,
  far.catalog_id catalog_id,
  dc.catalog_name as catalog_name,
  far.retailer_id as retailer_id,
  dr.retailer_name as retailer_name,
  dr.retailer_industry as retailer_industry,
  dr.retailer_business_identifier as retailer_business_identifier,
  dr.retailer_company_name as retailer_company_name,
  dr.retailer_group_1 as retailer_group_1,
  dr.retailer_group_2 as retailer_group_2,
  rn.geo_region as geo_region,
  rn.local_timezone as local_timezone,
  if(far.search_term is not null, 1, 0) as has_search_term,
  if(far.category is not null, 1, 0) as has_category,
  far.namespace namespace,
  ifnull(ad.ad_type_name, &#39;&#39;) ad_type_name,
  far.num_ads_considered,
  far.num_ads_served,
  far.num_ads_requested,
  far.capped_num_ads_served,
  far.capped_num_ads_requested,
  far.capped_num_requests_serving_max_ads,
  far.num_requests_serving_max_ads,
  far.num_ad_requests_serving_no_ads,
  far.num_ad_requests_serving_some_ads,
  far.num_ad_requests,
  far.num_ad_requests_with_saturation,
  far.placement_id
from
  reporting.ad_request_agg far
  left join reporting.catalog dc on far.catalog_id = dc.catalog_id 
                                                        and far.env_namespace = dc.env_namespace
  left join reporting.retailer dr on far.retailer_id = dr.retailer_id
                                                        and dr.env_namespace = far.env_namespace
  left join reporting.env_namespace rn on far.env_namespace = rn.env_namespace
  left join reporting.view_ad_type ad on far.ad_type = ad.ad_type
where
  far.ingressed_at &gt;= &#39;2000-01-01&#39;

reporting.campaign

  • supplier
  • retailer
  • namespace

Campaign data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: campaign_id, env_namespace
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = campaign.env_namespace;
retailer on retailer.env_namespace = campaign.env_namespace and retailer.retailer_id = campaign.retailer_id;
supplier on supplier.env_namespace = campaign.env_namespace and supplier.supplier_id = campaign.supplier_id;
wallet on wallet.env_namespace = campaign.env_namespace and wallet.wallet_id = campaign.wallet_id;

Column NameData TypeDescription
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
campaign_nameSTRINGName of the Campaign.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_nameSTRINGName of the Retailer.
supplier_nameSTRINGName of the Supplier.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
is_ftaSTRINGFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
fta_costNUMERICTotal amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign.
wallet_nameSTRINGName of the Wallet.
wallet_external_idSTRINGImplementation specific generic label.
wallet_archivedBOOLEANArchived status of the Wallet.
wallet_credit_limitNUMERICAmount the Wallet may go into credit.
wallet_currency_codeSTRINGISO 4217 currency code
wallet_total_purchased_creditsNUMERICTotal credits made to the Wallet.
wallet_available_balanceNUMERICCurrent available balance of the Wallet.
wallet_credit_limit_usdNUMERICwallet_credit_limit in USD (current exchange rate only).
wallet_available_balance_usdNUMERICwallet_available_balance in USD (current exchange rate only).
wallet_total_purchased_credits_usdNUMERICwallet_total_purchased_credits in USD (current exchange rate only).
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
campaign_active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
campaign_created_atTIMESTAMPDate the record was created in the source system.
campaign_updated_atTIMESTAMPDate the record was updated in the source system.
campaign_placementsSTRINGThe Campaign's selected Placement.
campaign_total_spendNUMERICTotal AdSpend to date for the Campaign.
campaign_total_spend_usdNUMERICcampaign_total_spend in USD (current exchange rate only).
campaign_max_cost_per_clickNUMERICThe maximum cost per click set for the Campaign.
campaign_max_total_spendNUMERICThe maximum total spend set for the Campaign.
campaign_max_daily_spendNUMERICThe maximum daily spend set for the Campaign.
campaign_impression_goalNUMERICThe maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend.
campaign_catalog_productsSTRINGThe Catalog's Products within the Campaign.
campaign_attr_1STRINGCampaign user defined attribute 1.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
team_idSTRINGInternal identifier of the Team (from the source system).
retailer_ad_spend_typeSTRINGType of spending if Retailer Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend).
supplier_ad_spend_typeSTRINGType of spending if Supplier Campaign (Always On, Daily Spend, Fixed Spend, Fixed Tenancy, Total Spend).
budgetNUMERICThe Campaign's budget as set by the Campaign's manager.
targeted_filtersSTRINGThe filters selected by an advertiser that their campaign will appear for. Used for fixed tenancy campaigns.
location_filtersSTRINGFilters on the campaign specific to a location if a location filter class is created.
filter_whitelistsSTRINGThe filters selected by an advertiser that the campaign can appear for. The campaign will only appear where eligible regardless of the advertiser's selection.
cross_sell_settingsSTRINGThe cross-sell targeting selection in the campaign.
upsell_settingsSTRINGThe Upsell targeting selection in the campaign if applicable.
categoriesSTRINGComma separated list of Categories targeted by the Campaign.
catalog_countINTEGERNumber of Catalogs being targeted by the Campaign.
catalog_idsSTRINGCatalog ids.
search_termsSTRINGComma separated list of SearchTerms targeted by the Campaign.
has_search_termsBOOLEANFlag to indicate if the Campaign is targeting SearchTerms.
last_spend_dateDATEMost recent date that AdSpend was incurred by the Supplier.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
product_type_codeSTRINGProduct type code.
cta_textSTRINGCTA text.
suggested_search_termsSTRINGSuggested search terms.
has_suggested_search_termsBOOLEANFlag to indicate that any suggested search terms exist.
is_currentBOOLEANFlag if the row is the latest version in the source system.
active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
namespaceSTRINGName of the Namespace.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
currency_codeSTRINGISO 4217 currency code

reporting.catalog

  • retailer
  • namespace

Catalog data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: catalog_id, env_namespace
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = catalog.env_namespace;
retailer on retailer.env_namespace = catalog.env_namespace and retailer.retailer_id = catalog.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_nameSTRINGName of the Catalog.
retailer_nameSTRINGName of the Retailer.
currency_codeSTRINGISO 4217 currency code
namespaceSTRINGName of the Namespace.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.

reporting.category

  • namespace

Category data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, retailer_id, category_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = category.env_namespace;
retailer on retailer.env_namespace = category.env_namespace and retailer.retailer_id = category.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
category_idSTRINGCategory being targeted.
namespaceSTRINGName of the Namespace.
category_labelSTRINGLabel for the Category (more descriptive than the typical id provided).
cat_level_1STRINGLevel 1 component of the category_label (delimited by >).
cat_level_2STRINGLevel 2 component of the category_label (delimited by >).
cat_level_3STRINGLevel 3 component of the category_label (delimited by >).
cat_level_4STRINGLevel 4 component of the category_label (delimited by >).
cat_level_5STRINGLevel 5 component of the category_label (delimited by >).
cat_level_6STRINGLevel 6 component of the category_label (delimited by >).
cat_level_7STRINGLevel 7 component of the category_label (delimited by >).
category_label_countINTEGERCount(category_label) across env_namespace, retailer_id, category_id.
source_nameSTRINGSource name.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
retailer_nameSTRINGName of the Retailer.

reporting.deduped_product

  • retailer
  • namespace

Deduped product data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, normalised_product_code
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = deduped_product.env_namespace;
catalog on catalog.env_namespace = deduped_product.env_namespace and catalog.catalog_id = deduped_product.catalog_id;
retailer on retailer.env_namespace = deduped_product.env_namespace and retailer.retailer_id = deduped_product.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
product_nameSTRINGName of the Product.
product_typeSTRINGType of the Product.
retailer_nameSTRINGName of the Retailer.
currency_codeSTRINGISO 4217 currency code
product_tagsSTRINGTags associated with the Product.
product_image_urlSTRINGURL to an image of the Product for the Ad.
brandSTRINGBrand of the Product.
google_product_taxonomySTRINGGoogle taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
namespaceSTRINGName of the Namespace.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.

reporting.enhanced_attribution_agg

  • retailer
  • namespace

Enhanced Attribution data (aggregated, both models).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = enhanced_attribution_agg.env_namespace;
retailer on retailer.env_namespace = enhanced_attribution_agg.env_namespace and retailer.retailer_id = enhanced_attribution_agg.retailer_id;
campaign on campaign.env_namespace = enhanced_attribution_agg.env_namespace and campaign.campaign_id = enhanced_attribution_agg.campaign_id;
product on product.env_namespace = enhanced_attribution_agg.env_namespace and product.product_code = enhanced_attribution_agg.product_code;
search_term on search_term.env_namespace = enhanced_attribution_agg.env_namespace and search_term.retailer_id = enhanced_attribution_agg.retailer_id and search_term.search_term = enhanced_attribution_agg.search_term;
category on category.env_namespace = enhanced_attribution_agg.env_namespace and category.category_id = enhanced_attribution_agg.category and category.retailer_id = enhanced_attribution_agg.retailer_id;
placement on placement.env_namespace = enhanced_attribution_agg.env_namespace and placement.placement = enhanced_attribution_agg.placement;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
yyyymmddSTRINGYear+month+day of ingressed_at.
yyyymmSTRINGYear+month of ingressed_at.
yyyySTRINGYear of ingressed_at.
week_start_dateDATEFirst day of the week of the ingressed_at date.
order_dateDATEDate of the Orders.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
category_idSTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
attribution_modelINTEGERIndicate if data is from first or second model.
order_typeSTRINGType of the Order.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
total_click_salesNUMERICDirect unit sales + halo unit sales.
total_click_sales_valueNUMERICDirect sales value + halo sales value.
total_unit_salesNUMERICTotal click sales + view through unit sales.
total_sales_valueNUMERICTotal click sales value + view through sales value.
total_conversionsNUMERICTotal click conversions + view through conversions.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.

reporting.enhanced_attribution_agg_ltz_view

  • namespace

Enhanced Attribution view (aggregated, both models in local timezone). Decorated version of enhanced_attribution_agg.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to enhanced_attribution_agg
Other Unique Key(s):
Partition: Refer to enhanced_attribution_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
yyyymmddSTRINGYear+month+day of ingressed_at.
yyyymmSTRINGYear+month of ingressed_at.
yyyySTRINGYear of ingressed_at.
week_start_dateDATEFirst day of the week of the ingressed_at date.
order_dateDATEDate of the Orders.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
attribution_modelINTEGERIndicate if data is from first or second model.
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
total_click_salesNUMERICDirect unit sales + halo unit sales.
total_click_sales_valueNUMERICDirect sales value + halo sales value.
total_unit_salesNUMERICTotal click sales + view through unit sales.
total_sales_valueNUMERICTotal click sales value + view through sales value.
total_conversionsNUMERICTotal click conversions + view through conversions.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
category_idSTRINGCategory being targeted.
campaign_nameSTRINGName of the Campaign.
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
cta_textSTRINGCTA text.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
team_typeSTRINGType of Team (RETAILER or SUPPLIER).
company_nameSTRINGCompany name of the Team.
supplier_nameSTRINGName of the Supplier.
category_nameSTRINGName of the category.
wallet_nameSTRINGName of the Wallet.
wallet_available_balanceNUMERICCurrent available balance of the Wallet.
supplier_company_nameSTRINGCompany name of the Supplier.
wallet_capture_dateDATEDate the Wallet details were captured on.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the Catalog.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution.
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).
attribution_time_frameNUMERICDetermines how many days of attribution results should be stored for the first model.
attribution_time_frame_2NUMERICDetermines how many days of attribution results should be stored for the second model.
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
is_ftaBOOLEANFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
SQL Query

select
  DISTINCT
  halo.* EXCEPT(catalog_id,category_id,retailer_id,supplier_id,imp_halo_unit_sales,imp_halo_sales_value,imp_halo_conversions,attributable_impressions,attributable_clicks,attributable_ad_spend),
  cast(halo.category_id as string) category_id,
  dc.campaign_name campaign_name,
  dc.campaign_start_date AS campaign_start_date,
  dc.campaign_end_date AS campaign_end_date,
  dc.campaign_type campaign_type,
  dc.campaign_subtype campaign_subtype,
  dc.wallet_id wallet_id,
  dc.active_state active_state,
  dc.valid_state valid_state,
  dc.cta_text,
  halo.supplier_id supplier_id,
  halo.retailer_id retailer_id,
  dr.retailer_name,
  dr.team_type team_type,
  dr.retailer_company_name company_name,
  ds.supplier_name supplier_name,
  cat.category_label AS category_name,
  dw.wallet_name wallet_name,
  dw.available_balance AS wallet_available_balance,
  ds.supplier_company_name AS supplier_company_name,
  DATE(dw.wallet_capture_date) AS wallet_capture_date,
  rn.geo_region,
  rn.local_timezone,
  if(ifnull(halo.search_term,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_search_term,
  if(ifnull(cat.category_label,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_category,
  halo.catalog_id,
  dca.catalog_name,
  dr.enhanced_attribution_flag,
  dr.enhanced_attribution_flag_2,
  dr.retailer_taxonomy_halo,
  dr.retailer_taxonomy_halo_2,
  dr.view_attribution_window,
  dr.view_attribution_window_2,
  dr.click_attribution_window,
  dr.click_attribution_window_2,
  dr.attribution_time_frame,
  dr.attribution_time_frame_2,
  halo.imp_halo_unit_sales,
  halo.imp_halo_sales_value,
  halo.imp_halo_conversions,
  halo.attributable_impressions,
  halo.attributable_clicks,
  halo.attributable_ad_spend,
  COALESCE(UPPER(dc.is_fta) = &#39;TRUE&#39;, FALSE) AS is_fta
from reporting.enhanced_attribution_agg_ltz halo
  left join reporting.campaign dc on halo.campaign_id = dc.campaign_id
                                                            and halo.env_namespace = dc.env_namespace
  left join reporting.retailer dr on halo.env_namespace  =  dr.env_namespace
                                                            and halo.retailer_id = dr.retailer_id
  left join reporting.supplier ds on halo.env_namespace  =  ds.env_namespace
                                                            and halo.supplier_id = ds.supplier_id
  left join reporting.category cat on cat.category_id  = halo.category_id
                                                            and cat.env_namespace = halo.env_namespace
                                                            and cat.retailer_id = dr.retailer_id
  left join reporting.wallet dw on dw.env_namespace = dc.env_namespace
                                                        and dw.wallet_id = dc.wallet_id
  left join reporting.env_namespace rn on halo.env_namespace = rn.env_namespace
  left join reporting.catalog dca on  halo.catalog_id = dca.catalog_id
        and halo.env_namespace = dca.env_namespace
        and dca.is_current
where rn.geo_region &lt;&gt; &#39;NotProductionData&#39;

reporting.enhanced_attribution_agg_view

  • retailer
  • namespace

Enhanced Attribution view (aggregated, both models). Decorated version of enhanced_attribution_agg.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to enhanced_attribution_agg
Other Unique Key(s):
Partition: Refer to enhanced_attribution_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate when the attribution data was ingested.
yyyymmddSTRINGYear+month+day format of ingressed_at date.
yyyymmSTRINGYear+month format of ingressed_at date.
yyyySTRINGYear of the ingressed_at date.
week_start_dateDATEStart date of the week for the ingressed_at date.
order_dateDATEDate of the order.
normalised_product_codeSTRINGStandardized unique identifier for the Product across catalogs.
product_codeSTRINGProduct code.
product_nameSTRINGName of the product.
brandSTRINGBrand of the product.
retailer_taxonomySTRINGRetailer taxonomy category.
halo_taxonomySTRINGHalo taxonomy category.
halo_taxonomy_levelINTEGERLevel of the halo taxonomy.
campaign_idSTRINGID of the campaign.
search_termSTRINGDEPRECATED. Please switch to using keyword.
placementSTRINGPlacement of the ad.
platformSTRINGPlatform where the ad is displayed.
page_typeINTEGERType of the page where the ad is displayed.
attribution_modelINTEGERModel of attribution used.
order_typeSTRINGType of the order.
impressionsNUMERICNumber of impressions.
clicksNUMERICNumber of clicks.
ad_spendNUMERICAmount spent on ads.
direct_unit_salesNUMERICDirect unit sales.
direct_sales_valueNUMERICDirect sales value.
direct_conversionsNUMERICDirect conversions.
view_through_unit_salesNUMERICView-through unit sales.
view_through_sales_valueNUMERICView-through sales value.
view_through_conversionsNUMERICView-through conversions.
halo_unit_salesNUMERICHalo unit sales.
halo_sales_valueNUMERICHalo sales value.
halo_conversionsNUMERICHalo conversions.
total_click_salesNUMERICTotal sales from clicks.
total_click_sales_valueNUMERICTotal sales value from clicks.
total_unit_salesNUMERICTotal unit sales.
total_sales_valueNUMERICTotal sales value.
total_conversionsNUMERICTotal conversions.
retailer_group_1STRINGFirst retailer group.
retailer_group_2STRINGSecond retailer group.
supplier_group_1STRINGFirst supplier group.
supplier_group_2STRINGSecond supplier group.
supplier_group_3STRINGThird supplier group.
supplier_group_4STRINGFourth supplier group.
enable_sales_metricsBOOLEANFlag to enable sales metrics.
category_idSTRINGID of the category.
campaign_nameSTRINGName of the campaign.
campaign_start_dateTIMESTAMPStart date of the campaign.
campaign_end_dateTIMESTAMPEnd date of the campaign.
campaign_typeSTRINGType of the campaign.
campaign_subtypeSTRINGSubtype of the campaign.
wallet_idSTRINGID of the wallet.
active_stateSTRINGActive state of the campaign.
valid_stateSTRINGValid state of the campaign.
cta_textSTRINGCall to action text.
supplier_idSTRINGID of the supplier.
retailer_idSTRINGInternal identifier of the Retailer (from the source system).
retailer_nameSTRINGDisplay name of the Retailer.
team_typeSTRINGType of the team.
company_nameSTRINGName of the company.
supplier_nameSTRINGName of the supplier.
category_nameSTRINGName of the category.
wallet_nameSTRINGName of the wallet.
wallet_available_balanceNUMERICAvailable balance in the wallet.
supplier_company_nameSTRINGCompany name of the supplier.
wallet_capture_dateDATEDate when the wallet was captured.
geo_regionSTRINGGeographical region.
local_timezoneSTRINGLocal timezone of the region.
has_search_termINTEGERFlag indicating presence of search term.
has_categoryINTEGERFlag indicating presence of category.
catalog_idSTRINGID of the catalog.
catalog_nameSTRINGName of the catalog.
enhanced_attribution_flagSTRINGFlag for enhanced attribution.
enhanced_attribution_flag_2STRINGSecond flag for enhanced attribution.
retailer_taxonomy_haloSTRINGRetailer taxonomy halo category.
retailer_taxonomy_halo_2STRINGSecond retailer taxonomy halo category.
view_attribution_windowNUMERICView attribution window.
view_attribution_window_2NUMERICSecond view attribution window.
click_attribution_windowNUMERICClick attribution window.
click_attribution_window_2NUMERICSecond click attribution window.
attribution_time_frameNUMERICAttribution time frame.
attribution_time_frame_2NUMERICSecond attribution time frame.
imp_halo_unit_salesNUMERICUnit sales from halo impression Attributions.
imp_halo_sales_valueNUMERICRevenue from halo impression Attributions.
imp_halo_conversionsNUMERICConversions from halo impression Attributions.
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
is_ftaBOOLEANFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
SQL Query

select
  DISTINCT
  halo.* EXCEPT(catalog_id,category_id,retailer_id,supplier_id,imp_halo_unit_sales,imp_halo_sales_value,imp_halo_conversions,attributable_impressions,attributable_clicks,attributable_ad_spend),

  cast(halo.category_id as string) category_id,
  dc.campaign_name campaign_name,
  dc.campaign_start_date AS campaign_start_date,
  dc.campaign_end_date AS campaign_end_date,
  dc.campaign_type campaign_type,
  dc.campaign_subtype campaign_subtype,
  dc.wallet_id wallet_id,
  dc.active_state active_state,
  dc.valid_state valid_state,
  dc.cta_text,
  halo.supplier_id supplier_id,
  halo.retailer_id retailer_id,
  dr.retailer_name,
  dr.team_type team_type,
  dr.retailer_company_name company_name,
  ds.supplier_name supplier_name,
  cat.category_label AS category_name,
  dw.wallet_name wallet_name,
  dw.available_balance AS wallet_available_balance,
  ds.supplier_company_name AS supplier_company_name,
  DATE(dw.wallet_capture_date) AS wallet_capture_date,
  rn.geo_region,
  rn.local_timezone,
  if(ifnull(halo.search_term,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_search_term,
  if(ifnull(cat.category_label,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_category,
  halo.catalog_id,
  dca.catalog_name,
  dr.enhanced_attribution_flag,
  dr.enhanced_attribution_flag_2,
  dr.retailer_taxonomy_halo,
  dr.retailer_taxonomy_halo_2,
  dr.view_attribution_window,
  dr.view_attribution_window_2,
  dr.click_attribution_window,
  dr.click_attribution_window_2,
  dr.attribution_time_frame,
  dr.attribution_time_frame_2,
  halo.imp_halo_unit_sales,
  halo.imp_halo_sales_value,
  halo.imp_halo_conversions,
  halo.attributable_impressions,
  halo.attributable_clicks,
  halo.attributable_ad_spend,
  COALESCE(UPPER(dc.is_fta) = &#39;TRUE&#39;, FALSE) AS is_fta
from reporting.enhanced_attribution_agg halo
  left join reporting.campaign dc on halo.campaign_id = dc.campaign_id
                                                            and halo.env_namespace = dc.env_namespace
  left join reporting.retailer dr on halo.env_namespace  =  dr.env_namespace
                                                            and halo.retailer_id = dr.retailer_id
  left join reporting.supplier ds on halo.env_namespace  =  ds.env_namespace
                                                            and halo.supplier_id = ds.supplier_id
  left join reporting.category cat on cat.category_id  = halo.category_id
                                                            and cat.env_namespace = halo.env_namespace
                                                            and cat.retailer_id = dr.retailer_id
  left join reporting.wallet dw on dw.env_namespace = dc.env_namespace
                                                        and dw.wallet_id = dc.wallet_id
  left join reporting.env_namespace rn on halo.env_namespace = rn.env_namespace
  left join reporting.catalog dca on  halo.catalog_id = dca.catalog_id
      and halo.env_namespace = dca.env_namespace
      and dca.is_current
where rn.geo_region &lt;&gt; &#39;NotProductionData&#39;

reporting.env_namespace

  • namespace

Namespace data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace
Other Unique Key(s):
Partition: None

Foreign Key(s):
None

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
zone_idSTRINGTimezone (TZ) identifier standardised by IANA time zone database.
banner_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on banner campaigns.
display_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on display campaigns.
wildcard_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on wildcard campaigns.
brand_page_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on brand page campaigns.
shotgun_banner_enable_sales_metricsBOOLEANFlag to indicate if sales metrics are enabled on shotgun banner campaigns.

reporting.external_attribution_agg

  • namespace

external Attribution data (aggregated, both models).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = external_attribution_agg.env_namespace;
retailer on retailer.env_namespace = external_attribution_agg.env_namespace and retailer.retailer_id = external_attribution_agg.retailer_id;
campaign on campaign.env_namespace = external_attribution_agg.env_namespace and campaign.campaign_id = external_attribution_agg.campaign_id;
product on product.env_namespace = external_attribution_agg.env_namespace and product.product_code = external_attribution_agg.product_code;
search_term on search_term.env_namespace = external_attribution_agg.env_namespace and search_term.retailer_id = external_attribution_agg.retailer_id and search_term.search_term = external_attribution_agg.search_term;
category on category.env_namespace = external_attribution_agg.env_namespace and category.category_id = external_attribution_agg.category and category.retailer_id = external_attribution_agg.retailer_id;
placement on placement.env_namespace = external_attribution_agg.env_namespace and placement.placement = external_attribution_agg.placement;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
yyyymmddSTRINGYear+month+day of ingressed_at.
yyyymmSTRINGYear+month of ingressed_at.
yyyySTRINGYear of ingressed_at.
week_start_dateDATEFirst day of the week of the ingressed_at date.
order_dateDATEDate of the Orders.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
category_idSTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
attribution_modelINTEGERIndicate if data is from first or second model.
order_typeSTRINGType of the Order.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
total_click_salesNUMERICDirect unit sales + halo unit sales.
total_click_sales_valueNUMERICDirect sales value + halo sales value.
total_unit_salesNUMERICTotal click sales + view through unit sales.
total_sales_valueNUMERICTotal click sales value + view through sales value.
total_conversionsNUMERICTotal click conversions + view through conversions.
imp_halo_unit_salesNUMERICUnit sales from halo click Attributions.
imp_halo_sales_valueNUMERICRevenue from halo click Attributions.
imp_halo_conversionsNUMERICConversions from halo click Attributions.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
catalog_idSTRINGInternal identifier of the Catalog (from the source system).

reporting.external_attribution_agg_ltz

  • namespace

external Attribution data (aggregated, both models) LTZ Version.

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, category_id, normalised_product_code, product_code, product_name, brand, retailer_taxonomy, halo_taxonomy, halo_taxonomy_level, order_date, ingressed_at, search_term, placement, platform, page_type, attribution_model, retailer_id, order_type
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = external_attribution_agg_ltz.env_namespace;
retailer on retailer.env_namespace = external_attribution_agg_ltz.env_namespace and retailer.retailer_id = external_attribution_agg_ltz.retailer_id;
campaign on campaign.env_namespace = external_attribution_agg_ltz.env_namespace and campaign.campaign_id = external_attribution_agg_ltz.campaign_id;
product on product.env_namespace = external_attribution_agg_ltz.env_namespace and product.product_code = external_attribution_agg_ltz.product_code;
search_term on search_term.env_namespace = external_attribution_agg_ltz.env_namespace and search_term.retailer_id = external_attribution_agg_ltz.retailer_id and search_term.search_term = external_attribution_agg_ltz.search_term;
category on category.env_namespace = external_attribution_agg_ltz.env_namespace and category.category_id = external_attribution_agg_ltz.category and category.retailer_id = external_attribution_agg_ltz.retailer_id;
placement on placement.env_namespace = external_attribution_agg_ltz.env_namespace and placement.placement = external_attribution_agg_ltz.placement;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
yyyymmddSTRINGYear+month+day of ingressed_at.
yyyymmSTRINGYear+month of ingressed_at.
yyyySTRINGYear of ingressed_at.
week_start_dateDATEFirst day of the week of the ingressed_at date.
order_dateDATEDate of the Orders.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
category_idSTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
attribution_modelINTEGERIndicate if data is from first or second model.
order_typeSTRINGType of the Order.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
total_click_salesNUMERICDirect unit sales + halo unit sales.
total_click_sales_valueNUMERICDirect sales value + halo sales value.
total_unit_salesNUMERICTotal click sales + view through unit sales.
total_sales_valueNUMERICTotal click sales value + view through sales value.
total_conversionsNUMERICTotal click conversions + view through conversions.
imp_halo_unit_salesNUMERICUnit sales from halo click Attributions.
imp_halo_sales_valueNUMERICRevenue from halo click Attributions.
imp_halo_conversionsNUMERICConversions from halo click Attributions.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
catalog_idSTRINGInternal identifier of the Catalog (from the source system).

reporting.external_attribution_agg_ltz_view

  • namespace

External Attribution view (aggregated, both models) LTZ version. Decorated version of external_attribution_agg_ltz.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to external_attribution_agg_ltz
Other Unique Key(s):
Partition: Refer to external_attribution_agg_ltz

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
yyyymmddSTRINGYear+month+day of ingressed_at.
yyyymmSTRINGYear+month of ingressed_at.
yyyySTRINGYear of ingressed_at.
week_start_dateDATEFirst day of the week of the ingressed_at date.
order_dateDATEDate of the Orders.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
attribution_modelINTEGERIndicate if data is from first or second model.
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
total_click_salesNUMERICDirect unit sales + halo unit sales.
total_click_sales_valueNUMERICDirect sales value + halo sales value.
total_unit_salesNUMERICTotal click sales + view through unit sales.
total_sales_valueNUMERICTotal click sales value + view through sales value.
total_conversionsNUMERICTotal click conversions + view through conversions.
imp_halo_unit_salesNUMERICUnit sales from halo click Attributions.
imp_halo_sales_valueNUMERICRevenue from halo click Attributions.
imp_halo_conversionsNUMERICConversions from halo click Attributions.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
category_idSTRINGCategory being targeted.
campaign_nameSTRINGName of the Campaign.
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
cta_textSTRINGCTA text.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
team_typeSTRINGType of Team (RETAILER or SUPPLIER).
company_nameSTRINGCompany name of the Team.
supplier_nameSTRINGName of the Supplier.
category_nameSTRINGName of the category.
wallet_nameSTRINGName of the Wallet.
wallet_available_balanceNUMERICCurrent available balance of the Wallet.
supplier_company_nameSTRINGCompany name of the Supplier.
wallet_capture_dateDATEDate the Wallet details were captured on.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the Catalog.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution.
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).
attribution_time_frameNUMERICDetermines how many days of attribution results should be stored for the first model.
attribution_time_frame_2NUMERICDetermines how many days of attribution results should be stored for the second model.
is_ftaBOOLEANFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
SQL Query

select
  DISTINCT
  halo.* EXCEPT(catalog_id,category_id,retailer_id,supplier_id),
  cast(halo.category_id as string) category_id,
  dc.campaign_name campaign_name,
  dc.campaign_start_date AS campaign_start_date,
  dc.campaign_end_date AS campaign_end_date,
  dc.campaign_type campaign_type,
  dc.campaign_subtype campaign_subtype,
  dc.wallet_id wallet_id,
  dc.active_state active_state,
  dc.valid_state valid_state,
  dc.cta_text,
  halo.supplier_id supplier_id,
  halo.retailer_id retailer_id,
  dr.retailer_name,
  dr.team_type team_type,
  dr.retailer_company_name company_name,
  ds.supplier_name supplier_name,
  cat.category_label AS category_name,
  dw.wallet_name wallet_name,
  dw.available_balance AS wallet_available_balance,
  ds.supplier_company_name AS supplier_company_name,
  DATE(dw.wallet_capture_date) AS wallet_capture_date,
  rn.geo_region,
  rn.local_timezone,
  if(ifnull(halo.search_term,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_search_term,
  if(ifnull(cat.category_label,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_category,
  halo.catalog_id,
  dca.catalog_name,
  dr.enhanced_attribution_flag,
  dr.enhanced_attribution_flag_2,
  dr.retailer_taxonomy_halo,
  dr.retailer_taxonomy_halo_2,
  dr.view_attribution_window,
  dr.view_attribution_window_2,
  dr.click_attribution_window,
  dr.click_attribution_window_2,
  dr.attribution_time_frame,
  dr.attribution_time_frame_2,
  COALESCE(UPPER(dc.is_fta) = &#39;TRUE&#39;, FALSE) AS is_fta
from reporting.external_attribution_agg_ltz halo
  left join reporting.campaign dc on halo.campaign_id = dc.campaign_id
                                                            and halo.env_namespace = dc.env_namespace
  left join reporting.retailer dr on halo.env_namespace  =  dr.env_namespace
                                                            and halo.retailer_id = dr.retailer_id
  left join reporting.supplier ds on halo.env_namespace  =  ds.env_namespace
                                                            and halo.supplier_id = ds.supplier_id
  left join reporting.category cat on cat.category_id  = halo.category_id
                                                            and cat.env_namespace = halo.env_namespace
                                                            and cat.retailer_id = dr.retailer_id
  left join reporting.wallet dw on dw.env_namespace = dc.env_namespace
                                                        and dw.wallet_id = dc.wallet_id
  left join reporting.env_namespace rn on halo.env_namespace = rn.env_namespace
  left join reporting.catalog dca on  halo.catalog_id = dca.catalog_id
        and halo.env_namespace = dca.env_namespace
        and dca.is_current
where rn.geo_region &lt;&gt; &#39;NotProductionData&#39; and halo.order_date&gt;&#39;2024-12-09&#39;

reporting.external_attribution_agg_view

  • namespace

External Attribution view (aggregated, both models). Decorated version of external_attribution_agg.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to external_attribution_agg
Other Unique Key(s):
Partition: Refer to external_attribution_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
yyyymmddSTRINGYear+month+day of ingressed_at.
yyyymmSTRINGYear+month of ingressed_at.
yyyySTRINGYear of ingressed_at.
week_start_dateDATEFirst day of the week of the ingressed_at date.
order_dateDATEDate of the Orders.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
halo_taxonomySTRINGThe portion of the retailer_taxonomy relevant for the given halo_taxonomy_level. Note for halo_taxonomy_level=1 it is null since the Brand is level 1.
halo_taxonomy_levelINTEGERHalo level number (1-9). 1 = Brand level halo, Levels 2-9 are the HaloTaxonomy component, 9 being the specific Product Code (SKU).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
page_typeINTEGERLegacy, superseded by Placement.
attribution_modelINTEGERIndicate if data is from first or second model.
order_typeSTRINGType of the Order.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
direct_unit_salesNUMERICUnit sales from CitrusAd platform Attributions.
direct_sales_valueNUMERICRevenue from CitrusAd platform Attributions.
direct_conversionsNUMERICConversions from CitrusAd platform Attributions.
view_through_unit_salesNUMERICUnit sales from Impression View Thru Attributions.
view_through_sales_valueNUMERICRevenue from Impression View Thru Attributions.
view_through_conversionsNUMERICConversions from Impression View Thru Attributions.
halo_unit_salesNUMERICUnit sales from halo click Attributions.
halo_sales_valueNUMERICRevenue from halo click Attributions.
halo_conversionsNUMERICConversions from halo click Attributions.
total_click_salesNUMERICDirect unit sales + halo unit sales.
total_click_sales_valueNUMERICDirect sales value + halo sales value.
total_unit_salesNUMERICTotal click sales + view through unit sales.
total_sales_valueNUMERICTotal click sales value + view through sales value.
total_conversionsNUMERICTotal click conversions + view through conversions.
imp_halo_unit_salesNUMERICUnit sales from halo click Attributions.
imp_halo_sales_valueNUMERICRevenue from halo click Attributions.
imp_halo_conversionsNUMERICConversions from halo click Attributions.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
category_idSTRINGCategory being targeted.
campaign_nameSTRINGName of the Campaign.
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
cta_textSTRINGCTA text.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
team_typeSTRINGType of Team (RETAILER or SUPPLIER).
company_nameSTRINGCompany name of the Team.
supplier_nameSTRINGName of the Supplier.
category_nameSTRINGName of the category.
wallet_nameSTRINGName of the Wallet.
wallet_available_balanceNUMERICCurrent available balance of the Wallet.
supplier_company_nameSTRINGCompany name of the Supplier.
wallet_capture_dateDATEDate the Wallet details were captured on.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the Catalog.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution.
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).
attribution_time_frameNUMERICDetermines how many days of attribution results should be stored for the first model.
attribution_time_frame_2NUMERICDetermines how many days of attribution results should be stored for the second model.
is_ftaBOOLEANFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
SQL Query

select
  DISTINCT
  halo.* EXCEPT(catalog_id,category_id,retailer_id,supplier_id),
  cast(halo.category_id as string) category_id,
  dc.campaign_name campaign_name,
  dc.campaign_start_date AS campaign_start_date,
  dc.campaign_end_date AS campaign_end_date,
  dc.campaign_type campaign_type,
  dc.campaign_subtype campaign_subtype,
  dc.wallet_id wallet_id,
  dc.active_state active_state,
  dc.valid_state valid_state,
  dc.cta_text,
  halo.supplier_id supplier_id,
  halo.retailer_id retailer_id,
  dr.retailer_name,
  dr.team_type team_type,
  dr.retailer_company_name company_name,
  ds.supplier_name supplier_name,
  cat.category_label AS category_name,
  dw.wallet_name wallet_name,
  dw.available_balance AS wallet_available_balance,
  ds.supplier_company_name AS supplier_company_name,
  DATE(dw.wallet_capture_date) AS wallet_capture_date,
  rn.geo_region,
  rn.local_timezone,
  if(ifnull(halo.search_term,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_search_term,
  if(ifnull(cat.category_label,&#39;&#39;)&lt;&gt;&#39;&#39; ,1,0) has_category,
  halo.catalog_id,
  dca.catalog_name,
  dr.enhanced_attribution_flag,
  dr.enhanced_attribution_flag_2,
  dr.retailer_taxonomy_halo,
  dr.retailer_taxonomy_halo_2,
  dr.view_attribution_window,
  dr.view_attribution_window_2,
  dr.click_attribution_window,
  dr.click_attribution_window_2,
  dr.attribution_time_frame,
  dr.attribution_time_frame_2,
  COALESCE(UPPER(dc.is_fta) = &#39;TRUE&#39;, FALSE) AS is_fta
from reporting.external_attribution_agg halo
  left join reporting.campaign dc on halo.campaign_id = dc.campaign_id
                                                            and halo.env_namespace = dc.env_namespace
  left join reporting.retailer dr on halo.env_namespace  =  dr.env_namespace
                                                            and halo.retailer_id = dr.retailer_id
  left join reporting.supplier ds on halo.env_namespace  =  ds.env_namespace
                                                            and halo.supplier_id = ds.supplier_id
  left join reporting.category cat on cat.category_id  = halo.category_id
                                                            and cat.env_namespace = halo.env_namespace
                                                            and cat.retailer_id = dr.retailer_id
  left join reporting.wallet dw on dw.env_namespace = dc.env_namespace
                                                        and dw.wallet_id = dc.wallet_id
  left join reporting.env_namespace rn on halo.env_namespace = rn.env_namespace
  left join reporting.catalog dca on  halo.catalog_id = dca.catalog_id
      and halo.env_namespace = dca.env_namespace
      and dca.is_current
where rn.geo_region &lt;&gt; &#39;NotProductionData&#39; and halo.order_date&gt;&#39;2024-12-09&#39;

reporting.fta_campaign_spend

  • supplier
  • namespace

FTA Campaign Spend data.

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, campaign_id, wallet_id, search_term, catalog_id, product_code, bucket_date
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = fta_campaign_spend.env_namespace;
campaign on campaign.env_namespace = fta_campaign_spend.env_namespace and campaign.campaign_id = fta_campaign_spend.campaign_id;
supplier on supplier.env_namespace = fta_campaign_spend.env_namespace and supplier.supplier_id = fta_campaign_spend.supplier_id;
retailer on retailer.env_namespace = fta_campaign_spend.env_namespace and retailer.retailer_id = fta_campaign_spend.retailer_id;
wallet on wallet.env_namespace = fta_campaign_spend.env_namespace and wallet.wallet_id = fta_campaign_spend.wallet_id;
catalog on catalog.env_namespace = fta_campaign_spend.env_namespace and catalog.catalog_id = fta_campaign_spend.catalog_id;
search_term on search_term.env_namespace = fta_campaign_spend.env_namespace and search_term.retailer_id = fta_campaign_spend.retailer_id and search_term.search_term = fta_campaign_spend.search_term;
product on product.env_namespace = fta_campaign_spend.env_namespace and product.product_code = fta_campaign_spend.product_code;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
product_codeSTRINGProduct code.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_nameSTRINGName of the Supplier.
campaign_nameSTRINGName of the Campaign.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
bucketed_costNUMERICBucketed cost.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
click_spendNUMERICAdSpend generated by clicks.
clicksINTEGERNumber of Clicks.
impressionsINTEGERTotal impressions.
conversionsINTEGERTotal standard Conversions (purchases of the exact Product in the Ad).
sales_revenueINTEGERTotal sales revenue generated by Conversions.
unit_salesINTEGERTotal number of Products purchased from Conversions.
bucket_dateDATEBucket date.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting

reporting.ledger_agg

  • supplier
  • retailer
  • namespace

Ledger data (aggregated into UTC+0 day buckets).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_type, reason, retailer_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = ledger_agg.env_namespace;
retailer on retailer.env_namespace = ledger_agg.env_namespace and retailer.retailer_id = ledger_agg.retailer_id;
campaign on campaign.env_namespace = ledger_agg.env_namespace and campaign.campaign_id = ledger_agg.campaign_id;
team on team.env_namespace = ledger_agg.env_namespace and team.team_id = ledger_agg.team_id;
wallet on wallet.env_namespace = ledger_agg.env_namespace and wallet.wallet_id = ledger_agg.wallet_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
team_idSTRINGInternal identifier of the Team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
team_nameSTRINGName of the Team.
supplier_nameSTRINGName of the Supplier.
supplier_company_nameSTRINGCompany name of the Supplier.
retailer_nameSTRINGName of the Retailer.
retailer_company_nameSTRINGCompany name of the Retailer.
wallet_nameSTRINGName of the Wallet.
wallet_currency_codeSTRINGISO 4217 currency code
wallet_external_idSTRINGImplementation specific generic label.
campaign_nameSTRINGName of the Campaign.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
namespaceSTRINGName of the Namespace.
ledger_typeSTRINGDebit or Credit transaction type.
product_typeSTRINGType of the Product.
reasonSTRINGReason given for the transaction type.
wallet_archivedBOOLEANArchived status of the Wallet.
transaction_dateDATEDate of the transactions.
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
campaign_active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
campaign_is_ftaSTRINGFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
amountNUMERICTotal of transaction amounts.
campaign_fta_costNUMERICTotal amount being spent by the given Fixed Tenancy (FTA) Campaign.
campaign_max_cost_per_clickNUMERICThe maximum cost per click set for the Campaign.
campaign_max_total_spendNUMERICThe maximum total spend set for the Campaign.
campaign_max_daily_spendNUMERICThe maximum daily spend set for the Campaign.
campaign_total_spendNUMERICTotal AdSpend to date for the Campaign.
wallet_active_campaign_countNUMERICNumber of currently active Campaigns associated to the Wallet.
wallet_active_campaign_max_total_spendNUMERICAggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet.
currency_valueFLOATLocal currency to USD conversion rate (current rate only).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
transaction_countNUMERICTotal transaction count.

reporting.ledger_agg_2

  • supplier
  • retailer
  • namespace

Ledger data (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months.

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: transaction_date, env_namespace, team_id, wallet_id, campaign_id, ledger_type, product_ledger, reason, retailer_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = ledger_agg_2.env_namespace;
retailer on retailer.env_namespace = ledger_agg_2.env_namespace and retailer.retailer_id = ledger_agg_2.retailer_id;
campaign on campaign.env_namespace = ledger_agg_2.env_namespace and campaign.campaign_id = ledger_agg_2.campaign_id;
team on team.env_namespace = ledger_agg_2.env_namespace and team.team_id = ledger_agg_2.team_id;
wallet on wallet.env_namespace = ledger_agg_2.env_namespace and wallet.wallet_id = ledger_agg_2.wallet_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
team_idSTRINGInternal identifier of the Team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
team_nameSTRINGName of the Team.
supplier_nameSTRINGName of the Supplier.
supplier_company_nameSTRINGCompany name of the Supplier.
retailer_nameSTRINGName of the Retailer.
retailer_company_nameSTRINGCompany name of the Retailer.
wallet_nameSTRINGName of the Wallet.
wallet_currency_codeSTRINGISO 4217 currency code
wallet_external_idSTRINGImplementation specific generic label.
campaign_nameSTRINGName of the Campaign.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
namespaceSTRINGName of the Namespace.
ledger_typeSTRINGDebit or Credit transaction type.
product_typeSTRINGType of the Product.
reasonSTRINGReason given for the transaction type.
wallet_archivedBOOLEANArchived status of the Wallet.
transaction_timestampTIMESTAMPTimestamp of the transactions rounded up to the hour
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
campaign_valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
campaign_active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
campaign_is_ftaSTRINGFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
amountNUMERICTotal of transaction amounts.
campaign_fta_costNUMERICTotal amount being spent by the given Fixed Tenancy (FTA) Campaign.
campaign_max_cost_per_clickNUMERICThe maximum cost per click set for the Campaign.
campaign_max_total_spendNUMERICThe maximum total spend set for the Campaign.
campaign_max_daily_spendNUMERICThe maximum daily spend set for the Campaign.
campaign_total_spendNUMERICTotal AdSpend to date for the Campaign.
wallet_active_campaign_countNUMERICNumber of currently active Campaigns associated to the Wallet.
wallet_active_campaign_max_total_spendNUMERICAggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet.
currency_valueFLOATLocal currency to USD conversion rate (current rate only).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
transaction_countINTEGERTotal transaction count.

reporting.order_ad_stats

  • retailer
  • namespace

Order and Realised Ad statistics data (aggregated).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, retailer_id, order_date, product_code, normalised_product_code
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = order_ad_stats.env_namespace;
retailer on retailer.env_namespace = order_ad_stats.env_namespace and retailer.retailer_id = order_ad_stats.retailer_id;
catalog on catalog.env_namespace = order_ad_stats.env_namespace and catalog.catalog_id = order_ad_stats.catalog_id;
product on product.env_namespace = order_ad_stats.env_namespace and product.catalog_id = order_ad_stats.catalog_id and product.product_code = order_ad_stats.product_code;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
namespaceSTRINGName of the Namespace.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
product_codeSTRINGProduct code.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
ad_stats_product_codeSTRINGProduct code.
order_dateDATEDate of the Orders.
conversions_from_adsNUMERICTotal Conversions occuring from CitrusAd Ads.
unit_sales_from_adsNUMERICTotal number of Products purchased from Conversions.
total_priceNUMERICTotal paid for the products ordered.
quantityNUMERICQuantity of the Product ordered.
order_itemsNUMERICTotal number of items ordered.
ordersNUMERICNumber of Orders made.
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
product_typeSTRINGType of the Product.
product_tagsSTRINGTags associated with the Product.
currency_codeSTRINGISO 4217 currency code
retailer_nameSTRINGName of the Retailer.
currency_valueFLOATLocal currency to USD conversion rate (current rate only).
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.

reporting.order_agg

  • retailer
  • namespace

Order data (aggregated).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, order_date, issuer_team_id, retailer_id, catalog_id, product_code, normalised_product_code, order_type
Other Unique Key(s):
Partition: order_date (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = order_agg.env_namespace;
retailer on retailer.env_namespace = order_agg.env_namespace and retailer.retailer_id = order_agg.retailer_id;
catalog on catalog.env_namespace = order_agg.env_namespace and catalog.catalog_id = order_agg.catalog_id;
product on product.env_namespace = order_agg.env_namespace and product.catalog_id = order_agg.catalog_id and product.product_code = order_agg.product_code;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
issuer_team_idSTRINGInternal identifier of the Team (from the source system).
product_nameSTRINGName of the Product.
brandSTRINGBrand of the Product.
product_typeSTRINGType of the Product.
product_tagsSTRINGTags associated with the Product.
retailer_nameSTRINGName of the Retailer.
currency_codeSTRINGISO 4217 currency code
namespaceSTRINGName of the Namespace.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
order_typeSTRINGType of the Order.
order_dateDATEDate of the Orders.
total_priceNUMERICTotal paid for the products ordered.
total_price_usdFLOATtotal_price in USD (current exchange rate only).
quantityNUMERICQuantity of the Product ordered.
order_itemsNUMERICTotal number of items ordered.
ordersNUMERICNumber of Orders made.

reporting.placement

  • namespace

Placement data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, placement_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = placement.env_namespace;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
placement_idSTRINGInternal identifier of the Placement (from the source system).
ad_gen_idSTRINGAd gen id.
catalog_idsSTRINGCatalog ids.
display_nameSTRINGDisplay name of the Placement.
campaign_targetSTRINGCampaign target.
campaign_typesSTRINGList of applicable campaign types.
namespaceSTRINGName of the Namespace.
archivedSTRINGArchived status of the Placement.

reporting.product

  • retailer
  • namespace

Product data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, normalised_product_code, product_code, catalog_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = product.env_namespace;
catalog on catalog.env_namespace = product.env_namespace and catalog.catalog_id = product.catalog_id;
retailer on retailer.env_namespace = product.env_namespace and retailer.retailer_id = product.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
normalised_product_codeSTRINGProduct code prefixed with leading zeros to be 16 characters long.
product_codeSTRINGProduct code.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
product_nameSTRINGName of the Product.
product_typeSTRINGType of the Product.
retailer_nameSTRINGName of the Retailer.
currency_codeSTRINGISO 4217 currency code
product_tagsSTRINGTags associated with the Product.
product_image_urlSTRINGURL to an image of the Product for the Ad.
brandSTRINGBrand of the Product.
google_product_taxonomySTRINGGoogle taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
namespaceSTRINGName of the Namespace.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
catalog_nameSTRINGName of the Catalog.
typeSTRINGType of Product.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
seller_idSTRINGSeller that the Product is applicable for.
upcSTRINGUPC of the Product.
inventorySTRINGHow much of the Product is in stock.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.

reporting.realised_ad_agg

  • supplier

Realised Ad data (aggregated into UTC+0 day buckets).

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = realised_ad_agg.env_namespace;
retailer on retailer.env_namespace = realised_ad_agg.env_namespace and retailer.retailer_id = realised_ad_agg.retailer_id;
catalog on catalog.env_namespace = realised_ad_agg.env_namespace and catalog.catalog_id = realised_ad_agg.catalog_id;
product on product.env_namespace = realised_ad_agg.env_namespace and product.catalog_id = realised_ad_agg.catalog_id and product.normalised_product_code = realised_ad_agg.product_code;
supplier on supplier.env_namespace = realised_ad_agg.env_namespace and supplier.supplier_id = realised_ad_agg.supplier_id;
campaign on campaign.env_namespace = realised_ad_agg.env_namespace and campaign.campaign_id = realised_ad_agg.campaign_id;
category on category.env_namespace = realised_ad_agg.env_namespace and category.retailer_id = realised_ad_agg.retailer_id and category.category_id = realised_ad_agg.category

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED. Please switch to using keyword.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
placement_idSTRINGInternal identifier of the Placement (from the source system).
namespaceSTRINGName of the Namespace.
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
wallet_idSTRINGInternal identifier of the Wallet (from the source system)
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.

reporting.realised_ad_agg_2

  • namespace

Realised Ad data (aggregated by customerid). Includes customer_id, but no breakdown by Campaign, Placement and Product.

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, retailer_id, supplier_id, customer_id, search_term, category
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = realised_ad_agg_2.env_namespace;
retailer on retailer.env_namespace = realised_ad_agg_2.env_namespace and retailer.retailer_id = realised_ad_agg_2.retailer_id;
supplier on supplier.env_namespace = realised_ad_agg_2.env_namespace and supplier.supplier_id = realised_ad_agg_2.supplier_id;
search_term on search_term.env_namespace = realised_ad_agg_2.env_namespace and search_term.retailer_id = realised_ad_agg_2.retailer_id and search_term.search_term = realised_ad_agg_2.search_term;
category on category.env_namespace = realised_ad_agg_2.env_namespace and category.category_id = realised_ad_agg_2.category and category.retailer_id = realised_ad_agg_2.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
customer_idSTRINGCustomer identifier as provided by the Retailer (as in loyalty number etc, where available). Sometimes used for Attribution.
ingressed_atDATEDate the Ads were realised.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
categorySTRINGCategory being targeted.
namespaceSTRINGName of the Namespace.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
retailer_nameSTRINGName of the Retailer.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
supplier_nameSTRINGName of the Supplier.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
has_search_termINTEGERhas_search_term
has_categoryINTEGERhas_category

reporting.realised_ad_agg_3

  • retailer
  • namespace

Realised Ad data (aggregated into UTC+0 hourly buckets). Only for current + previous 3 months.

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: ingressed_at, env_namespace, catalog_id, retailer_id, supplier_id, campaign_id, ad_type, search_term, generic_search_term, product_code, content_standard_id, slot_id, category, placement, platform, target_product_code
Other Unique Key(s):
Partition: ingressed_at (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = realised_ad_agg_3.env_namespace;
retailer on retailer.env_namespace = realised_ad_agg_3.env_namespace and retailer.retailer_id = realised_ad_agg_3.retailer_id;
catalog on catalog.env_namespace = realised_ad_agg_3.env_namespace and catalog.catalog_id = realised_ad_agg_3.catalog_id;
product on product.env_namespace = realised_ad_agg_3.env_namespace and product.catalog_id = realised_ad_agg_3.catalog_id and product.normalised_product_code = realised_ad_agg_3.product_code;
supplier on supplier.env_namespace = realised_ad_agg_3.env_namespace and supplier.supplier_id = realised_ad_agg_3.supplier_id;
campaign on campaign.env_namespace = realised_ad_agg_3.env_namespace and campaign.campaign_id = realised_ad_agg_3.campaign_id;
category on category.env_namespace = realised_ad_agg_3.env_namespace and category.retailer_id = realised_ad_agg_3.retailer_id and category.category_id = realised_ad_agg_3.category;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atTIMESTAMPTimestamp the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED. Please switch to using keyword.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
has_search_termINTEGERFlag to indicate if the Ad is targeting a Search Term.
has_categoryINTEGERFlag to indicate if the Ad is targeting a Category.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
retailer_nameSTRINGName of the Retailer.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
supplier_nameSTRINGName of the Supplier.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
wallet_idSTRINGInternal identifier of the Wallet (from the source system)
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.

reporting.realised_ad_agg_ltz_view

  • namespace

Realised Ad view (aggregated in local timezone) + FTA Campaign spend data. Union of realised_ad_agg and fta_campaign_spend.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to realised_ad_agg
Other Unique Key(s):
Partition: Refer to realised_ad_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED. Please switch to using keyword.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
namespaceSTRINGName of the Namespace.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
ad_type_nameSTRINGHuman readable name for the ad type
catalog_nameSTRINGName of the Catalog.
supplier_nameSTRINGName of the Supplier.
supplier_industrySTRINGIndustry of the Supplier.
supplier_business_identifierSTRINGImplementation specific generic label.
supplier_company_nameSTRINGCompany name of the Supplier.
retailer_nameSTRINGName of the Retailer.
retailer_industrySTRINGIndustry of the Retailer.
retailer_business_identifierSTRINGImplementation specific generic label.
retailer_company_nameSTRINGCompany name of the Retailer.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
campaign_nameSTRINGName of the Campaign.
campaign_total_spendNUMERICTotal AdSpend to date for the Campaign.
currency_codeSTRINGISO 4217 currency code
is_ftaSTRINGFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
wallet_available_balanceNUMERICCurrent available balance of the Wallet.
campaign_active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
campaign_placementsSTRINGThe Campaign's selected Placement.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
wallet_nameSTRINGName of the Wallet.
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_max_total_spendNUMERICThe maximum total spend set for the Campaign.
campaign_created_atTIMESTAMPDate the record was created in the source system.
campaign_max_cost_per_clickNUMERICThe maximum cost per click set for the Campaign.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_catalog_productsSTRINGThe Catalog's Products within the Campaign.
wallet_total_purchased_creditsNUMERICTotal credits made to the Wallet.
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
campaign_valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
campaign_impression_goalNUMERICThe maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend.
fta_costNUMERICTotal amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign.
wallet_archivedBOOLEANArchived status of the Wallet.
campaign_max_daily_spendNUMERICThe maximum daily spend set for the Campaign.
campaign_total_spend_usdNUMERICcampaign_total_spend in USD (current exchange rate only).
wallet_external_idSTRINGImplementation specific generic label.
campaign_updated_atTIMESTAMPDate the record was updated in the source system.
wallet_credit_limitNUMERICAmount the Wallet may go into credit.
campaign_attr_1STRINGCampaign user defined attribute 1.
cta_textSTRINGCTA text.
wallet_team_nameSTRINGTeam name associated with the wallet.
wallet_capture_dateTIMESTAMPDate the Wallet details were captured on.
earliest_top_up_amount_usdNUMERICearliest_top_up_amount in USD (current exchange rate only).
category_labelSTRINGLabel for the Category (more descriptive than the typical id provided).
product_nameSTRINGName of the Product.
product_typeSTRINGType of the Product.
product_tagsSTRINGTags associated with the Product.
brandSTRINGBrand of the Product.
typeSTRINGType of Product.
upcSTRINGUPC of the Product.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
sales_revenue_usdFLOATRevenue generated from sales in USD.
ad_revenue_usdFLOATRevenue generated from ads in USD.
ad_spend_usdFLOATAmount spent on ads in USD.
placement_idSTRINGInternal identifier of the Placement (from the source system).
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
last_event_loaded_atDATETIMEDate the row was inserted into the source system.
source_typeSTRINGName of source table.
has_search_termINTEGERhas_search_term
has_categoryINTEGERhas_category
SQL Query
with ads as (
  select
    faa.env,
    faa.env_namespace,
    faa.ingressed_at,
    faa.catalog_id,
    faa.campaign_id,
    faa.supplier_id,
    faa.search_term,
    faa.generic_search_term,
    faa.product_code,
    faa.retailer_id,
    faa.content_standard_id,
    faa.slot_id,
    faa.category,
    faa.placement,
    faa.platform,
    faa.ad_type,
    faa.target_product_code,
    faa.sales_revenue,
    faa.ad_revenue,
    faa.ad_spend,
    faa.impressions,
    faa.clicks,
    faa.conversions,
    faa.unit_sales,
    faa.click_spend,
    faa.impression_spend,
    faa.position_sum,
    faa.ads_with_position_count,
    faa.namespace,
    faa.enable_sales_metrics,
    faa.placement_id,
    faa.wallet_id,
    faa.attributable_impressions,
    faa.attributable_clicks,
    faa.attributable_ad_spend,
    faa.last_event_loaded_at,
    &#39;realised_ad_agg_ltz&#39; as source_type,
    faa.has_search_term,
    faa.has_category
  from
    reporting.realised_ad_agg_ltz faa
  where
    faa.ingressed_at &gt;= &#39;2000-01-01&#39;
  union all
  select
    fta.env,
    fta.env_namespace,
    fta.bucket_date ingressed_at,
    fta.catalog_id,
    fta.campaign_id,
    fta.supplier_id,
    fta.search_term,
    &#39;&#39; as generic_search_term,
    fta.product_code,
    fta.retailer_id,
    cast(&#39;&#39; AS string)  as content_standard_id,
    cast(&#39;&#39; AS string)  slot_id,
    cast(&#39;&#39; AS string)  category,
    cast(&#39;&#39; AS string)  placement,
    cast(&#39;&#39; AS string)  platform,
    fta.ad_type,
    cast(&#39;&#39; AS string) target_product_code,
    0 as sales_revenue,
    0 as ad_revenue,
    fta.bucketed_cost ad_spend,
    NULL as impressions,
    NULL as clicks,
    0 as conversions,
    0 as unit_sales,
    fta.bucketed_cost click_spend,
    0 as impression_spend,
    0 as position_sum,
    0 as ads_with_position_count,
    fta.namespace,
    fta.enable_sales_metrics,
    null as placement_id,
    null as wallet_id,
    0 as attributable_impressions,
    0 as attributable_clicks,
    0 as attributable_ad_spend,
    null as last_event_loaded_at,
    &#39;fta_campaign_spend&#39; as source_type,
    if(ifnull(fta.search_term, &#39;&#39;) &lt;&gt; &#39;&#39;, 1, 0) as has_search_term,
    0 as has_category
  from reporting.fta_campaign_spend fta
)
select
  ads.* EXCEPT (wallet_id,placement_id,attributable_impressions,attributable_clicks,attributable_ad_spend,last_event_loaded_at,source_type,has_search_term,has_category),
  ad.ad_type_name,
  dctl.catalog_name,
  ds.supplier_name,
  ds.supplier_industry,
  ds.supplier_business_identifier,
  ds.supplier_company_name,
  dr.retailer_name,
  dr.retailer_industry,
  dr.retailer_business_identifier,
  dr.retailer_company_name,
  dr.retailer_group_1,
  dr.retailer_group_2,
  ds.supplier_group_1,
  ds.supplier_group_2,
  ds.supplier_group_3,
  ds.supplier_group_4,
  dcmp.campaign_name,
  /*domo specific*/
  dcmp.campaign_total_spend,
  dcmp.currency_code,
  dcmp .is_fta,
  dcmp.wallet_available_balance,
  dcmp.campaign_active_state,
  dcmp.campaign_placements,
  dcmp.campaign_type,
  dcmp.wallet_name,
  dcmp.campaign_start_date,
  dcmp.campaign_max_total_spend,
  dcmp.campaign_created_at,
  dcmp.campaign_max_cost_per_click,
  dcmp.campaign_end_date,
  ads.wallet_id,
  dcmp.campaign_catalog_products,
  dcmp.wallet_total_purchased_credits,
  dcmp.campaign_subtype,
  dcmp.campaign_valid_state,
  dcmp.campaign_impression_goal,
  dcmp.fta_cost,
  dcmp.wallet_archived,
  dcmp.campaign_max_daily_spend,
  dcmp.campaign_total_spend_usd,
  dcmp.wallet_external_id,
  dcmp.campaign_updated_at,
  dcmp.wallet_credit_limit,
  dcmp.campaign_attr_1,
  dcmp.cta_text,
  w.team_name wallet_team_name,
  w.wallet_capture_date,
  w.earliest_top_up_amount_usd,
  ca.category_label,
  p.product_name,
  p.product_type,
  p.product_tags,
  p.brand,
  p.type,
  p.upc,
  rn.geo_region as geo_region,
  rn.local_timezone as local_timezone,
  ads.sales_revenue/currency.value sales_revenue_usd,
  ads.ad_revenue/currency.value ad_revenue_usd,
  ads.ad_spend/currency.value ad_spend_usd,
  ads.placement_id,
  ads.attributable_impressions,
  ads.attributable_clicks,
  ads.attributable_ad_spend,
  ads.last_event_loaded_at,
  ads.source_type,
  if(ifnull(ads.search_term, &#39;&#39;) &lt;&gt; &#39;&#39;, 1, 0) as has_search_term,
  ads.has_category
  from
    ads
    left join reporting.catalog dctl on dctl.catalog_id = ads.catalog_id
                                    and dctl.env_namespace = ads.env_namespace
    left join reporting.campaign dcmp on dcmp.campaign_id = ads.campaign_id
                                     and dcmp.env_namespace = ads.env_namespace
    left join reporting.retailer dr on dr.retailer_id = ads.retailer_id
                                   and dr.env_namespace = ads.env_namespace
    left join reporting.supplier ds on ds.supplier_id = ads.supplier_id
                                   and ds.env_namespace = ads.env_namespace
    left join reporting.view_ad_type ad on ads.ad_type = ad.ad_type
    left join reporting.wallet w     on ads.env_namespace = w.env_namespace
                                    and ads.wallet_id = w.wallet_id
    left join reporting.category ca  on ads.env_namespace = ca.env_namespace
                                    and ads.category = ca.category_id
                                    and ads.retailer_id = ca.retailer_id
    left join reporting.product p  on ads.env_namespace = p.env_namespace
                                  and ads.catalog_id = p.catalog_id
                                  and ads.product_code = p.normalised_product_code
    left join reporting.env_namespace rn on ads.env_namespace = rn.env_namespace
    left join reporting.currency currency on dcmp.currency_code =currency.currency and currency.base=&#39;USD&#39;


reporting.realised_ad_agg_view

  • retailer
  • namespace

Realised Ad view (aggregated) + FTA Campaign spend data. Union of realised_ad_agg and fta_campaign_spend.

Layer: Reporting Datamart
Category: Fact Decorated View
Status: Published

Primary Key: Refer to realised_ad_agg
Other Unique Key(s):
Partition: Refer to realised_ad_agg

Foreign Key(s):
Refer to view code

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
ingressed_atDATEDate the Ads were realised.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
campaign_idSTRINGInternal identifier of the Campaign (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
search_termSTRINGDEPRECATED. Please switch to using keyword.
generic_search_termSTRINGDEPRECATED. Please switch to using keyword.
product_codeSTRINGProduct code.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
content_standard_idSTRINGContentStandardId as specified in the Ad Request.
slot_idSTRINGBanner SlotId as specified in the Ad Request.
categorySTRINGCategory being targeted.
placementSTRINGDisplay name of the Placement.
platformSTRINGThe platform of the User as specified in the Request. Only populated if the requester specifies the platform as platform:<VALUE> as a filter.
ad_typeINTEGERType of Ad (0 = Product, 1 = Banner, 4 = BannerX).
target_product_codeSTRINGTarget Product code.
sales_revenueNUMERICTotal sales revenue generated by Conversions.
ad_revenueNUMERICPortion of Ad spend retained by the Retailer.
ad_spendNUMERICLocal currency amount charged by the Retailer to the Supplier for the Realised Ads.
impressionsNUMERICTotal impressions.
clicksNUMERICNumber of Clicks.
conversionsNUMERICTotal standard Conversions (purchases of the exact Product in the Ad).
unit_salesNUMERICTotal number of Products purchased from Conversions.
click_spendNUMERICAdSpend generated by clicks.
impression_spendNUMERICAdSpend generated by impressions.
position_sumNUMERICSum of all postions for the Ads. Used to calculate average ad position (avg position = position_sum / ads_with_position_count).
ads_with_position_countNUMERICTotal number of Ads that have a position set. avg position = position_sum / ads_with_position_count.
namespaceSTRINGName of the Namespace.
enable_sales_metricsBOOLEANUsed to set sales metrics to 0 for certain namespace/campaign types if required for reporting
ad_type_nameSTRINGHuman readable name for the ad type
catalog_nameSTRINGName of the Catalog.
supplier_nameSTRINGName of the Supplier.
supplier_industrySTRINGIndustry of the Supplier.
supplier_business_identifierSTRINGImplementation specific generic label.
supplier_company_nameSTRINGCompany name of the Supplier.
retailer_nameSTRINGName of the Retailer.
retailer_industrySTRINGIndustry of the Retailer.
retailer_business_identifierSTRINGImplementation specific generic label.
retailer_company_nameSTRINGCompany name of the Retailer.
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
campaign_nameSTRINGName of the Campaign.
campaign_total_spendNUMERICTotal AdSpend to date for the Campaign.
currency_codeSTRINGISO 4217 currency code
is_ftaSTRINGFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).
wallet_available_balanceNUMERICCurrent available balance of the Wallet.
campaign_active_stateSTRINGThe Campaign's active state as set in the platform. (ACTIVE, PAUSED, DRAFT, ARCHIVED).
campaign_placementsSTRINGThe Campaign's selected Placement.
campaign_typeSTRINGType of Campaign (BANNER, BRAND_PAGE, DISPLAY, EMAIL, SHOTGUN_BANNER, WILDCARD)
wallet_nameSTRINGName of the Wallet.
campaign_start_dateTIMESTAMPDate the Campaign will begin.
campaign_max_total_spendNUMERICThe maximum total spend set for the Campaign.
campaign_created_atTIMESTAMPDate the record was created in the source system.
campaign_max_cost_per_clickNUMERICThe maximum cost per click set for the Campaign.
campaign_end_dateTIMESTAMPDate when the Campaign will end.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
campaign_catalog_productsSTRINGThe Catalog's Products within the Campaign.
wallet_total_purchased_creditsNUMERICTotal credits made to the Wallet.
campaign_subtypeSTRINGLegacy, superseded by placement. Subtype of the Campaign (SEARCH_ONLY, CATEGORY_ONLY, CATEGORY_AND_SEARCH, BROAD_DISPLAY, CROSS_SELL, UPSELL, RUN_OF_SITE).
campaign_valid_stateSTRINGThe Campaign's valid state. (APPROVED, PENDING, REJECTED)
campaign_impression_goalNUMERICThe maximum number of impressions a Campaign is aiming for. Only relevant for campaigns with a spend type of Fixed Spend.
fta_costNUMERICTotal amount being spent by the given Fixed Tenancy Agreement (FTA) Campaign.
wallet_archivedBOOLEANArchived status of the Wallet.
campaign_max_daily_spendNUMERICThe maximum daily spend set for the Campaign.
campaign_total_spend_usdNUMERICcampaign_total_spend in USD (current exchange rate only).
wallet_external_idSTRINGImplementation specific generic label.
campaign_updated_atTIMESTAMPDate the record was updated in the source system.
wallet_credit_limitNUMERICAmount the Wallet may go into credit.
campaign_attr_1STRINGCampaign user defined attribute 1.
cta_textSTRINGCTA text.
wallet_team_nameSTRINGTeam name associated with the wallet.
wallet_capture_dateTIMESTAMPDate the Wallet details were captured on.
earliest_top_up_amount_usdNUMERICearliest_top_up_amount in USD (current exchange rate only).
category_labelSTRINGLabel for the Category (more descriptive than the typical id provided).
product_nameSTRINGName of the Product.
product_typeSTRINGType of the Product.
product_tagsSTRINGTags associated with the Product.
brandSTRINGBrand of the Product.
typeSTRINGType of Product.
upcSTRINGUPC of the Product.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
sales_revenue_usdFLOATRevenue generated from sales in USD.
ad_revenue_usdFLOATRevenue generated from ads in USD.
ad_spend_usdFLOATAmount spent on ads in USD.
placement_idSTRINGInternal identifier of the Placement (from the source system)
attributable_impressionsNUMERICSubset of impressions that are considered attributable.
attributable_clicksNUMERICSubset of clicks that are considered attributable.
attributable_ad_spendNUMERICSubset of ad spend that is considered attributable.
last_event_loaded_atTIMESTAMPDate the row was inserted into the source system.
source_typeSTRINGName of source table.
has_search_termINTEGERhas_search_term
has_categoryINTEGERhas_category
SQL Query
with ads as (
  select
    faa.env,
    faa.env_namespace,
    faa.ingressed_at,
    faa.catalog_id,
    faa.campaign_id,
    faa.supplier_id,
    faa.search_term,
    faa.generic_search_term,
    faa.product_code,
    faa.retailer_id,
    faa.content_standard_id,
    faa.slot_id,
    faa.category,
    faa.placement,
    faa.platform,
    faa.ad_type,
    faa.target_product_code,
    faa.sales_revenue,
    faa.ad_revenue,
    faa.ad_spend,
    faa.impressions,
    faa.clicks,
    faa.conversions,
    faa.unit_sales,
    faa.click_spend,
    faa.impression_spend,
    faa.position_sum,
    faa.ads_with_position_count,
    faa.namespace,
    faa.enable_sales_metrics,
    faa.placement_id,
    faa.wallet_id,
    faa.attributable_impressions,
    faa.attributable_clicks,
    faa.attributable_ad_spend,
    faa.last_event_loaded_at,
    &#39;realised_ad_agg&#39; as source_type,
    faa.has_search_term,
    faa.has_category
  from
    reporting.realised_ad_agg faa
  where
    faa.ingressed_at &gt;= &#39;2000-01-01&#39;
  union all
  select
    fta.env,
    fta.env_namespace,
    fta.bucket_date ingressed_at,
    fta.catalog_id,
    fta.campaign_id,
    fta.supplier_id,
    fta.search_term,
    &#39;&#39; as generic_search_term,
    fta.product_code,
    fta.retailer_id,
    cast(&#39;&#39; AS string)  as content_standard_id,
    cast(&#39;&#39; AS string)  slot_id,
    cast(&#39;&#39; AS string)  category,
    cast(&#39;&#39; AS string)  placement,
    cast(&#39;&#39; AS string)  platform,
    fta.ad_type,
    cast(&#39;&#39; AS string) target_product_code,
    0 as sales_revenue,
    0 as ad_revenue,
    fta.bucketed_cost ad_spend,
    NULL as impressions,
    NULL as clicks,
    0 as conversions,
    0 as unit_sales,
    fta.bucketed_cost click_spend,
    0 as impression_spend,
    0 as position_sum,
    0 as ads_with_position_count,
    fta.namespace,
    fta.enable_sales_metrics,
    null as placement_id,
    null as wallet_id,
    0 as attributable_impressions,
    0 as attributable_clicks,
    0 as attributable_ad_spend,
    null as last_event_loaded_at,
    &#39;fta_campaign_spend&#39; as source_type,
    if(ifnull(fta.search_term, &#39;&#39;) &lt;&gt; &#39;&#39;, 1, 0) as has_search_term,
    0 as has_category
  from reporting.fta_campaign_spend fta
)
select
  ads.* EXCEPT (wallet_id,placement_id,attributable_impressions,attributable_clicks,attributable_ad_spend,last_event_loaded_at,source_type,has_search_term,has_category),
  ad.ad_type_name,
  dctl.catalog_name,
  ds.supplier_name,
  ds.supplier_industry,
  ds.supplier_business_identifier,
  ds.supplier_company_name,
  dr.retailer_name,
  dr.retailer_industry,
  dr.retailer_business_identifier,
  dr.retailer_company_name,
  dr.retailer_group_1,
  dr.retailer_group_2,
  ds.supplier_group_1,
  ds.supplier_group_2,
  ds.supplier_group_3,
  ds.supplier_group_4,
  dcmp.campaign_name,
  /*domo specific*/
  dcmp.campaign_total_spend,
  dcmp.currency_code,
  dcmp .is_fta,
  dcmp.wallet_available_balance,
  dcmp.campaign_active_state,
  dcmp.campaign_placements,
  dcmp.campaign_type,
  dcmp.wallet_name,
  dcmp.campaign_start_date,
  dcmp.campaign_max_total_spend,
  dcmp.campaign_created_at,
  dcmp.campaign_max_cost_per_click,
  dcmp.campaign_end_date,
  ads.wallet_id,
  dcmp.campaign_catalog_products,
  dcmp.wallet_total_purchased_credits,
  dcmp.campaign_subtype,
  dcmp.campaign_valid_state,
  dcmp.campaign_impression_goal,
  dcmp.fta_cost,
  dcmp.wallet_archived,
  dcmp.campaign_max_daily_spend,
  dcmp.campaign_total_spend_usd,
  dcmp.wallet_external_id,
  dcmp.campaign_updated_at,
  dcmp.wallet_credit_limit,
  dcmp.campaign_attr_1,
  dcmp.cta_text,
  w.team_name wallet_team_name,
  w.wallet_capture_date,
  w.earliest_top_up_amount_usd,
  ca.category_label,
  p.product_name,
  p.product_type,
  p.product_tags,
  p.brand,
  p.type,
  p.upc,
  rn.geo_region as geo_region,
  rn.local_timezone as local_timezone,
  ads.sales_revenue/currency.value sales_revenue_usd,
  ads.ad_revenue/currency.value ad_revenue_usd,
  ads.ad_spend/currency.value ad_spend_usd,
  ads.placement_id,
  ads.attributable_impressions,
  ads.attributable_clicks,
  ads.attributable_ad_spend,
  ads.last_event_loaded_at,
  ads.source_type,
  ads.has_search_term,
  ads.has_category
from
  ads
  left join reporting.catalog dctl on dctl.catalog_id = ads.catalog_id
                                  and dctl.env_namespace = ads.env_namespace
  left join reporting.campaign dcmp on dcmp.campaign_id = ads.campaign_id
                                   and dcmp.env_namespace = ads.env_namespace
  left join reporting.retailer dr on dr.retailer_id = ads.retailer_id
                                 and dr.env_namespace = ads.env_namespace
  left join reporting.supplier ds on ds.supplier_id = ads.supplier_id
                                 and ds.env_namespace = ads.env_namespace
  left join reporting.view_ad_type ad on ads.ad_type = ad.ad_type
  left join reporting.wallet w     on ads.env_namespace = w.env_namespace
                                  and ads.wallet_id = w.wallet_id
  left join reporting.category ca  on ads.env_namespace = ca.env_namespace
                                  and ads.category = ca.category_id
                                  and ads.retailer_id = ca.retailer_id
  left join reporting.product p  on ads.env_namespace = p.env_namespace
                                and ads.catalog_id = p.catalog_id
                                and ads.product_code = p.normalised_product_code
  left join reporting.env_namespace rn on ads.env_namespace = rn.env_namespace
  left join reporting.currency currency on dcmp.currency_code =currency.currency and currency.base=&#39;USD&#39;

reporting.retailer

  • retailer
  • namespace

Retailer data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, retailer_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = retailer.env_namespace;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
team_typeSTRINGType of Team (RETAILER).
retailer_company_nameSTRINGCompany name of the Retailer.
retailer_business_identifierSTRINGImplementation specific generic label.
retailer_industrySTRINGIndustry of the Retailer.
currency_codeSTRINGISO 4217 currency code
namespaceSTRINGName of the Namespace.
ads_requested_capNUMERICMax number of Product Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed).
banner_ads_requested_capNUMERICMax number of Banner Ads that will be considered for reporting purposes per Ad Request (set per Retailer team, no setting means no cap will be imposed).
reserved_search_termsSTRINGNot in use.
global_suppress_flagSTRINGFlag to indicate Retailer is to be excluded from reporting (eg test data).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
created_atTIMESTAMPDate the record was created in the source system.
updated_atTIMESTAMPDate the record was updated in the source system.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (1st model).
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).
attribution_time_frameNUMERICDetermines how many days of attribution results should be stored for the first model.
attribution_time_frame_2NUMERICDetermines how many days of attribution results should be stored for the second model.

reporting.retailer_supplier

  • retailer

Retailer centric Supplier data (only relevant Suppliers as referenced within Realised Ads generated against the Retailer's Catalogs).

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, supplier_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
supplier_group_1STRINGSupplier group membership #1.
supplier_group_2STRINGSupplier group membership #2.
supplier_group_3STRINGSupplier group membership #3.
supplier_group_4STRINGSupplier group membership #4.
supplier_nameSTRINGName of the Supplier.
supplier_company_nameSTRINGCompany name of the Supplier.
supplier_business_identifierSTRINGImplementation specific generic label.
supplier_industrySTRINGIndustry of the Supplier.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.

reporting.search_term

  • namespace

Search Term data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, retailer_id, search_term
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = search_term.env_namespace;
retailer on retailer.env_namespace = search_term.env_namespace and retailer.retailer_id = search_term.retailer_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_nameSTRINGName of the Retailer.
search_termSTRINGThe word/phrase being searched for on the retailer site by the end user.
num_ad_requestsINTEGERTotal number of Requests.
num_realised_adsINTEGERTotal number of Ads realised.
ad_request_rankINTEGERRank of the Search Term by total Requests.
ad_stat_rankINTEGERRank of the Search Term by total Ads realised.
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.

reporting.supplier

  • supplier
  • namespace

Supplier data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, supplier_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = supplier.env_namespace;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
supplier_nameSTRINGName of the Supplier.
team_typeSTRINGType of Team (SUPPLIER).
supplier_company_nameSTRINGCompany name of the Supplier.
supplier_business_identifierSTRINGImplementation specific generic label.
supplier_industrySTRINGIndustry of the Supplier.
namespaceSTRINGName of the Namespace.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
created_atTIMESTAMPDate the record was created in the source system.
updated_atTIMESTAMPDate the record was updated in the source system.
last_campaign_created_idSTRINGInternal identifier of the Campaign last created by the Supplier Team (from the source system).
last_campaign_created_dateTIMESTAMPDate the Supplier created the most recent Campaign.
last_campaign_updated_idSTRINGInternal identifier of the Campaign last modified by the Supplier Team (from the source system).
last_campaign_updated_dateTIMESTAMPDate the Supplier updated the most recent Campaign.
total_campaignsINTEGERTotal number of Campaigns associated with Supplier (including inactive).
total_active_campaignsINTEGERTotal active Campaigns associated with the Supplier.
total_spendNUMERICTotal AdSpend to date for the Supplier across all Campaigns.
last_spend_dateDATEMost recent date that AdSpend was incurred by the Supplier.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.

reporting.supplier_product

  • supplier

Supplier centric Product data (only relevant Products as referenced within Realised Ads generated by Supplier Campaigns).

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, normalised_product_code, product_code, catalog_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
supplier_group_1STRINGSupplier group membership #1.
supplier_group_2STRINGSupplier group membership #2.
supplier_group_3STRINGSupplier group membership #3.
supplier_group_4STRINGSupplier group membership #4.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
product_codeSTRINGProduct code.
product_nameSTRINGName of the Product.
product_typeSTRINGType of the Product.
retailer_taxonomySTRINGTaxonomy (product hierarchy) of the Product as specified by the Retailer.
google_product_taxonomySTRINGGoogle taxonomy (product hierarchy) of the Product. Levels of the hierarchy delimited using > symbol.
catalog_idSTRINGInternal identifier of the Catalog (from the source system).
catalog_nameSTRINGName of the Catalog.
product_image_urlSTRINGURL to an image of the Product for the Ad.
brandSTRINGBrand of the Product.

reporting.supplier_retailer

  • supplier

Supplier centric Retailer data (only relevant Retailers as referenced within Realised Ads generated by Supplier Campaigns).

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, retailer_id, category_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
supplier_group_1STRINGRetailer group membership #1.
supplier_group_2STRINGRetailer group membership #2.
supplier_group_3STRINGRetailer group membership #3.
supplier_group_4STRINGRetailer group membership #4.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
retailer_group_1STRINGRetailer group membership #1.
retailer_group_2STRINGRetailer group membership #2.
retailer_nameSTRINGName of the Retailer.
retailer_company_nameSTRINGCompany name of the Retailer.
retailer_business_identifierSTRINGImplementation specific generic label.
retailer_industrySTRINGIndustry of the Retailer.
currency_codeSTRINGISO 4217 currency code
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
supplier_nameSTRINGName of the Supplier.
enhanced_attribution_flagSTRINGIf true, the first enhanced attribution model will be calculated.
enhanced_attribution_flag_2STRINGIf true, the second enhanced attribution model will be calculated.
retailer_taxonomy_haloSTRINGComma separated list of what halo levels will be computed for model 1.
retailer_taxonomy_halo_2STRINGComma separated list of what halo levels will be computed for model 2.
view_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution.
view_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for View Thru Attribution (2nd model).
click_attribution_windowNUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (1st model).
click_attribution_window_2NUMERICMax number of days allowed between the Order and Realised Ad for Halo Click Attribution (2nd model).

reporting.team

  • supplier
  • retailer
  • namespace

Team data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, team_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = team.env_namespace;
retailer on retailer.env_namespace = team.env_namespace and retailer.retailer_id = team.retailer_id;
supplier on supplier.env_namespace = team.env_namespace and supplier.supplier_id = team.supplier_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
team_idSTRINGInternal identifier of the Team (from the source system).
team_nameSTRINGName of the Team.
team_typeSTRINGType of Team (RETAILER or SUPPLIER).
company_nameSTRINGCompany name of the Team.
business_identifierSTRINGImplementation specific generic label.
industrySTRINGIndustry of the Team.
user_idSTRINGInternal identifier of the User (from the source system).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
supplier_nameSTRINGName of the Supplier.
namespaceSTRINGName of the Namespace.
created_atTIMESTAMPDate the record was created in the source system.
updated_atTIMESTAMPDate the record was updated in the source system.
last_campaign_created_idSTRINGInternal identifier of the Campaign last created by the Team (from the source system).
last_campaign_created_dateTIMESTAMPDate the Team created the most recent Campaign.
last_campaign_updated_idSTRINGInternal identifier of the Campaign last modified by the Team (from the source system).
last_campaign_updated_dateTIMESTAMPDate the Team updated the most recent Campaign.
total_campaignsINTEGERTotal number of Campaigns associated with Team (including inactive).
total_active_campaignsINTEGERTotal active Campaigns associated with the Team.
total_spendNUMERICTotal AdSpend to date for the Team across all Campaigns.
last_spend_dateDATEMost recent date that AdSpend was incurred by the Supplier.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.
phoneSTRINGThe company phone number
company_websiteSTRINGThe company website
company_address_line_1STRINGThe company address
company_address_post_codeSTRINGPost code of the company address
contact_emailSTRINGEmail address of the company contact

reporting.user

  • namespace

User data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, user_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = user.env_namespace;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
user_idSTRINGInternal identifier of the User (from the source system).
user_nameSTRINGName of the User.
emailSTRINGUser's email address.
adminSTRINGFlag if the User is an administrator.
activatedBOOLEANFlag indicating that a User has activated their account.
system_permissionsSTRINGUser system permissions.
action_permissionSTRINGUser action permissions.
subject_permissionSTRINGUser subject permissions.
namespaceSTRINGName of the Namespace.
created_atTIMESTAMPDate the record was created in the source system.
updated_atTIMESTAMPDate the record was updated in the source system.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
is_activeBOOLEANFlag to indicate that the record is active in the source system.
is_deletedBOOLEANFlag to indicate that the record has been soft deleted in the source system.
is_currentBOOLEANFlag if the row is the latest version in the source system.

reporting.user_team

  • namespace

Team users data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, team_id, user_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = user_team.env_namespace;
retailer on retailer.env_namespace = user_team.env_namespace and retailer.retailer_id = user_team.retailer_id;
supplier on supplier.env_namespace = user_team.env_namespace and supplier.supplier_id = user_team.supplier_id;
user on user.env_namespace = user_team.env_namespace and user.user_id = user_team.user_id;
team on team.env_namespace = user_team.env_namespace and team.team_id = user_team.team_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
team_idSTRINGInternal identifier of the Team (from the source system).
user_idSTRINGInternal identifier of the User (from the source system).
user_nameSTRINGName of the User.
team_nameSTRINGName of the Team.
team_typeSTRINGType of Team (RETAILER or SUPPLIER).
namespaceSTRINGName of the Namespace.
company_nameSTRINGCompany name of the Team.
industrySTRINGIndustry of the Team.
emailSTRINGUser's email address.
adminBOOLEANFlag if the User is an administrator.
activatedBOOLEANFlag indicating that a User has activated their account.
system_permissionsSTRINGUser system permissions.
action_permissionSTRINGUser action permissions.
subject_permissionSTRINGUser subject permissions.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
supplier_nameSTRINGName of the Supplier.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.

reporting.viz_global_campaign_out

  • supplier
  • retailer
  • namespace

Campaign data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is campaign.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, CampaignId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
CampaignIdSTRINGUnique identifier for the advertising campaign
CampaignNameSTRINGDisplay name of the advertising campaign
CampaignTypeSTRINGPrimary classification of the campaign (e.g., sponsored products, display ads)
CampaignSubtypeSTRINGSecondary classification of the campaign providing additional categorization
RetailerIdSTRINGUnique identifier of the retailer associated with this campaign
SupplierIdSTRINGUnique identifier of the supplier running this campaign
RetailerNameSTRINGDisplay name of the retailer associated with this campaign
SupplierNameSTRINGDisplay name of the supplier running this campaign
WalletIdSTRINGIdentifier of the wallet funding this campaign
IsFtaSTRINGIndicates if this is a first-time advertiser (FTA) campaign
FtaCostNUMERICCost allocated for first-time advertiser benefits
WalletNameSTRINGDisplay name of the wallet funding this campaign
WalletExternalIdSTRINGExternal system identifier for the wallet
WalletArchivedBOOLIndicates if the associated wallet has been archived
WalletCreditLimitNUMERICMaximum credit amount allowed for the associated wallet
WalletCurrencyCodeSTRINGThree-letter ISO currency code for the wallet
WalletTotalPurchasedCreditsNUMERICTotal amount of credits purchased for the wallet
WalletAvailableBalanceNUMERICCurrent available balance in the wallet's currency
WalletCreditLimitUsdNUMERICMaximum credit amount allowed for the wallet in USD
WalletAvailableBalanceUsdNUMERICCurrent available balance converted to USD
WalletTotalPurchasedCreditsUsdNUMERICTotal amount of credits purchased converted to USD
CampaignStartDateTIMESTAMPDate and time when the campaign begins or began running
CampaignEndDateTIMESTAMPDate and time when the campaign stops or stopped running
CampaignValidStateSTRINGValidation status of the campaign (e.g., valid, invalid)
CampaignActiveStateSTRINGCurrent activity state of the campaign (e.g., active, paused, completed)
CampaignCreatedAtTIMESTAMPTimestamp when the campaign was created
CampaignUpdatedAtTIMESTAMPTimestamp when the campaign was last modified
CampaignPlacementsSTRINGList of advertising placement locations for this campaign
CampaignTotalSpendNUMERICTotal amount spent by this campaign in campaign currency
CampaignTotalSpendUsdNUMERICTotal amount spent by this campaign converted to USD
CampaignMaxCostPerClickNUMERICMaximum allowed cost per click for this campaign
CampaignMaxTotalSpendNUMERICMaximum total budget allocated for this campaign
CampaignMaxDailySpendNUMERICMaximum amount that can be spent per day on this campaign
CampaignImpressionGoalNUMERICTarget number of impressions for the campaign
CampaignCatalogProductsSTRINGList of product identifiers included in this campaign
CampaignAttr1STRINGCustom attribute for campaign categorization
RetailerGroup1STRINGPrimary grouping category for retailer
RetailerGroup2STRINGSecondary grouping category for retailer
SupplierGroup1STRINGPrimary grouping category for supplier
SupplierGroup2STRINGSecondary grouping category for supplier
SupplierGroup3STRINGTertiary grouping category for supplier
SupplierGroup4STRINGQuaternary grouping category for supplier
TeamIdSTRINGIdentifier of the team that owns this campaign
RetailerAdSpendTypeSTRINGClassification of ad spend type from retailer perspective
SupplierAdSpendTypeSTRINGClassification of ad spend type from supplier perspective
BudgetNUMERICTotal budget allocated for the campaign
TargetedFiltersSTRINGTargeting criteria applied to the campaign
LocationFiltersSTRINGGeographic targeting filters applied to the campaign
FilterWhitelistsSTRINGApproved list of targeting exceptions for the campaign
CrossSellSettingsSTRINGConfiguration for cross-sell product recommendations
UpsellSettingsSTRINGConfiguration for upsell product recommendations
CategoriesSTRINGList of product categories targeted by this campaign
CatalogCountINT64Number of products in the campaign catalog
CatalogIdsSTRINGList of catalog identifiers associated with this campaign
SearchTermsSTRINGList of search terms targeted by this campaign
HasSearchTermsBOOLIndicates if the campaign targets specific search terms
LastSpendDateDATEMost recent date when the campaign incurred spend
GeoRegionSTRINGGeographic region where the campaign is running
LocalTimezoneSTRINGLocal timezone identifier for the campaign
ProductTypeCodeSTRINGClassification code for the type of products in the campaign
CtaTextSTRINGCall-to-action text used in the campaign
SuggestedSearchTermsSTRINGSystem-recommended search terms for the campaign
HasSuggestedSearchTermsBOOLIndicates if the campaign has system-suggested search terms
IsCurrentBOOLIndicates if this is the current active version of the campaign
ActiveStateSTRINGCurrent activity state of the campaign
ValidStateSTRINGCurrent validation state of the campaign
RegionSTRINGSystem region identifier for the campaign
RegionNamespaceSTRINGCombined region and namespace identifier for the campaign
WalletAvaliableBalanceNUMERICCurrent available balance in the wallet (alternate field)
RetailerSTRINGRetailer identifier (alternate field)
SupplierSTRINGSupplier identifier (alternate field)
CurrencyCodeSTRINGThree-letter ISO currency code for the campaign
CatalogProductsSTRINGList of product identifiers in the campaign (alternate field)
CreatedAtTIMESTAMPTimestamp when the campaign was created (alternate field)
UpdatedAtTIMESTAMPTimestamp when the campaign was last modified (alternate field)
StartDateTIMESTAMPCampaign start date and time (alternate field)
EndDateTIMESTAMPCampaign end date and time (alternate field)
IDSTRINGUnique identifier for the campaign (alternate field)
NameSTRINGDisplay name of the campaign (alternate field)
ImpressionGoalNUMERICTarget number of impressions (alternate field)
MaxCostPerClickNUMERICMaximum allowed cost per click (alternate field)
MaxTotalSpendNUMERICMaximum total budget (alternate field)
MaxDailySpendNUMERICMaximum daily spend limit (alternate field)
PlacementsSTRINGAd placement locations (alternate field)
TotalSpendNUMERICTotal campaign spend (alternate field)
TotalSpendUsdNUMERICTotal campaign spend in USD (alternate field)
NamespaceSTRINGSystem namespace identifier (alternate field)
IsActiveBOOLIndicates if the campaign is currently active
IsDeletedBOOLIndicates if the campaign has been deleted

reporting.viz_global_catalog_out

  • retailer
  • namespace

Catalog data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is catalog.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, CatalogId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
CatalogNameSTRINGName of the Catalog.
RetailerNameSTRINGName of the Retailer.
CurrencyCodeSTRINGISO currency code for the catalog.
NamespaceSTRINGName of the Namespace.
RetailerGroup1STRINGPrimary grouping category for the Retailer.
RetailerGroup2STRINGSecondary grouping category for the Retailer.
GeoRegionSTRINGGeographic region where the catalog is used.
LocalTimezoneSTRINGLocal timezone of the catalog's primary region.
IsActiveBOOLIndicates if the catalog is currently active.
IsDeletedBOOLIndicates if the catalog has been deleted.
IsCurrentBOOLIndicates if this is the current version of the catalog record.
RegionSTRINGGeographic region identifier.
RegionNamespaceSTRINGNamespace specific to the geographic region.
IDSTRINGAlternative identifier for the catalog.
NameSTRINGAlternative name for the catalog.
RetailerSTRINGAlternative retailer identifier or name.
SupplierSTRINGAssociated supplier identifier or name if applicable.

reporting.viz_global_category_out

  • supplier
  • retailer
  • namespace

Category data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is category.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, RetailerId, CategoryId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
CategoryIdSTRINGIdentifier for the category.
NamespaceSTRINGName of the business namespace.
CategoryLabelSTRINGLabel for the category.
CatLevel1STRINGCategory level 1.
CatLevel2STRINGCategory level 2.
CatLevel3STRINGCategory level 3.
CatLevel4STRINGCategory level 4.
CatLevel5STRINGCategory level 5.
CatLevel6STRINGCategory level 6.
CatLevel7STRINGCategory level 7.
CategoryLabelCountINT64Count of labels in the category.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.

reporting.viz_global_daily_wallet_balance

  • supplier
  • retailer
  • namespace

Daily wallet balance data.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: env_namespace, wallet_id, date
Other Unique Key(s):
Partition: date (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = wallet_balance.env_namespace;
team on team.env_namespace = wallet_balance.env_namespace and team.team_id = wallet_balance.wallet_team_id;
wallet on wallet.env_namespace = wallet_balance.env_namespace and wallet.wallet_id = wallet_balance.wallet_id;

Column NameData TypeDescription
DateDATEThe date of the wallet balance record
EarliestCreditDateTIMESTAMPTimestamp of the earliest credit transaction for this wallet
LatestCreditDateTIMESTAMPTimestamp of the most recent credit transaction for this wallet
PreviousDateDATEThe previous day's date for balance comparison
ExpectedWalletEmptyDateDATEProjected date when the wallet balance will reach zero based on current spend rate
RegionSTRINGGeographic region identifier
NamespaceSTRINGSystem namespace identifier
RegionNamespaceSTRINGCombined region and namespace identifier
WalletIdSTRINGInternal identifier of the wallet (from the source system)
WalletTeamIdSTRINGInternal identifier of the team that owns the wallet
ExternalIdSTRINGExternal system identifier for the wallet
CurrencyCodeSTRINGThree-letter ISO currency code for the wallet (e.g., USD, AUD)
WalletNameSTRINGDisplay name of the wallet
ArchivedBOOLIndicates if the wallet has been archived
TeamNameSTRINGDisplay name of the team that owns the wallet
RetailerSTRINGIdentifier of the associated retailer
SupplierSTRINGIdentifier of the associated supplier
AvailableBalanceNUMERICCurrent available balance in the wallet's currency
PrepaidBalanceNUMERICPrepaid amount available in the wallet's currency
CreditLimitNUMERICMaximum credit amount allowed for this wallet
ActiveCampaignCountNUMERICNumber of currently active advertising campaigns
ActiveCampaignMaxTotalSpendNUMERICSum of maximum spend limits across all active campaigns
TotalPurchasedCreditsNUMERICTotal amount of credits purchased for this wallet
PreviousAvailableBalanceNUMERICAvailable balance from the previous day in wallet's currency
PreviousAvailableBalanceUSDNUMERICAvailable balance from the previous day converted to USD
TotalPurchasedCreditsUSDNUMERICTotal amount of credits purchased converted to USD
CreditLimitUSDNUMERICMaximum credit amount allowed converted to USD
AvailableBalanceUSDNUMERICCurrent available balance converted to USD
PrepaidBalanceUSDNUMERICPrepaid amount available converted to USD
BurnRatePerDayNUMERICAverage daily spend rate in wallet's currency
BurnRatePerDayUSDNUMERICAverage daily spend rate converted to USD
TotalAdSpendNUMERICTotal advertising spend within the considered period
AdSpendConsideredFromDATEStart date of the period considered for ad spend calculations
AdSpendConsideredToDATEEnd date of the period considered for ad spend calculations
IdSTRINGUnique identifier for this daily wallet balance record
NameSTRINGDisplay name associated with this balance record
TeamIdSTRINGInternal identifier of the team associated with this wallet
GeoRegionSTRINGGeographic region identifier for the wallet
LocalTimezoneSTRINGLocal timezone identifier for the wallet
IsCurrentRowSTRINGFlag indicating if this is the current active record

reporting.viz_global_decorated_ad__adrequest_stats_out

  • retailer
  • namespace

Request and Realised Ad data (aggregated and unioned). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is ad_request__realised_ad_view.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, Date, CatalogId, RetailerId, SupplierId, CampaignId, AdType, SearchTerm, GenericSearchTerm, ProductCode, ContentStandardId, SlotId, Category, Placement, Platform
Other Unique Key(s):
Partition: Refer to ad_request__realised_ad_view

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
RegionSTRINGGeographical region of the ad request.
NamespaceSTRINGName of the business namespace.
RegionNamespaceSTRINGNamespace prefixed with the region.
DateDATEDate of the ad request.
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
CampaignStartDateTIMESTAMPStart date and time of the campaign.
CampaignCreatedAtTIMESTAMPDate and time when the campaign was created.
CampaignEndDateTIMESTAMPEnd date and time of the campaign.
CampaignUpdatedAtTIMESTAMPDate and time when the campaign was last updated.
WalletCaptureDateTIMESTAMPDate and time when the wallet was captured.
SearchTermSTRINGSearch term entered by the customer.
PlacementSTRINGDisplay name of the ad placement.
PlatformSTRINGPlatform where the ad is served (e.g., web, mobile).
CategorySTRINGCategory being targeted.
GenericSearchTermSTRINGNormalized version of the search term.
AdTypeNameSTRINGName of the ad type.
CatalogNameSTRINGName of the catalog.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
RetailerNameSTRINGName of the retailer.
RetailerIndustrySTRINGIndustry category of the retailer.
RetailerBusinessIdentifierSTRINGBusiness identifier for the retailer.
RetailerCompanyNameSTRINGCompany name of the retailer.
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
SupplierGroup1STRINGSupplier group membership #1.
SupplierGroup2STRINGSupplier group membership #2.
SupplierGroup3STRINGSupplier group membership #3.
SupplierGroup4STRINGSupplier group membership #4.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.
TeamNameSTRINGName of the team managing the campaign.
CategoryLabelSTRINGLabel for the category.
CampaignIdSTRINGInternal identifier of the Campaign (from the source system).
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
ProductCodeSTRINGProduct code (from the source system).
ContentStandardIdSTRINGContent standard identifier.
SlotIdSTRINGIdentifier for the ad slot.
SupplierNameSTRINGName of the Supplier.
SupplierCompanyNameSTRINGRegistered company name of the Supplier.
SupplierBusinessIdentifierSTRINGBusiness identifier of the Supplier.
SupplierIndustrySTRINGIndustry classification of the Supplier.
CurrencyCodeSTRINGCurrency code for the monetary values.
IsFTASTRINGIndicates if the campaign is FTA (Free Trade Agreement) eligible.
CampaignActiveStateSTRINGCurrent active state of the campaign.
CampaignPlacementsSTRINGDetails of placements for the campaign.
CampaignTypeSTRINGType of the campaign.
WalletNameSTRINGName of the wallet used.
WalletIdSTRINGIdentifier of the wallet.
CampaignNameSTRINGName of the campaign.
CampaignCatalogProductsSTRINGProducts associated with the campaign.
CampaignSubtypeSTRINGSubtype of the campaign.
CampaignValidStateSTRINGValidity state of the campaign.
WalletArchivedBOOLIndicates if the wallet is archived.
WalletExternalIdSTRINGExternal identifier for the wallet.
CampaignAttr1STRINGCustom attribute 1 for the campaign.
CTATextSTRINGCall to action text for the ad.
ProductNameSTRINGName of the product.
ProductTypeSTRINGType of the product.
ProductTagsSTRINGTags associated with the product.
BrandSTRINGBrand name of the product.
TypeSTRINGType classification of the product.
UPCSTRINGUniversal Product Code (UPC) of the product.
AdTypeINT64Type identifier for the ad format or placement type.
HasSearchTermINT64Indicates if there is a search term available.
HasCategoryINT64Indicates if there is a category available.
SalesRevenueNUMERICTotal revenue generated from sales.
AdRevenueNUMERICTotal revenue generated from ads.
AdSpendNUMERICTotal amount spent on ads.
ImpressionsNUMERICNumber of times ads were shown.
ClicksNUMERICNumber of times ads were clicked.
ConversionsNUMERICNumber of ad conversions.
UnitSalesNUMERICNumber of units sold.
ClickSpendNUMERICAmount spent per click.
ImpressionSpendNUMERICAmount spent per impression.
PositionSumNUMERICSum of positions for the ad.
AdsWithPositionCountNUMERICCount of ads with position data.
MaxCpcNUMERICMaximum cost per click across ads.
MinCpcNUMERICMinimum cost per click across ads.
StdDevCpcFLOAT64Standard deviation of cost per click.
VarianceCpcFLOAT64Variance of cost per click.
MaxCpiNUMERICMaximum cost per impression across ads.
MinCpiNUMERICMinimum cost per impression across ads.
StdDevCpiFLOAT64Standard deviation of cost per impression.
VarianceCpiFLOAT64Variance of cost per impression.
SalesRevenueUSDFLOAT64Sales revenue in USD.
AdRevenueUSDFLOAT64Ad revenue in USD.
AdSpendUSDFLOAT64Ad spend in USD.
CampaignTotalSpendNUMERICTotal amount spent on the campaign.
WalletAvailableBalanceNUMERICAvailable balance in the wallet.
CampaignMaxTotalSpendNUMERICMaximum total spend limit for the campaign.
CampaignMaxCostPerClickNUMERICMaximum cost per click for the campaign.
WalletTotalPurchasedCreditsNUMERICTotal purchased credits in the wallet.
CampaignImpressionGoalNUMERICImpression goal set for the campaign.
FTACostNUMERICCost associated with FTA.
CampaignMaxDailySpendNUMERICMaximum daily spend limit for the campaign.
CampaignTotalSpendUSDNUMERICTotal spend in USD for the campaign.
WalletAvaliableBalanceNUMERICAvailable balance in the wallet (duplicate field).
WalletCreditLimitNUMERICCredit limit for the wallet.
EarliestTopUpAmountUSDNUMERICEarliest top-up amount in USD.
AvailableBalanceNUMERICCurrent available balance in the wallet's currency
WalletTeamIdSTRINGInternal identifier of the team that owns the wallet
ExternalIdSTRINGExternal system identifier for the wallet
ArchivedBOOLIndicates if the wallet has been archived
EarliestCreditDateTIMESTAMPTimestamp of the earliest credit transaction for this wallet
LatestCreditDateTIMESTAMPTimestamp of the most recent credit transaction for this wallet
PreviousDateDATEThe previous day's date for balance comparison
ExpectedWalletEmptyDateDATEProjected date when the wallet balance will reach zero based on current spend rate
PrepaidBalanceNUMERICPrepaid amount available in the wallet's currency
CreditLimitNUMERICMaximum credit amount allowed for this wallet
ActiveCampaignCountNUMERICNumber of currently active advertising campaigns
ActiveCampaignMaxTotalSpendNUMERICSum of maximum spend limits across all active campaigns
TotalPurchasedCreditsNUMERICTotal amount of credits purchased for this wallet
PreviousAvailableBalanceNUMERICAvailable balance from the previous day in wallet's currency
TotalPurchasedCreditsUSDNUMERICTotal amount of credits purchased converted to USD
CreditLimitUSDNUMERICMaximum credit amount allowed converted to USD
AvailableBalanceUSDNUMERICCurrent available balance converted to USD
PrepaidBalanceUSDNUMERICPrepaid amount available converted to USD
BurnRatePerDayNUMERICAverage daily spend rate in wallet's currency
CurrencyValueNUMERICValue of the currency used.
ReservedSearchTermFlagSTRINGFlag for reserved search terms.
CatLevel1STRINGCategory level 1.
CatLevel2STRINGCategory level 2.
CatLevel3STRINGCategory level 3.
CatLevel4STRINGCategory level 4.
CatLevel5STRINGCategory level 5.
CatLevel6STRINGCategory level 6.
CatLevel7STRINGCategory level 7.
PageTypeNUMERICIdentifier for the type of page the ad is displayed on.
NumAdsConsideredNUMERICNumber of ads considered for the request.
NumAdsServedNUMERICNumber of ads served.
NumAdsRequestedNUMERICNumber of ads requested.
CappedNumAdsServedNUMERICCapped number of ads served.
CappedNumAdsRequestedNUMERICCapped number of ads requested.
CappedNumRequestsServingMaxAdsNUMERICCapped number of requests serving the maximum number of ads.
NumRequestsServingMaxAdsNUMERICNumber of requests serving the maximum number of ads.
NumAdRequestsServingNoAdsNUMERICNumber of ad requests where no ads were served.
NumAdRequestsServingSomeAdsNUMERICNumber of ad requests where at least one ad was served.
NumAdRequestsNUMERICTotal number of ad requests.
NumAdRequestsWithSaturationNUMERICNumber of ad requests that served at least 4 ads or filled the entire request.
FilterModeINTEGERMode of filtering applied to the ad request.

reporting.viz_global_decorated_ad_stats_out

  • supplier

Realised Ad (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is realised_ad_agg_view.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, Date, CatalogId, RetailerId, SupplierId, CampaignId, AdType, SearchTerm, GenericSearchTerm, ProductCode, ContentStandardId, SlotId, Category, Placement, Platform
Other Unique Key(s):
Partition: Refer to realised_ad_agg_view

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
RegionSTRINGGeographical region of the ad request.
NamespaceSTRINGName of the business namespace.
RegionNamespaceSTRINGNamespace prefixed with the region.
DateDATEDate of the ad event.
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
CampaignIdSTRINGInternal identifier of the Campaign (from the source system).
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
SearchTermSTRINGSearch term that triggered the ad request.
GenericSearchTermSTRINGGeneric version of the search term, if applicable.
ProductCodeSTRINGProduct code (from the source system).
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
ContentStandardIdSTRINGContent standard identifier.
SlotIdSTRINGIdentifier for the ad slot.
CategorySTRINGCategory being targeted.
PlacementSTRINGDisplay name of the Placement.
PlatformSTRINGPlatform where the ad is served (e.g., web, mobile).
AdTypeINTEGERType identifier for the ad format or placement type.
CatalogNameSTRINGName of the catalog.
AdTypeNameSTRINGName of the ad type.
GeoRegionSTRINGGeographical region targeting for the ad.
LocalTimezoneSTRINGLocal timezone of the retailer.
RetailerSTRINGRetailer associated with the ad.
RetailerIndustrySTRINGIndustry category of the retailer.
RetailerCompanyNameSTRINGCompany name of the retailer.
RetailerNameSTRINGName of the retailer.
RetailerBusinessIdentifierSTRINGBusiness identifier for the retailer.
SupplierSTRINGSupplier associated with the ad.
SupplierNameSTRINGName of the supplier.
SupplierCompanyNameSTRINGCompany name of the supplier.
SupplierBusinessIdentifierSTRINGBusiness identifier for the supplier.
SupplierIndustrySTRINGIndustry category of the supplier.
CampaignTotalSpendNUMERICTotal amount spent on the campaign.
CurrencyCodeSTRINGCurrency code for the monetary values.
IsFTASTRINGIndicates if the campaign is FTA (Free Trade Agreement) eligible.
WalletAvailableBalanceNUMERICAvailable balance in the wallet.
CampaignActiveStateSTRINGCurrent active state of the campaign.
CampaignPlacementsSTRINGDetails of placements for the campaign.
CampaignTypeSTRINGType of the campaign.
WalletNameSTRINGName of the wallet used.
CampaignStartDateTIMESTAMPStart date and time of the campaign.
CampaignMaxTotalSpendNUMERICMaximum total spend limit for the campaign.
CampaignCreatedAtTIMESTAMPCreation date and time of the campaign.
CampaignMaxCostPerClickNUMERICMaximum cost per click for the campaign.
CampaignEndDateTIMESTAMPEnd date and time of the campaign.
WalletIdSTRINGIdentifier of the wallet.
CampaignNameSTRINGName of the campaign.
CampaignCatalogProductsSTRINGProducts associated with the campaign.
WalletTotalPurchasedCreditsNUMERICTotal purchased credits in the wallet.
CampaignSubtypeSTRINGSubtype of the campaign.
CampaignValidStateSTRINGValidity state of the campaign.
CampaignImpressionGoalNUMERICImpression goal set for the campaign.
FTACostNUMERICCost associated with FTA.
WalletArchivedBOOLEANIndicates if the wallet is archived.
CampaignMaxDailySpendNUMERICMaximum daily spend limit for the campaign.
CampaignTotalSpendUSDNUMERICTotal spend in USD for the campaign.
WalletExternalIdSTRINGExternal identifier for the wallet.
CampaignUpdatedAtTIMESTAMPLast updated date and time of the campaign.
WalletAvaliableBalanceNUMERICAvailable balance in the wallet (duplicate field).
WalletCreditLimitNUMERICCredit limit for the wallet.
CampaignAttr1STRINGCustom attribute 1 for the campaign.
CTATextSTRINGCall to action text for the ad.
TeamNameSTRINGName of the team managing the campaign.
WalletCaptureDateTIMESTAMPDate when the wallet was captured.
EarliestTopUpAmountUSDNUMERICEarliest top-up amount in USD.
CategoryLabelSTRINGLabel for the category.
ProductNameSTRINGName of the product.
ProductTypeSTRINGType of the product.
ProductTagsSTRINGTags associated with the product.
BrandSTRINGBrand name of the product.
TypeSTRINGType classification of the product.
UPCSTRINGUniversal Product Code (UPC) of the product.
RetailerGroup1STRINGFirst group classification for the retailer.
RetailerGroup2STRINGSecond group classification for the retailer.
SupplierGroup1STRINGFirst group classification for the supplier.
SupplierGroup2STRINGSecond group classification for the supplier.
SupplierGroup3STRINGThird group classification for the supplier.
SupplierGroup4STRINGFourth group classification for the supplier.
HasSearchTermINTEGERIndicates if there is a search term available.
HasCategoryINTEGERIndicates if there is a category available.
SalesRevenueNUMERICRevenue generated from sales.
AdRevenueNUMERICRevenue generated from ads.
AdSpendNUMERICAmount spent on ads.
ImpressionsNUMERICNumber of times the ad was displayed.
ClicksNUMERICNumber of times the ad was clicked.
ConversionsNUMERICNumber of conversions attributed to the ad.
UnitSalesNUMERICNumber of units sold.
ClickSpendNUMERICAmount spent per click.
ImpressionSpendNUMERICAmount spent per impression.
PositionSumNUMERICSum of positions for the ad.
AdsWithPositionCountNUMERICCount of ads with position data.
MaxCpcNUMERICMaximum cost per click across ads.
MinCpcNUMERICMinimum cost per click across ads.
StdDevCpcFLOATStandard deviation of cost per click.
VarianceCpcFLOATVariance of cost per click.
MaxCpiNUMERICMaximum cost per impression across ads.
MinCpiNUMERICMinimum cost per impression across ads.
StdDevCpiFLOATStandard deviation of cost per impression.
VarianceCpiFLOATVariance of cost per impression.
SalesRevenueUSDFLOATSales revenue in USD.
AdRevenueUSDFLOATAd revenue in USD.
AdSpendUSDFLOATAd spend in USD.
EnableSalesMetricsBOOLEANFlag to enable sales metrics.

reporting.viz_global_decorated_adrequests_stats_out

  • retailer
  • namespace

Request (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is ad_request_agg_view.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, Date, RetailerId, CatalogId, RequestTypeName, SearchTerm, ReservedSearchTermFlag, GenericSearchTerm, Placement, Platform, PageType, FilterMode, SlotId, Category
Other Unique Key(s):
Partition: Refer to ad_request_agg_view

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
SearchTermSTRINGSearch term that triggered the ad request.
GenericSearchTermSTRINGGeneric version of the search term, if applicable.
SlotIdSTRINGIdentifier for the ad slot.
CategorySTRINGCategory being targeted.
CatLevel1STRINGCategory level 1.
CatLevel2STRINGCategory level 2.
CatLevel3STRINGCategory level 3.
CatLevel4STRINGCategory level 4.
CatLevel5STRINGCategory level 5.
CatLevel6STRINGCategory level 6.
CatLevel7STRINGCategory level 7.
CategoryLabelSTRINGLabel for the category.
AdTypeINT64Type identifier for the ad format or placement type.
ReservedSearchTermFlagSTRINGFlag for reserved search terms.
PlacementSTRINGDisplay name of the Placement.
PlatformSTRINGPlatform where the ad is served (e.g., web, mobile).
PageTypeINT64Identifier for the type of page the ad is displayed on.
FilterModeINT64Mode of filtering applied to the ad request.
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
CatalogNameSTRINGName of the catalog.
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
RetailerNameSTRINGName of the Retailer.
RetailerIndustrySTRINGIndustry category of the retailer.
RetailerBusinessIdentifierSTRINGBusiness identifier for the retailer.
RetailerCompanyNameSTRINGCompany name of the retailer.
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.
HasSearchTermINT64Indicates if there is a search term available.
HasCategoryINT64Indicates if there is a category available.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
DateDATEDate of the ad request.
AdTypeNameSTRINGName of the ad type.
RequestTypeNameSTRINGName of the ad request type.
NamespaceSTRINGName of the business namespace.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.
SupplierGroup1STRINGSupplier group membership #1.
SupplierGroup2STRINGSupplier group membership #2.
SupplierGroup3STRINGSupplier group membership #3.
SupplierGroup4STRINGSupplier group membership #4.
NumAdsConsideredNUMERICNumber of ads considered for the request.
NumAdsServedNUMERICNumber of ads served.
NumAdsRequestedNUMERICNumber of ads requested.
CappedNumAdsServedNUMERICCapped number of ads served.
CappedNumAdsRequestedNUMERICCapped number of ads requested.
CappedNumRequestsServingMaxAdsNUMERICCapped number of requests serving the maximum number of ads.
NumRequestsServingMaxAdsNUMERICNumber of requests serving the maximum number of ads.
NumAdRequestsServingNoAdsNUMERICNumber of ad requests where no ads were served.
NumAdRequestsServingSomeAdsNUMERICNumber of ad requests where at least one ad was served.
NumAdRequestsNUMERICTotal number of ad requests.
NumAdRequestsWithSaturationNUMERICNumber of ad requests that served at least 4 ads or filled the entire request.

reporting.viz_global_decorated_bucketed_order_ad_stats_out

  • retailer
  • namespace

Order and Realised Ad (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is order_ad_stats.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, RetailerId, OrderDate, ProductCode, NormalisedProductCode, CatalogId
Other Unique Key(s):
Partition: Refer to order_ad_stats

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
OrderDateDATEDate of the order.
RegionSTRINGGeographical region of the ad request.
NamespaceSTRINGName of the business namespace.
RegionNamespaceSTRINGNamespace prefixed with the region.
ProductCodeSTRINGProduct code (from the source system).
NormalisedProductCodeSTRINGStandardized product code used for consistent identification.
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
AdStatsProductCodeSTRINGProduct code associated with ad statistics.
ConversionsFromAdsNUMERICNumber of conversions from ads.
UnitSalesFromAdsNUMERICNumber of unit sales from ads.
TotalPriceNUMERICTotal price of the transaction.
QuantityNUMERICQuantity of items.
OrderItemsNUMERICItems in the order.
OrdersNUMERICList of orders.
ProductNameSTRINGName of the product.
BrandSTRINGBrand name of the product.
ProductTypeSTRINGType of the product.
TypeSTRINGType classification of the product.
ProductTagsSTRINGTags associated with the product.
SupplierSTRINGSupplier associated with the ad request.
CurrencyCodeSTRINGCurrency code for the monetary values.
RetailerNameSTRINGName of the Retailer.
RetailerSTRINGRetailer associated with the ad request.
CurrencyValueFLOAT64Value of the currency used.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.

reporting.viz_global_decorated_report_request_tracking_out

  • namespace

CitrusAd client reporting usage (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is report_request_tracking.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace,TeamId,UserId,RequestDate,RequestType,CacheLevel,CountTowardsQuota,ReportSpan,MaxBilledBytesPerDay,MaxUncachedRequestsPerDay
Other Unique Key(s):
Partition: Refer to report_request_tracking

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
NamespaceSTRINGName of the business namespace.
TeamIdSTRINGInternal identifier of the team associated with this wallet
UserIdSTRINGIdentifier of a user associated with the Team.
RequestDateDATEDate of the request.
ReportTypeSTRINGType of report generated.
CacheLevelSTRINGLevel of caching applied.
CountsTowardsQuotaBOOLIndicates if the amount counts towards quota.
ReportSpanSTRINGSpan of the report.
ReportSpanSecondsNUMERICSpan of the report in seconds.
MaxBilledBytesPerDayNUMERICMaximum bytes billed per day.
MaxUncachedRequestsPerDayNUMERICMaximum uncached requests per day.
MaxBilledBytesPerMonthNUMERICMaximum bytes billed per month.
MaxUncachedRequestsPerMonthNUMERICMaximum uncached requests per month.
TeamNameSTRINGName of the team managing the campaign.
UserNameSTRINGName of the user.
UserEmailSTRINGEmail address of the user.
UserIsAdminSTRINGIndicates if the user is an admin.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.
BigQueryBilledBytesNUMERICNumber of bytes billed by BigQuery.
RequestCountINT64Number of requests made.

reporting.viz_global_halo_attribution_out

  • supplier

Enhanced Attribution (aggregated, both models) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is enhanced_attribution_agg_view.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, CampaignId, CategoryId, ProductCode, HaloTaxonomyLevel, OrderDate, IngressedAt, SearchTerm, Placement, Platform, PageType, AttributionModel, RetailerId, OrderType, NormalisedProductCode, ProductName, Brand, RetailerTaxonomy, HaloTaxonomy
Other Unique Key(s):
Partition: Refer to enhanced_attribution_agg_view

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
NamespaceSTRINGName of the business namespace.
IngressedAtDATEThe timestamp when Ad was requested and created.
YYYYMMDDSTRINGYear, month, and day in YYYYMMDD format.
YYYYMMSTRINGYear and month in YYYYMM format.
YYYYSTRINGYear in four-digit format.
WeekStartDateDATEStart date of the week.
OrderDateDATEDate of the order.
NormalisedProductCodeSTRINGStandardized product code used for consistent identification.
ProductCodeSTRINGProduct code (from the source system).
ProductNameSTRINGName of the product.
BrandSTRINGBrand name of the product.
RetailerTaxonomySTRINGRetailer's own product taxonomy classification.
HaloTaxonomySTRINGHalo taxonomy.
HaloTaxonomyLevelINT64Level of halo taxonomy.
CampaignIdSTRINGInternal identifier of the Campaign (from the source system).
SearchTermSTRINGSearch term that triggered the ad request.
PlacementSTRINGDisplay name of the Placement.
PlatformSTRINGPlatform where the ad is served (e.g., web, mobile).
PageTypeINT64Identifier for the type of page the ad is displayed on.
AttributionModelINT64Model used for attribution.
OrderTypeSTRINGType of the order.
CategoryIdSTRINGIdentifier for the category.
CampaignNameSTRINGName of the campaign.
CampaignStartDateTIMESTAMPStart date and time of the campaign.
CampaignEndDateTIMESTAMPEnd date and time of the campaign.
CampaignTypeSTRINGType of the campaign.
CampaignSubtypeSTRINGSubtype of the campaign.
WalletIdSTRINGIdentifier of the wallet.
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
TeamTypeSTRINGType of Team (SUPPLIER or RETAILER).
SupplierNameSTRINGName of the Supplier.
CategoryNameSTRINGName of the category.
WalletNameSTRINGName of the wallet used.
WalletAvailableBalanceNUMERICAvailable balance in the wallet.
WalletCaptureDateDATEDate when the wallet was captured.
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
SupplierGroup1STRINGSupplier group membership #1.
SupplierGroup2STRINGSupplier group membership #2.
SupplierGroup3STRINGSupplier group membership #3.
SupplierGroup4STRINGSupplier group membership #4.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.
HasSearchTermINT64Indicates if there is a search term available.
HasCategoryINT64Indicates if there is a category available.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
ActiveStateSTRINGCurrent activity state of the campaign
ValidStateSTRINGCurrent validation state of the campaign
CTATextSTRINGCall to action text for the ad.
CompanyNameSTRINGRegistered company name of the Team.
RetailerNameSTRINGName of the Retailer.
SupplierCompanyNameSTRINGRegistered company name of the Supplier.
ImpressionsNUMERICNumber of times ads were shown.
ClicksNUMERICNumber of times ads were clicked.
AdSpendNUMERICTotal amount spent on ads.
DirectUnitSalesNUMERICNumber of direct unit sales.
DirectSalesValueNUMERICValue of direct sales.
DirectConversionsNUMERICNumber of direct conversions.
ViewThroughUnitSalesNUMERICNumber of view-through unit sales.
ViewThroughSalesValueNUMERICValue of view-through sales.
ViewThroughConversionsNUMERICNumber of view-through conversions.
HaloUnitSalesNUMERICNumber of halo unit sales.
HaloSalesValueNUMERICValue of halo sales.
HaloConversionsNUMERICNumber of halo conversions.
TotalClickSalesNUMERICTotal sales from clicks.
TotalClickSalesValueNUMERICTotal value of sales from clicks.
TotalUnitSalesNUMERICTotal number of unit sales.
TotalSalesValueNUMERICTotal sales value.
TotalConversionsNUMERICTotal number of conversions.
EnableSalesMetricsBOOLEANFlag to enable sales metrics.
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
CatalogNameSTRINGName of the catalog.
ImpHaloUnitSalesNUMERICNumber of implied halo unit sales.
ImpHaloSalesValueNUMERICValue of implied halo sales.
ImpHaloConversionsNUMERICNumber of implied halo conversions.
AttributableImpressionsNUMERICSubset of impressions that are considered attributable.
AttributableClicksNUMERICSubset of clicks that are considered attributable.
AttributableAdSpendNUMERICSubset of ad spend that is considered attributable.
IsFTABOOLEANFlag indicating if the Campaign is Fixed Tenancy Agreement (FTA).

reporting.viz_global_ledger_out

  • supplier
  • retailer
  • namespace

Ledger (aggregated) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is ledger_agg.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, WalletId, TeamId, TransactionDate, CampaignId, LedgerType, ProductLedger, Reason, RetailerId
Other Unique Key(s):
Partition: Refer to ledger_agg

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
TeamIdSTRINGInternal identifier of the team associated with this wallet
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
WalletIdSTRINGIdentifier of the wallet.
CampaignIdSTRINGInternal identifier of the Campaign (from the source system).
TeamNameSTRINGName of the team managing the campaign.
SupplierNameSTRINGName of the Supplier.
SupplierCompanyNameSTRINGRegistered company name of the Supplier.
RetailerNameSTRINGName of the Retailer.
RetailerCompanyNameSTRINGCompany name of the retailer.
WalletNameSTRINGName of the wallet used.
CurrencyCodeSTRINGCurrency code for the monetary values.
ExternalIdSTRINGExternal system identifier for the wallet
CampaignNameSTRINGName of the campaign.
CampaignTypeSTRINGType of the campaign.
NamespaceSTRINGName of the business namespace.
LedgerTypeSTRINGType of ledger used.
ReasonSTRINGReason for the transaction.
ArchivedBOOLIndicates if the wallet has been archived
TransactionDateDATEDate of the transaction.
CampaignStartDateTIMESTAMPStart date and time of the campaign.
CampaignEndDateTIMESTAMPEnd date and time of the campaign.
ValidStateSTRINGCurrent validation state of the campaign
ActiveStateSTRINGCurrent activity state of the campaign
IsFTASTRINGIndicates if the campaign is FTA (Free Trade Agreement) eligible.
AmountNUMERICMonetary amount involved in the transaction.
FTACostNUMERICCost associated with FTA.
MaxCostPerClickNUMERICMaximum allowed cost per click (alternate field)
MaxTotalSpendNUMERICMaximum total budget (alternate field)
MaxDailySpendNUMERICMaximum daily spend limit (alternate field)
TotalSpendNUMERICTotal spend by the Team.
ActiveCampaignCountNUMERICNumber of currently active advertising campaigns
ActiveCampaignMaxTotalSpendNUMERICSum of maximum spend limits across all active campaigns
CurrencyValueFLOAT64Value of the currency used.
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
SupplierGroup1STRINGSupplier group membership #1.
SupplierGroup2STRINGSupplier group membership #2.
SupplierGroup3STRINGSupplier group membership #3.
SupplierGroup4STRINGSupplier group membership #4.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
ProductLedgerSTRINGLedger for product transactions.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.
TransactionCountSTRINGTotal number of transactions.

reporting.viz_global_product_out

  • retailer
  • namespace

Product data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is product.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, CatalogId, ProductCode
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
NormalisedProductCodeSTRINGStandardized product code used for consistent identification.
ProductCodeSTRINGOriginal product code from the source system.
CatalogIdSTRINGInternal identifier of the Catalog (from the source system).
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
ProductNameSTRINGName of the product.
ProductTypeSTRINGType or category of the product.
RetailerNameSTRINGName of the retailer offering the product.
CurrencyCodeSTRINGCurrency code for the product price (ISO 4217).
ProductTagsSTRINGTags or labels associated with the product.
ProductImageUrlSTRINGURL of the product image.
BrandSTRINGBrand of the product.
GoogleProductTaxonomySTRINGGoogle product taxonomy classification.
RetailerTaxonomySTRINGRetailer's own product taxonomy classification.
NamespaceSTRINGNamespace or environment for the product (e.g., production, staging).
IsDeletedBOOLWhether the product is deleted or inactive.
CatalogNameSTRINGName of the catalog containing the product.
TypeSTRINGType or classification of the product (alternate field).
RetailerGroup1STRINGRetailer group classification 1 for the product.
RetailerGroup2STRINGRetailer group classification 2 for the product.
SellerIdSTRINGIdentifier of the seller for the product.
UpcSTRINGUniversal Product Code (UPC) for the product.
InventorySTRINGInventory status or quantity for the product.
GeoRegionSTRINGGeographical region for the product.
LocalTimezoneSTRINGLocal timezone for the product.
RegionSTRINGRegion for the product.
RegionNamespaceSTRINGNamespace for the region of the product.
RetailerSTRINGName of the retailer associated with the product.
SupplierSTRINGName of the supplier associated with the product.

reporting.viz_global_retailer_out

  • retailer
  • namespace

Product data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is retailer.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, RetailerId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
RetailerNameSTRINGName of the Retailer.
TeamTypeSTRINGType of Team (SUPPLIER or RETAILER).
RetailerCompanyNameSTRINGCompany name of the retailer.
RetailerBusinessIdentifierSTRINGBusiness identifier for the retailer.
RetailerIndustrySTRINGIndustry category of the retailer.
CurrencyCodeSTRINGCurrency code for the monetary values.
NamespaceSTRINGName of the business namespace.
AdsRequestedCapNUMERICMaximum number of ads that can be requested.
BannerAdsRequestedCapNUMERICMaximum number of banner ads that can be requested.
ReservedSearchTermsSTRINGList of reserved search terms.
GlobalSuppressFlagSTRINGGlobal suppress flag.
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.
IsActiveBOOLIndicates if the catalog is currently active.
IsDeletedBOOLIndicates if the catalog has been deleted.
IsCurrentBOOLIndicates if this is the current version of the catalog record.
CreatedAtTIMESTAMPTimestamp when the Team was created.
UpdatedAtTIMESTAMPTimestamp when the Team was last updated.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
CompanyNameSTRINGRegistered company name of the Team.
BusinessIdentifierSTRINGBusiness identifier for the Team.
IndustrySTRINGIndustry sector of the Team.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.

reporting.viz_global_sov_category_mth_out

  • namespace

Share of voice by Category data (month buckets). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is insights_sov_category.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace,RetailerId,SupplierId,Category,IngressedAt
Other Unique Key(s):
Partition: Refer to insights_sov_category

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
IngressedAtDATEThe timestamp when Ad was requested and created.
RegionSTRINGGeographical region of the ad event.
RegionNamespaceSTRINGNamespace prefixed with the region.
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
RetailerNameSTRINGName of the Retailer.
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
SupplierNameSTRINGName of the Supplier.
CategorySTRINGCategory being targeted.
ImpressionsNUMERICNumber of ad impressions.
ClicksNUMERICNumber of ad clicks.
ConversionsNUMERICTotal standard conversions (purchases of the exact product in the ad).
UnitSalesNUMERICTotal number of products purchased from conversions.
AdSpendNUMERICTotal ad spend.
AdRevenueNUMERICPortion of ad spend retained by the retailer.
SalesRevenueNUMERICTotal sales revenue generated by conversions.
ImpressionsByRetailerNUMERICNumber of ad impressions by retailer.
ClicksByRetailerNUMERICNumber of ad clicks by retailer.
ConversionsByRetailerNUMERICNumber of conversions by retailer.
UnitSalesByRetailerNUMERICNumber of unit sales by retailer.
AdSpendByRetailerNUMERICAd spend attributed to each retailer.
AdRevenueByRetailerNUMERICAd revenue attributed to each retailer.
SalesRevenueByRetailerNUMERICSales revenue attributed to each retailer.
ImpressionsByNamespaceNUMERICNumber of ad impressions by namespace.
ClicksByNamespaceNUMERICNumber of ad clicks by namespace.
ConversionsByNamespaceNUMERICNumber of conversions by namespace.
UnitSalesByNamespaceNUMERICNumber of unit sales by namespace.
AdSpendByNamespaceNUMERICAd spend attributed to each namespace.
AdRevenueByNamespaceNUMERICAd revenue attributed to each namespace.
SalesRevenueByNamespaceNUMERICSales revenue attributed to each namespace.

reporting.viz_global_sov_category_week_out

  • namespace

Share of voice by Category data (weekly buckets). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is insights_sov_category.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace,RetailerId,SupplierId,Category,IngressedAt
Other Unique Key(s):
Partition: Refer to insights_sov_category

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
IngressedAtDATEThe timestamp when Ad was requested and created.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
RetailerNameSTRINGName of the Retailer.
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
SupplierNameSTRINGName of the Supplier.
CategorySTRINGCategory being targeted.
ImpressionsNUMERICNumber of times ads were shown.
ClicksNUMERICNumber of times ads were clicked.
ConversionsNUMERICNumber of ad conversions.
UnitSalesNUMERICNumber of units sold.
AdSpendNUMERICTotal amount spent on ads.
AdRevenueNUMERICTotal revenue generated from ads.
SalesRevenueNUMERICTotal revenue generated from sales.
ImpressionsByRetailerNUMERICNumber of ad impressions by retailer.
ClicksByRetailerNUMERICNumber of ad clicks by retailer.
ConversionsByRetailerNUMERICNumber of conversions by retailer.
UnitSalesByRetailerNUMERICNumber of unit sales by retailer.
AdSpendByRetailerNUMERICAd spend attributed to each retailer.
AdRevenueByRetailerNUMERICAd revenue attributed to each retailer.
SalesRevenueByRetailerNUMERICSales revenue attributed to each retailer.
ImpressionsByNamespaceNUMERICNumber of ad impressions by namespace.
ClicksByNamespaceNUMERICNumber of ad clicks by namespace.
ConversionsByNamespaceNUMERICNumber of conversions by namespace.
UnitSalesByNamespaceNUMERICNumber of unit sales by namespace.
AdSpendByNamespaceNUMERICAd spend attributed to each namespace.
AdRevenueByNamespaceNUMERICAd revenue attributed to each namespace.
SalesRevenueByNamespaceNUMERICSales revenue attributed to each namespace.

reporting.viz_global_sov_search_term_mth_out

  • namespace

Share of voice by Search Term data (month buckets). Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is insights_sov_search_term.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace,RetailerId,SupplierId,SearchTerm,IngressedAt
Other Unique Key(s):
Partition: Refer to insights_sov_search_term

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
IngressedAtDATEThe timestamp when Ad was requested and created.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
RetailerNameSTRINGName of the Retailer.
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
SupplierNameSTRINGName of the Supplier.
SearchTermSTRINGSearch term that triggered the ad request.
ImpressionsNUMERICNumber of times ads were shown.
ClicksNUMERICNumber of times ads were clicked.
ConversionsNUMERICNumber of ad conversions.
UnitSalesNUMERICNumber of units sold.
AdSpendNUMERICTotal amount spent on ads.
AdRevenueNUMERICTotal revenue generated from ads.
SalesRevenueNUMERICTotal revenue generated from sales.
ImpressionsByRetailerNUMERICNumber of ad impressions by retailer.
ClicksByRetailerNUMERICNumber of ad clicks by retailer.
ConversionsByRetailerNUMERICNumber of conversions by retailer.
UnitSalesByRetailerNUMERICNumber of unit sales by retailer.
AdSpendByRetailerNUMERICAd spend attributed to each retailer.
AdRevenueByRetailerNUMERICAd revenue attributed to each retailer.
SalesRevenueByRetailerNUMERICSales revenue attributed to each retailer.
ImpressionsByNamespaceNUMERICNumber of ad impressions by namespace.
ClicksByNamespaceNUMERICNumber of ad clicks by namespace.
ConversionsByNamespaceNUMERICNumber of conversions by namespace.
UnitSalesByNamespaceNUMERICNumber of unit sales by namespace.
AdSpendByNamespaceNUMERICAd spend attributed to each namespace.
AdRevenueByNamespaceNUMERICAd revenue attributed to each namespace.
SalesRevenueByNamespaceNUMERICSales revenue attributed to each namespace.

reporting.viz_global_supplier_out

  • supplier
  • namespace

Supplier data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is supplier.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, SupplierId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
SupplierNameSTRINGName of the Supplier.
TeamTypeSTRINGType of Team (SUPPLIER).
SupplierCompanyNameSTRINGRegistered company name of the Supplier.
SupplierBusinessIdentifierSTRINGBusiness identifier of the Supplier.
SupplierIndustrySTRINGIndustry classification of the Supplier.
NamespaceSTRINGName of the Namespace.
SupplierGroup1STRINGPrimary grouping category for the Supplier.
SupplierGroup2STRINGSecondary grouping category for the Supplier.
SupplierGroup3STRINGTertiary grouping category for the Supplier.
SupplierGroup4STRINGQuaternary grouping category for the Supplier.
CreatedAtTIMESTAMPTimestamp when the Supplier record was created.
UpdatedAtTIMESTAMPTimestamp when the Supplier record was last updated.
LastCampaignCreatedIdSTRINGIdentifier of the most recently created campaign for this Supplier.
LastCampaignCreatedDateTIMESTAMPTimestamp when the most recent campaign was created.
LastCampaignUpdatedIdSTRINGIdentifier of the most recently updated campaign for this Supplier.
LastCampaignUpdatedDateTIMESTAMPTimestamp when the most recent campaign was updated.
TotalCampaignsINT64Total number of campaigns associated with this Supplier.
TotalActiveCampaignsINT64Total number of active campaigns for this Supplier.
TotalSpendNUMERICTotal amount spent by this Supplier on campaigns.
LastSpendDateDATEDate of the most recent spend by this Supplier.
GeoRegionSTRINGGeographic region where the Supplier operates.
LocalTimezoneSTRINGLocal timezone of the Supplier's primary location.
IsActiveBOOLIndicates if the Supplier account is currently active.
IsDeletedBOOLIndicates if the Supplier account has been deleted.
IsCurrentBOOLIndicates if this is the current version of the Supplier record.
RegionSTRINGGeographic region identifier.
RegionNamespaceSTRINGNamespace specific to the geographic region.
CompanyNameSTRINGRegistered name of the Supplier company.
BusinessIdentifierSTRINGBusiness registration identifier for the Supplier.
IndustrySTRINGIndustry sector of the Supplier.
RetailerSTRINGAssociated retailer name if applicable.
SupplierSTRINGAlternative supplier name or identifier.

reporting.viz_global_team_out

  • supplier
  • retailer
  • namespace

Team data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is team.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, TeamId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
TeamIdSTRINGInternal identifier of the Team (from the source system).
TeamNameSTRINGName of the Team.
TeamTypeSTRINGType of Team (SUPPLIER or RETAILER).
CompanyNameSTRINGRegistered company name of the Team.
BusinessIdentifierSTRINGBusiness identifier for the Team.
IndustrySTRINGIndustry sector of the Team.
UserIdSTRINGIdentifier of a user associated with the Team.
RetailerIdSTRINGIdentifier of the Retailer associated with the Team.
SupplierIdSTRINGIdentifier of the Supplier associated with the Team.
RetailerGroup1STRINGRetailer group classification 1 for the Team.
RetailerGroup2STRINGRetailer group classification 2 for the Team.
SupplierGroup1STRINGSupplier group classification 1 for the Team.
SupplierGroup2STRINGSupplier group classification 2 for the Team.
SupplierGroup3STRINGSupplier group classification 3 for the Team.
SupplierGroup4STRINGSupplier group classification 4 for the Team.
SupplierNameSTRINGName of the Supplier associated with the Team.
NamespaceSTRINGNamespace or environment for the Team (e.g., production, staging).
CreatedAtTIMESTAMPTimestamp when the Team was created.
UpdatedAtTIMESTAMPTimestamp when the Team was last updated.
LastCampaignCreatedIdSTRINGIdentifier of the last campaign created by the Team.
LastCampaignCreatedDateTIMESTAMPTimestamp of the last campaign created by the Team.
LastCampaignUpdatedIdSTRINGIdentifier of the last campaign updated by the Team.
LastCampaignUpdatedDateTIMESTAMPTimestamp of the last campaign updated by the Team.
TotalCampaignsINT64Total number of campaigns created by the Team.
TotalActiveCampaignsINT64Total number of active campaigns for the Team.
TotalSpendNUMERICTotal spend by the Team.
LastSpendDateDATEDate of the last spend by the Team.
GeoRegionSTRINGGeographical region of the Team.
LocalTimezoneSTRINGLocal timezone of the Team.
IsActiveBOOLWhether the Team is currently active.
IsDeletedBOOLWhether the Team is deleted or inactive.
IsCurrentBOOLWhether the Team is the current version (for slowly changing dimensions).
RegionSTRINGRegion of the Team.
RegionNamespaceSTRINGNamespace for the region of the Team.
RetailerSTRINGName of the Retailer associated with the Team.
SupplierSTRINGName of the Supplier associated with the Team.

reporting.viz_global_team_user_out

  • namespace

Team Users data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is user_team.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, TeamId, UserId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
TeamIdSTRINGInternal identifier of the team associated with this wallet
UserIdSTRINGIdentifier of a user associated with the Team.
UserNameSTRINGName of the user.
TeamNameSTRINGName of the team managing the campaign.
TeamTypeSTRINGType of Team (SUPPLIER or RETAILER).
NamespaceSTRINGName of the business namespace.
CompanyNameSTRINGRegistered company name of the Team.
IndustrySTRINGIndustry sector of the Team.
EmailSTRINGEmail address of the user.
AdminBOOLIndicates if the user has admin privileges.
ActivatedBOOLIndicates if the entity is activated.
SystemPermissionsSTRINGList of system permissions.
ActionPermissionSTRINGPermission related to a specific action.
SubjectPermissionSTRINGPermission related to the subject.
RetailerIdSTRINGInternal identifier of the Retailer team (from the source system).
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
SupplierGroup1STRINGSupplier group membership #1.
SupplierGroup2STRINGSupplier group membership #2.
SupplierGroup3STRINGSupplier group membership #3.
SupplierGroup4STRINGSupplier group membership #4.
SupplierNameSTRINGName of the Supplier.
GeoRegionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
LocalTimezoneSTRINGNot in use.
RegionSTRINGGeographical region of the ad request.
RegionNamespaceSTRINGNamespace prefixed with the region.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.

reporting.viz_global_wallet_balance_out

  • supplier
  • retailer
  • namespace

Wallet balance (daily) data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is wallet_balance.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, WalletId, TransactionDate
Other Unique Key(s):
Partition: Refer to wallet_balance

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
TransactionDateDATEDate of the transaction.
RegionSTRINGGeographical region of the ad request.
NamespaceSTRINGName of the business namespace.
RegionNamespaceSTRINGNamespace prefixed with the region.
WalletIdSTRINGIdentifier of the wallet.
WalletNameSTRINGName of the wallet used.
CreditLimitNUMERICMaximum credit amount allowed for this wallet
ArchivedBOOLIndicates if the wallet has been archived
RetailerNameSTRINGName of the Retailer.
RetailerCompanyNameSTRINGCompany name of the retailer.
SupplierNameSTRINGName of the Supplier.
SupplierCompanyNameSTRINGRegistered company name of the Supplier.
RetailerGroup1STRINGFirst level group classification for the retailer.
RetailerGroup2STRINGSecond level group classification for the retailer.
SupplierGroup1STRINGSupplier group membership #1.
SupplierGroup2STRINGSupplier group membership #2.
SupplierGroup3STRINGSupplier group membership #3.
SupplierGroup4STRINGSupplier group membership #4.
SupplierIdSTRINGInternal identifier of the Supplier team (from the source system).
DebitTransactionsINT64List of debit transactions.
CreditTransactionsINT64List of credit transactions.
AmountNUMERICMonetary amount involved in the transaction.
AmountDebitNUMERICAmount debited.
AmountCreditNUMERICAmount credited.
AmountUSDFLOAT64Monetary amount in USD.
AmountDebitUSDFLOAT64Amount debited in USD.
AmountCreditUSDFLOAT64Amount credited in USD.
DailyLimitNUMERICDaily spending limit for the Wallet.
BalanceNUMERICCurrent balance.
BalanceUSDFLOAT64Current balance in USD.
RetailerSTRINGRetailer associated with the ad request.
SupplierSTRINGSupplier associated with the ad request.
WalletExternalIdSTRINGExternal identifier for the wallet.

reporting.viz_global_wallet_out

  • supplier
  • retailer
  • namespace

Wallet data. Use to reconcile to the CitrusAd BI platform (if applicable). Legacy use only, preferred view to use is wallet.

Layer: Visualisation
Category: View
Status: Internal Only

Primary Key: RegionNamespace, WalletId
Other Unique Key(s):
Partition: None

Foreign Key(s):
Not Applicable

Column NameData TypeDescription
WalletIdSTRINGInternal identifier of the Wallet (from the source system).
WalletTeamIdSTRINGInternal identifier of the Team that owns the Wallet.
ExternalIdSTRINGExternal identifier for the Wallet.
DealIdSTRINGIdentifier of the associated Deal.
WalletNameSTRINGName of the Wallet.
TeamNameSTRINGName of the Team that owns the Wallet.
TeamTypeSTRINGType of Team (SUPPLIER or RETAILER).
ArchivedBOOLWhether the Wallet is archived (no longer active).
CurrencyCodeSTRINGCurrency code of the Wallet (ISO 4217).
NamespaceSTRINGNamespace or environment for the Wallet (e.g., production, staging).
CreditLimitNUMERICCredit limit of the Wallet in its native currency.
PrepaidBalanceNUMERICPrepaid balance of the Wallet in its native currency.
TotalPurchasedCreditsNUMERICTotal purchased credits in the Wallet's native currency.
AvailableBalanceNUMERICAvailable balance in the Wallet's native currency.
LatestTopUpAmountNUMERICAmount of the latest top-up in the Wallet's native currency.
EarliestTopUpAmountNUMERICAmount of the earliest top-up in the Wallet's native currency.
LargestTopUpAmountNUMERICLargest top-up amount in the Wallet's native currency.
SmallestTopUpAmountNUMERICSmallest top-up amount in the Wallet's native currency.
AverageTopUpAmountNUMERICAverage top-up amount in the Wallet's native currency.
CreditLimitUsdNUMERICCredit limit of the Wallet in USD.
AvailableBalanceUsdNUMERICAvailable balance in the Wallet in USD.
PrepaidBalanceUsdNUMERICPrepaid balance of the Wallet in USD.
TotalPurchasedCreditsUsdNUMERICTotal purchased credits in the Wallet in USD.
LatestTopUpAmountUsdNUMERICAmount of the latest top-up in the Wallet in USD.
EarliestTopUpAmountUsdNUMERICAmount of the earliest top-up in the Wallet in USD.
LargestTopUpAmountUsdNUMERICLargest top-up amount in the Wallet in USD.
SmallestTopUpAmountUsdNUMERICSmallest top-up amount in the Wallet in USD.
AverageTopUpAmountUsdNUMERICAverage top-up amount in the Wallet in USD.
EarliestCreditDateTIMESTAMPTimestamp of the earliest credit to the Wallet.
LatestCreditDateTIMESTAMPTimestamp of the latest credit to the Wallet.
WalletCaptureDateTIMESTAMPTimestamp when the Wallet data was captured.
ActiveCampaignCountNUMERICNumber of active campaigns associated with the Wallet.
ActiveCampaignMaxTotalSpendNUMERICMaximum total spend among active campaigns for the Wallet.
DailyLimitNUMERICDaily spending limit for the Wallet.
CappedAvailableBalanceNUMERICAvailable balance after applying any caps or limits.
AvailableBalanceAudNUMERICAvailable balance in the Wallet in AUD.
AverageTopUpAmountAudNUMERICAverage top-up amount in the Wallet in AUD.
CreditLimitAudNUMERICCredit limit of the Wallet in AUD.
EarliestTopUpAmountAudNUMERICAmount of the earliest top-up in the Wallet in AUD.
LargestTopUpAmountAudNUMERICLargest top-up amount in the Wallet in AUD.
LatestTopUpAmountAudNUMERICAmount of the latest top-up in the Wallet in AUD.
PrepaidBalanceAudNUMERICPrepaid balance of the Wallet in AUD.
SmallestTopUpAmountAudNUMERICSmallest top-up amount in the Wallet in AUD.
TotalPurchasedCreditsAudNUMERICTotal purchased credits in the Wallet in AUD.
RetailerIdSTRINGInternal identifier of the Retailer associated with the Wallet.
SupplierIdSTRINGInternal identifier of the Supplier associated with the Wallet.
RetailerGroup1STRINGRetailer group classification 1 for the Wallet.
RetailerGroup2STRINGRetailer group classification 2 for the Wallet.
SupplierGroup1STRINGSupplier group classification 1 for the Wallet.
SupplierGroup2STRINGSupplier group classification 2 for the Wallet.
SupplierGroup3STRINGSupplier group classification 3 for the Wallet.
SupplierGroup4STRINGSupplier group classification 4 for the Wallet.
GeoRegionSTRINGGeographical region of the Wallet.
LocalTimezoneSTRINGLocal timezone of the Wallet.
RegionSTRINGRegion of the Wallet.
RegionNamespaceSTRINGNamespace for the region of the Wallet.
RetailerSTRINGName of the Retailer associated with the Wallet.
SupplierSTRINGName of the Supplier associated with the Wallet.
IdSTRINGUnique identifier for the Wallet record.
TeamIdSTRINGIdentifier of the Team associated with the Wallet.
NameSTRINGName of the Wallet (duplicate of WalletName for compatibility).

reporting.wallet

  • supplier
  • retailer
  • namespace

Wallet data.

Layer: Reporting Datamart
Category: Dimension
Status: Published

Primary Key: env_namespace, wallet_id
Other Unique Key(s):
Partition: None

Foreign Key(s):
env_namespace on env_namespace.env_namespace = wallet.env_namespace;
retailer on retailer.env_namespace = wallet.env_namespace and retailer.retailer_id = wallet.retailer_id;
supplier on supplier.env_namespace = wallet.env_namespace and supplier.supplier_id = wallet.supplier_id;

Column NameData TypeDescription
envSTRINGEnvironment the Namespace is deployed in.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
wallet_team_idSTRINGInternal identifier of the Team (from the source system).
external_idSTRINGImplementation specific generic label.
deal_idSTRINGDeal id.
wallet_nameSTRINGName of the Wallet.
team_nameSTRINGName of the Team.
team_typeSTRINGType of Team (SUPPLIER).
archivedBOOLEANArchived status of the Wallet.
currency_codeSTRINGISO 4217 currency code
namespaceSTRINGName of the Namespace.
credit_limitNUMERICAmount the Wallet may go into credit.
prepaid_balanceNUMERICPrepaid balance of the Wallet.
total_purchased_creditsNUMERICTotal credits made to the Wallet.
available_balanceNUMERICCurrent available balance of the Wallet.
latest_top_up_amountNUMERICAmount of the most recent credit applied to the Wallet.
earliest_top_up_amountNUMERICEarliest credit amount made against the Wallet.
largest_top_up_amountNUMERICLargest credit amount made against the Wallet.
smallest_top_up_amountNUMERICSmallest credit amount made against the Wallet.
average_top_up_amountNUMERICAverage of credits applied to the Wallet.
credit_limit_usdNUMERICcredit_limit in USD (current exchange rate only).
available_balance_usdNUMERICavailable_balance in USD (current exchange rate only).
prepaid_balance_usdNUMERICprepaid_balance in USD (current exchange rate only).
total_purchased_credits_usdNUMERICtotal_purchased_credits in USD (current exchange rate only).
latest_top_up_amount_usdNUMERIClatest_top_up_amount in USD (current exchange rate only).
earliest_top_up_amount_usdNUMERICearliest_top_up_amount in USD (current exchange rate only).
largest_top_up_amount_usdNUMERIClargest_top_up_amount in USD (current exchange rate only).
smallest_top_up_amount_usdNUMERICsmallest_top_up_amount in USD (current exchange rate only).
average_top_up_amount_usdNUMERICaverage_top_up_amount in USD (current exchange rate only).
earliest_credit_dateTIMESTAMPMost recent date a credit was made to the Wallet.
latest_credit_dateTIMESTAMPDate of the most recent credit.
wallet_capture_dateTIMESTAMPDate the Wallet details were captured on.
active_campaign_countNUMERICNumber of currently active Campaigns associated to the Wallet.
active_campaign_max_total_spendNUMERICAggregate CampaignMaxTotalSpend for all currently active Campaigns associated to the Wallet.
daily_limitNUMERICAmount the Wallet may go into credit in a day.
capped_available_balanceNUMERICCurrent capped available balance of the Wallet.
available_balance_audNUMERICavailable_balance in AUD (current exchange rate only).
average_top_up_amount_audNUMERICaverage_top_up_amount in AUD (current exchange rate only).
credit_limit_audNUMERICcredit_limit in AUD (current exchange rate only).
earliest_top_up_amount_audNUMERICearliest_top_up_amount_aud in AUD (current exchange rate only).
largest_top_up_amount_audNUMERIClargest_top_up_amount in AUD (current exchange rate only).
latest_top_up_amount_audNUMERIClatest_top_up_amount in AUD (current exchange rate only).
prepaid_balance_audNUMERICprepaid_balance in AUD (current exchange rate only).
smallest_top_up_amount_audNUMERICsmallest_top_up_amount in AUD (current exchange rate only).
total_purchased_credits_audNUMERICtotal_purchased_credits in AUD (current exchange rate only).
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.

reporting.wallet_balance

  • supplier
  • retailer
  • namespace

Wallet balance data.

Layer: Reporting Datamart
Category: Fact
Status: Published

Primary Key: env_namespace, wallet_id, date
Other Unique Key(s):
Partition: date (by DAY)

Foreign Key(s):
env_namespace on env_namespace.env_namespace = wallet_balance.env_namespace;
retailer on retailer.env_namespace = wallet_balance.env_namespace and retailer.retailer_id = wallet_balance.retailer_id;
supplier on supplier.env_namespace = wallet_balance.env_namespace and supplier.supplier_id = wallet_balance.supplier_id;
team on team.env_namespace = wallet_balance.env_namespace and team.team_id = wallet_balance.wallet_team_id;
wallet on wallet.env_namespace = wallet_balance.env_namespace and wallet.wallet_id = wallet_balance.wallet_id;

Column NameData TypeDescription
wallet_idSTRINGInternal identifier of the Wallet (from the source system).
wallet_team_idSTRINGInternal identifier of the Team (from the source system).
external_idSTRINGImplementation specific generic label.
currency_codeSTRINGISO 4217 currency code
envSTRINGEnvironment the Namespace is deployed in.
namespaceSTRINGName of the Namespace.
env_namespaceSTRINGNamespace prefixed with the Environment it is deployed in.
wallet_nameSTRINGName of the Wallet.
archivedBOOLEANArchived status of the Wallet.
dateDATEEffective date of the record.
credit_limitNUMERICAmount the Wallet may go into credit.
balanceNUMERICClosing balance of the Wallet on that day.
retailer_idSTRINGInternal identifier of the Retailer team (from the source system).
supplier_idSTRINGInternal identifier of the Supplier team (from the source system).
retailer_group_1STRINGRetailer team group membership #1.
retailer_group_2STRINGRetailer team group membership #2.
supplier_group_1STRINGSupplier team group membership #1.
supplier_group_2STRINGSupplier team group membership #2.
supplier_group_3STRINGSupplier team group membership #3.
supplier_group_4STRINGSupplier team group membership #4.
geo_regionSTRINGGeographical region of the Namespace (as defined by CitrusAd).
local_timezoneSTRINGNot in use.
daily_limitNUMERICAmount the Wallet may go into credit in a day.

Version: 320451e