diff --git a/Dockerfile b/Dockerfile index 8555d2c9..5e6bb171 100644 --- a/Dockerfile +++ b/Dockerfile @@ -10,6 +10,4 @@ RUN python -m pip install --requirement requirements.local.txt && \ rm requirements.local.txt && \ rm requirements.txt -# Ignored files should be the auto generated json files in _static/api directory, -# but it doesn't look like sphinx-autobuild allows such fine grained control over what is ignored. -CMD ["sphinx-autobuild", "--host", "0.0.0.0", "--port", "8080", "--ignore", "*.json", "/app", "/home/python/docs/_build/html"] +CMD ["sphinx-autobuild", "--host", "0.0.0.0", "--port", "8080", "--ignore", "/app/_static/api/*", "--ignore", "/app/.idea/*", "/app", "/home/python/docs/_build/html"] diff --git a/custom_reports/columns.rst b/custom_reports/columns.rst index 0b07f95b..b87cb27a 100644 --- a/custom_reports/columns.rst +++ b/custom_reports/columns.rst @@ -18,7 +18,7 @@ Metrics The table below lists core metrics that may be used in queries. Additional metrics may be created using dimension transformations. -.. include:: columns_metrics.rst +.. include:: columns__metrics.rst Dimensions ---------- @@ -27,7 +27,7 @@ The table below lists core dimensions that may be used in queries. Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable). -.. include:: columns_dimensions.rst +.. include:: columns__dimensions.rst .. note:: Please note that the number of available custom slots (dimensions, @@ -39,4 +39,4 @@ Transformations The tables below list all transformations that may be used to transform dimensions to metrics or different dimensions. -.. include:: columns_transformations.rst +.. include:: columns__transformations.rst diff --git a/custom_reports/columns_dimensions.rst b/custom_reports/columns__dimensions.rst similarity index 100% rename from custom_reports/columns_dimensions.rst rename to custom_reports/columns__dimensions.rst diff --git a/custom_reports/columns_metrics.rst b/custom_reports/columns__metrics.rst similarity index 100% rename from custom_reports/columns_metrics.rst rename to custom_reports/columns__metrics.rst diff --git a/custom_reports/columns_transformations.rst b/custom_reports/columns__transformations.rst similarity index 100% rename from custom_reports/columns_transformations.rst rename to custom_reports/columns__transformations.rst diff --git a/custom_reports/integrations/google_ads.rst b/custom_reports/integrations/google_ads.rst index 8f8d2e63..af5acb52 100644 --- a/custom_reports/integrations/google_ads.rst +++ b/custom_reports/integrations/google_ads.rst @@ -14,23 +14,7 @@ Metrics The table below lists metrics provided by Google Ads integration. -.. table:: Google Ads Metrics - - +------------------------+----------------------+--------+-----+ - | Metric Name | Column ID | Scope |Type | - +========================+======================+========+=====+ - |Impressions (Google Ads)|google_ads_impressions|external|int | - +------------------------+----------------------+--------+-----+ - |Clicks (Google Ads) |google_ads_clicks |external|int | - +------------------------+----------------------+--------+-----+ - |Cost (Google Ads) |google_ads_cost |external|float| - +------------------------+----------------------+--------+-----+ - |Average CPC (Google Ads)|google_ads_average_cpc|external|float| - +------------------------+----------------------+--------+-----+ - |CTR (Google Ads) |google_ads_ctr |external|float| - +------------------------+----------------------+--------+-----+ - |ROAS (Google Ads) |google_ads_roas |session |float| - +------------------------+----------------------+--------+-----+ +.. include:: google_ads__metrics.rst Dimensions ---------- @@ -39,46 +23,7 @@ The table below lists dimensions provided by Google Ads integration. Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable). -.. table:: Google Ads Dimensions - - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | - +========================================+=============================+========+==========+==============+========+=====================================================================================================================================+ - |Source |source |session |str |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Medium |medium |session |str |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Source/Medium |source_medium |session |str |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Keyword |keyword |session |str |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Device type |device_type |session |[int, str]|uint8 |True |:download:`device_type.json ` | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Session entry URL |session_entry_url |session |str |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Timestamp |timestamp |session |date |not applicable|False |by default in Raw data API | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Website Name |website_name |session |[str, str]|not applicable|False |website UUID | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Customer ID (Google Ads) |google_ads_customer_id |session |str_id |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Customer Name (Google Ads) |google_ads_customer_name |session |[str, str]|not applicable|False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Campaign ID (Google Ads) |google_ads_campaign_id |session |int_id |int64 |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Campaign Name (Google Ads) |google_ads_campaign_name |session |[int, str]|not applicable|False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Ad Group ID (Google Ads) |google_ads_ad_group_id |session |int_id |int64 |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Ad Group Name (Google Ads) |google_ads_ad_group_name |session |[int, str]|not applicable|False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Ad Group Ad ID (Google Ads) |google_ads_ad_group_ad_id |session |str_id |string |False | | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Ad Group Ad Network Type (Google Ads) |google_ads_ad_network_type |session |[str, str]|string |False |:download:`google_ads_ad_network_type.json ` | - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - |Ad Group Keyword Match Type (Google Ads)|google_ads_keyword_match_type|external|[str, str]|string |False |:download:`google_ads_keyword_match_type.json `, not available in Raw data API| - +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - +.. include:: google_ads__dimensions.rst Mixed Queries ------------- @@ -90,43 +35,7 @@ such queries. Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable). -.. table:: Common Dimensions - - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | - +=====================================+==========================+=======+==========+==============+========+================================================================================================+ - |Source |source |session|str |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Medium |medium |session|str |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Source/Medium |source_medium |session|str |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Keyword |keyword |session|str |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Device type |device_type |session|[int, str]|uint8 |True |:download:`device_type.json ` | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Session entry URL |session_entry_url |session|str |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Timestamp |timestamp |session|date |not applicable|False |by default in Raw data API | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Website Name |website_name |session|[str, str]|not applicable|False |website UUID | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Customer ID (Google Ads) |google_ads_customer_id |session|str_id |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Customer Name (Google Ads) |google_ads_customer_name |session|[str, str]|not applicable|False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Campaign ID (Google Ads) |google_ads_campaign_id |session|int_id |int64 |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Campaign Name (Google Ads) |google_ads_campaign_name |session|[int, str]|not applicable|False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Ad Group ID (Google Ads) |google_ads_ad_group_id |session|int_id |int64 |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Ad Group Name (Google Ads) |google_ads_ad_group_name |session|[int, str]|not applicable|False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Ad Group Ad ID (Google Ads) |google_ads_ad_group_ad_id |session|str_id |string |False | | - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ - |Ad Group Ad Network Type (Google Ads)|google_ads_ad_network_type|session|[str, str]|string |False |:download:`google_ads_ad_network_type.json `| - +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ +.. include:: google_ads__common_dimensions.rst .. warning:: Using dimensions that are not explicitly listed in the table above in such diff --git a/custom_reports/integrations/google_ads__common_dimensions.rst b/custom_reports/integrations/google_ads__common_dimensions.rst new file mode 100644 index 00000000..527c525a --- /dev/null +++ b/custom_reports/integrations/google_ads__common_dimensions.rst @@ -0,0 +1,37 @@ +.. table:: Common Dimensions + + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | + +=====================================+==========================+=======+==========+==============+========+================================================================================================+ + |Source |source |session|str |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Medium |medium |session|str |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Source/Medium |source_medium |session|str |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Keyword |keyword |session|str |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Device type |device_type |session|[int, str]|uint8 |True |:download:`device_type.json ` | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Session entry URL |session_entry_url |session|str |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Timestamp |timestamp |session|date |not applicable|False |by default in Raw data API | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Website Name |website_name |session|[str, str]|not applicable|False |website UUID | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Customer ID (Google Ads) |google_ads_customer_id |session|str_id |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Customer Name (Google Ads) |google_ads_customer_name |session|[str, str]|not applicable|False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Campaign ID (Google Ads) |google_ads_campaign_id |session|int_id |int64 |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Campaign Name (Google Ads) |google_ads_campaign_name |session|[int, str]|not applicable|False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Ad Group ID (Google Ads) |google_ads_ad_group_id |session|int_id |int64 |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Ad Group Name (Google Ads) |google_ads_ad_group_name |session|[int, str]|not applicable|False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Ad Group Ad ID (Google Ads) |google_ads_ad_group_ad_id |session|str_id |string |False | | + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ + |Ad Group Ad Network Type (Google Ads)|google_ads_ad_network_type|session|[str, str]|string |False |:download:`google_ads_ad_network_type.json `| + +-------------------------------------+--------------------------+-------+----------+--------------+--------+------------------------------------------------------------------------------------------------+ diff --git a/custom_reports/integrations/google_ads__dimensions.rst b/custom_reports/integrations/google_ads__dimensions.rst new file mode 100644 index 00000000..7e7e85a3 --- /dev/null +++ b/custom_reports/integrations/google_ads__dimensions.rst @@ -0,0 +1,39 @@ +.. table:: Google Ads Dimensions + + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | + +========================================+=============================+========+==========+==============+========+=====================================================================================================================================+ + |Source |source |session |str |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Medium |medium |session |str |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Source/Medium |source_medium |session |str |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Keyword |keyword |session |str |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Device type |device_type |session |[int, str]|uint8 |True |:download:`device_type.json ` | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Session entry URL |session_entry_url |session |str |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Timestamp |timestamp |session |date |not applicable|False |by default in Raw data API | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Website Name |website_name |session |[str, str]|not applicable|False |website UUID | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Customer ID (Google Ads) |google_ads_customer_id |session |str_id |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Customer Name (Google Ads) |google_ads_customer_name |session |[str, str]|not applicable|False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Campaign ID (Google Ads) |google_ads_campaign_id |session |int_id |int64 |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Campaign Name (Google Ads) |google_ads_campaign_name |session |[int, str]|not applicable|False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Ad Group ID (Google Ads) |google_ads_ad_group_id |session |int_id |int64 |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Ad Group Name (Google Ads) |google_ads_ad_group_name |session |[int, str]|not applicable|False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Ad Group Ad ID (Google Ads) |google_ads_ad_group_ad_id |session |str_id |string |False | | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Ad Group Ad Network Type (Google Ads) |google_ads_ad_network_type |session |[str, str]|string |False |:download:`google_ads_ad_network_type.json ` | + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ + |Ad Group Keyword Match Type (Google Ads)|google_ads_keyword_match_type|external|[str, str]|string |False |:download:`google_ads_keyword_match_type.json `, not available in Raw data API| + +----------------------------------------+-----------------------------+--------+----------+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/custom_reports/integrations/google_ads__metrics.rst b/custom_reports/integrations/google_ads__metrics.rst new file mode 100644 index 00000000..755213be --- /dev/null +++ b/custom_reports/integrations/google_ads__metrics.rst @@ -0,0 +1,17 @@ +.. table:: Google Ads Metrics + + +------------------------+----------------------+--------+-----+ + | Metric Name | Column ID | Scope |Type | + +========================+======================+========+=====+ + |Impressions (Google Ads)|google_ads_impressions|external|int | + +------------------------+----------------------+--------+-----+ + |Clicks (Google Ads) |google_ads_clicks |external|int | + +------------------------+----------------------+--------+-----+ + |Cost (Google Ads) |google_ads_cost |external|float| + +------------------------+----------------------+--------+-----+ + |Average CPC (Google Ads)|google_ads_average_cpc|external|float| + +------------------------+----------------------+--------+-----+ + |CTR (Google Ads) |google_ads_ctr |external|float| + +------------------------+----------------------+--------+-----+ + |ROAS (Google Ads) |google_ads_roas |session |float| + +------------------------+----------------------+--------+-----+ diff --git a/custom_reports/integrations/google_search_console.rst b/custom_reports/integrations/google_search_console.rst index 3b393a8c..5987376c 100644 --- a/custom_reports/integrations/google_search_console.rst +++ b/custom_reports/integrations/google_search_console.rst @@ -14,19 +14,7 @@ Metrics The table below lists metrics provided by Google Search Console integration. -.. table:: Google Search Console Metrics - - +--------------------------------+------------------------------+--------+-----+ - | Metric Name | Column ID | Scope |Type | - +================================+==============================+========+=====+ - |Clicks (search engine) |search_engine_clicks |external|int | - +--------------------------------+------------------------------+--------+-----+ - |Impressions (search engine) |search_engine_impressions |external|int | - +--------------------------------+------------------------------+--------+-----+ - |CTR (search engine) |search_engine_ctr |external|float| - +--------------------------------+------------------------------+--------+-----+ - |Average position (search engine)|search_engine_average_position|external|float| - +--------------------------------+------------------------------+--------+-----+ +.. include:: google_search_console__metrics.rst Dimensions ---------- @@ -35,35 +23,7 @@ The table below lists dimensions provided by Google Search Console integration. Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable). -.. table:: Google Search Console Dimensions - - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | - +=====================+===========================+========+==========+==============+========+==================================================================================================+ - |Source |source |session |str |string |False | | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Medium |medium |session |str |string |False | | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Source/Medium |source_medium |session |str |string |False | | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Channel |referrer_type |session |[int, str]|uint8 |False |:download:`referrer_type.json ` | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Referrer URL |referrer_url |session |str |string |False | | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Device type |device_type |session |[int, str]|uint8 |True |:download:`device_type.json ` | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Continent |location_continent_iso_code|session |[str, str]|string(2) |True |:download:`location_continent_iso_code.json `| - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Country |location_country_name |session |[str, str]|string |True |ISO 3166-2 codes (e.g. "PL") | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Session entry URL |session_entry_url |session |str |string |False | | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Timestamp |timestamp |session |date |not applicable|False |by default in Raw data API | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Search engine keyword|search_engine_keyword |external|str |string |False |not available in Raw data API | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Website Name |website_name |session |[str, str]|not applicable|False |website UUID | - +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ +.. include:: google_search_console__dimensions.rst Mixed Queries ------------- @@ -75,33 +35,7 @@ such queries. Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable). -.. table:: Common Dimensions - - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | - +=================+===========================+=======+==========+==============+========+==================================================================================================+ - |Source |source |session|str |string |False | | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Medium |medium |session|str |string |False | | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Source/Medium |source_medium |session|str |string |False | | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Channel |referrer_type |session|[int, str]|uint8 |False |:download:`referrer_type.json ` | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Referrer URL |referrer_url |session|str |string |False | | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Device type |device_type |session|[int, str]|uint8 |True |:download:`device_type.json ` | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Continent |location_continent_iso_code|session|[str, str]|string(2) |True |:download:`location_continent_iso_code.json `| - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Country |location_country_name |session|[str, str]|string |True |ISO 3166-2 codes (e.g. "PL") | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Session entry URL|session_entry_url |session|str |string |False | | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Timestamp |timestamp |session|date |not applicable|False |by default in Raw data API | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ - |Website Name |website_name |session|[str, str]|not applicable|False |website UUID | - +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ +.. include:: google_search_console__common_dimensions.rst .. warning:: Using dimensions that are not explicitly listed in the table above in such diff --git a/custom_reports/integrations/google_search_console__common_dimensions.rst b/custom_reports/integrations/google_search_console__common_dimensions.rst new file mode 100644 index 00000000..268e0e40 --- /dev/null +++ b/custom_reports/integrations/google_search_console__common_dimensions.rst @@ -0,0 +1,27 @@ +.. table:: Common Dimensions + + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | + +=================+===========================+=======+==========+==============+========+==================================================================================================+ + |Source |source |session|str |string |False | | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Medium |medium |session|str |string |False | | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Source/Medium |source_medium |session|str |string |False | | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Channel |referrer_type |session|[int, str]|uint8 |False |:download:`referrer_type.json ` | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Referrer URL |referrer_url |session|str |string |False | | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Device type |device_type |session|[int, str]|uint8 |True |:download:`device_type.json ` | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Continent |location_continent_iso_code|session|[str, str]|string(2) |True |:download:`location_continent_iso_code.json `| + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Country |location_country_name |session|[str, str]|string |True |ISO 3166-2 codes (e.g. "PL") | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Session entry URL|session_entry_url |session|str |string |False | | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Timestamp |timestamp |session|date |not applicable|False |by default in Raw data API | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Website Name |website_name |session|[str, str]|not applicable|False |website UUID | + +-----------------+---------------------------+-------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ diff --git a/custom_reports/integrations/google_search_console__dimensions.rst b/custom_reports/integrations/google_search_console__dimensions.rst new file mode 100644 index 00000000..9a0c2f11 --- /dev/null +++ b/custom_reports/integrations/google_search_console__dimensions.rst @@ -0,0 +1,29 @@ +.. table:: Google Search Console Dimensions + + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + | Dimension Name | Column ID | Scope | Type |Database Type |Nullable| Notes | + +=====================+===========================+========+==========+==============+========+==================================================================================================+ + |Source |source |session |str |string |False | | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Medium |medium |session |str |string |False | | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Source/Medium |source_medium |session |str |string |False | | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Channel |referrer_type |session |[int, str]|uint8 |False |:download:`referrer_type.json ` | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Referrer URL |referrer_url |session |str |string |False | | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Device type |device_type |session |[int, str]|uint8 |True |:download:`device_type.json ` | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Continent |location_continent_iso_code|session |[str, str]|string(2) |True |:download:`location_continent_iso_code.json `| + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Country |location_country_name |session |[str, str]|string |True |ISO 3166-2 codes (e.g. "PL") | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Session entry URL |session_entry_url |session |str |string |False | | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Timestamp |timestamp |session |date |not applicable|False |by default in Raw data API | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Search engine keyword|search_engine_keyword |external|str |string |False |not available in Raw data API | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ + |Website Name |website_name |session |[str, str]|not applicable|False |website UUID | + +---------------------+---------------------------+--------+----------+--------------+--------+--------------------------------------------------------------------------------------------------+ diff --git a/custom_reports/integrations/google_search_console__metrics.rst b/custom_reports/integrations/google_search_console__metrics.rst new file mode 100644 index 00000000..37be1344 --- /dev/null +++ b/custom_reports/integrations/google_search_console__metrics.rst @@ -0,0 +1,13 @@ +.. table:: Google Search Console Metrics + + +--------------------------------+------------------------------+--------+-----+ + | Metric Name | Column ID | Scope |Type | + +================================+==============================+========+=====+ + |Clicks (search engine) |search_engine_clicks |external|int | + +--------------------------------+------------------------------+--------+-----+ + |Impressions (search engine) |search_engine_impressions |external|int | + +--------------------------------+------------------------------+--------+-----+ + |CTR (search engine) |search_engine_ctr |external|float| + +--------------------------------+------------------------------+--------+-----+ + |Average position (search engine)|search_engine_average_position|external|float| + +--------------------------------+------------------------------+--------+-----+ diff --git a/custom_reports/integrations/sharepoint.rst b/custom_reports/integrations/sharepoint.rst index cc3bf295..577337e6 100644 --- a/custom_reports/integrations/sharepoint.rst +++ b/custom_reports/integrations/sharepoint.rst @@ -9,35 +9,7 @@ Metrics The table below lists metrics available with SharePoint integration. -.. table:: SharePoint Metrics - - +--------------------------------+--------------------------------+-------+----+ - | Metric Name | Column ID | Scope |Type| - +================================+================================+=======+====+ - |SharePoint shares |sharepoint_shares |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint likes |sharepoint_likes |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint comments |sharepoint_comments |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint promotions |sharepoint_promotions |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint creations |sharepoint_creations |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint edits |sharepoint_edits |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint deletions |sharepoint_deletions |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint opens |sharepoint_opens |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint uploads |sharepoint_uploads |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint item views |sharepoint_item_views |session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint item attachment views|sharepoint_item_attachment_views|session|int | - +--------------------------------+--------------------------------+-------+----+ - |SharePoint item shares |sharepoint_item_shares |session|int | - +--------------------------------+--------------------------------+-------+----+ +.. include:: sharepoint__metrics.rst Dimensions ---------- @@ -46,60 +18,4 @@ The table below lists dimensions available with SharePoint integration. Note: "Database type" column presents the type of source column of the dimension (in case of enum - type of the ID, in case of dynamic dimensions - not applicable). -.. table:: SharePoint Dimensions - - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - | Dimension Name | Column ID | Scope | Type |Database Type|Nullable| Notes | - +===========================================+==============================================+=======+==========+=============+========+========================================================================================+ - |SharePoint display name |sharepoint_display_name |session|str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint office |sharepoint_office |session|str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint department |sharepoint_department |session|str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint job title |sharepoint_job_title |session|str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint shares in session |session_total_sharepoint_shares |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint likes in session |session_total_sharepoint_likes |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint comments in session |session_total_sharepoint_comments |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint promotions in session |session_total_sharepoint_promotions |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint creations in session |session_total_sharepoint_creations |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint edits in session |session_total_sharepoint_edits |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint deletions in session |session_total_sharepoint_deletions |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint opens in session |session_total_sharepoint_opens |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint uploads in session |session_total_sharepoint_uploads |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint item views in session |session_total_sharepoint_item_views |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint item attachment views in session|session_total_sharepoint_item_attachment_views|session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint item shares in session |session_total_sharepoint_item_shares |session|int |uint16 |False | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint action |sharepoint_action |event |[int, str]|uint8 |True |:download:`sharepoint_action.json ` | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint object type |sharepoint_object_type |event |[int, str]|uint8 |True |:download:`sharepoint_object_type.json `| - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint content type |sharepoint_content_type |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint author |sharepoint_author |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint author's display name |sharepoint_author_display_name |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint author's office |sharepoint_author_office |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint author's department |sharepoint_author_department |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint author's job title |sharepoint_author_job_title |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint file url |sharepoint_file_url |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ - |SharePoint file type |sharepoint_file_type |event |str |string |True | | - +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ +.. include:: sharepoint__dimensions.rst diff --git a/custom_reports/integrations/sharepoint__dimensions.rst b/custom_reports/integrations/sharepoint__dimensions.rst new file mode 100644 index 00000000..f4e15e0c --- /dev/null +++ b/custom_reports/integrations/sharepoint__dimensions.rst @@ -0,0 +1,57 @@ +.. table:: SharePoint Dimensions + + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + | Dimension Name | Column ID | Scope | Type |Database Type|Nullable| Notes | + +===========================================+==============================================+=======+==========+=============+========+========================================================================================+ + |SharePoint display name |sharepoint_display_name |session|str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint office |sharepoint_office |session|str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint department |sharepoint_department |session|str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint job title |sharepoint_job_title |session|str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint shares in session |session_total_sharepoint_shares |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint likes in session |session_total_sharepoint_likes |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint comments in session |session_total_sharepoint_comments |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint promotions in session |session_total_sharepoint_promotions |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint creations in session |session_total_sharepoint_creations |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint edits in session |session_total_sharepoint_edits |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint deletions in session |session_total_sharepoint_deletions |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint opens in session |session_total_sharepoint_opens |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint uploads in session |session_total_sharepoint_uploads |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint item views in session |session_total_sharepoint_item_views |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint item attachment views in session|session_total_sharepoint_item_attachment_views|session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint item shares in session |session_total_sharepoint_item_shares |session|int |uint16 |False | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint action |sharepoint_action |event |[int, str]|uint8 |True |:download:`sharepoint_action.json ` | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint object type |sharepoint_object_type |event |[int, str]|uint8 |True |:download:`sharepoint_object_type.json `| + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint content type |sharepoint_content_type |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint author |sharepoint_author |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint author's display name |sharepoint_author_display_name |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint author's office |sharepoint_author_office |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint author's department |sharepoint_author_department |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint author's job title |sharepoint_author_job_title |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint file url |sharepoint_file_url |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ + |SharePoint file type |sharepoint_file_type |event |str |string |True | | + +-------------------------------------------+----------------------------------------------+-------+----------+-------------+--------+----------------------------------------------------------------------------------------+ diff --git a/custom_reports/integrations/sharepoint__metrics.rst b/custom_reports/integrations/sharepoint__metrics.rst new file mode 100644 index 00000000..a8de160a --- /dev/null +++ b/custom_reports/integrations/sharepoint__metrics.rst @@ -0,0 +1,29 @@ +.. table:: SharePoint Metrics + + +--------------------------------+--------------------------------+-------+----+ + | Metric Name | Column ID | Scope |Type| + +================================+================================+=======+====+ + |SharePoint shares |sharepoint_shares |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint likes |sharepoint_likes |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint comments |sharepoint_comments |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint promotions |sharepoint_promotions |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint creations |sharepoint_creations |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint edits |sharepoint_edits |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint deletions |sharepoint_deletions |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint opens |sharepoint_opens |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint uploads |sharepoint_uploads |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint item views |sharepoint_item_views |session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint item attachment views|sharepoint_item_attachment_views|session|int | + +--------------------------------+--------------------------------+-------+----+ + |SharePoint item shares |sharepoint_item_shares |session|int | + +--------------------------------+--------------------------------+-------+----+