🔍 Code Extractor

class ReportAbandonedQueries

Maturity: 43

A report class that identifies popular search queries with low click-through rates in SharePoint, helping to improve content discoverability and user satisfaction.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/reports/abandoned_queries.py
Lines:
4 - 9
Complexity:
simple

Purpose

This class extends ReportBase to provide functionality for analyzing abandoned search queries in SharePoint. It helps identify search terms that users frequently enter but don't result in clicks, indicating potential content gaps or poor search result relevance. This information can be used to optimize content strategy and improve the user experience by addressing queries that lead to user dissatisfaction.

Source Code

class ReportAbandonedQueries(ReportBase):
    """This report shows popular search queries that receive low click-through. Use this report to identify search
    queries that might create user dissatisfaction and to improve the discoverability of content.
    """

    pass

Parameters

Name Type Default Kind
bases ReportBase -

Parameter Details

__init__: This class uses the constructor from its parent class ReportBase. No additional parameters are defined in this class itself. Refer to ReportBase documentation for initialization parameters.

Return Value

Instantiation returns a ReportAbandonedQueries object that inherits all methods and properties from ReportBase. The specific return values depend on the methods inherited from the parent class, which typically include report data structures containing search query analytics.

Class Interface

Dependencies

  • office365

Required Imports

from office365.sharepoint.search.reports.abandoned_queries import ReportAbandonedQueries
from office365.sharepoint.search.reports.base import ReportBase

Usage Example

from office365.sharepoint.search.reports.abandoned_queries import ReportAbandonedQueries
from office365.runtime.auth.user_credential import UserCredential
from office365.sharepoint.client_context import ClientContext

# Setup SharePoint context
site_url = 'https://yourtenant.sharepoint.com/sites/yoursite'
credentials = UserCredential('username@domain.com', 'password')
ctx = ClientContext(site_url).with_credentials(credentials)

# Create report instance (exact usage depends on ReportBase implementation)
report = ReportAbandonedQueries(ctx)

# Execute report (method names depend on ReportBase)
# report.execute()
# results = report.get_results()

Best Practices

  • This class is a pass-through implementation that relies entirely on ReportBase functionality. Consult ReportBase documentation for actual usage patterns.
  • Ensure proper SharePoint authentication is configured before instantiating this class.
  • Use this report to regularly monitor search query performance and identify content gaps.
  • Combine insights from this report with other search analytics to get a complete picture of search effectiveness.
  • The class follows the inheritance pattern common in the office365 library - specific report types extend the base functionality without adding custom methods.
  • Since this is an empty class body (pass statement), all functionality comes from the parent ReportBase class.

Tags

sharepoint search-analytics reporting click-through-rate user-experience content-discovery search-queries analytics

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class ReportTopQueries 67.9% similar

    A specialized report class for retrieving top search queries from SharePoint Search REST API.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/reports/top_queries.py

  • class ReportBase 50.8% similar

    ReportBase is a base class representing a report entity in Microsoft Office Server Search REST API, inheriting from ClientValue to provide client-side value representation.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/reports/base.py

  • class QuerySuggestionResults 50.0% similar

    A container class for SharePoint search query suggestions, including people names, personal results, popular results, and query suggestions.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/query/suggestion_results.py

  • class DocumentCrawlLog 49.8% similar

    A SharePoint search administration class that provides methods to retrieve information about crawled documents and URLs, including both successful and unsuccessful crawl attempts.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/administration/document_crawl_log.py

  • class RefinementResults 49.3% similar

    A data class representing refinement results from a SharePoint search query, containing layout templates, refiners, and result metadata.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/search/refinement_results.py
← Back to Browse