Faceted search — request refiners and drill down with refinement filters.

Reference

• https://learn.microsoft.com/en-us/sharepoint/dev/general-development/sharepoint-search-rest-api-overview

View source

import argparse

from office365.sharepoint.client_context import ClientContext
from tests.settings import cert_path, cert_thumbprint, client_id, site_url, tenant


def main():
    parser = argparse.ArgumentParser(description="Request refiners and drill down with refinement filters")
    parser.add_argument("--query", default="IsDocument:1", help="KQL query text")
    parser.add_argument("--limit", type=int, default=10, help="maximum number of rows")
    args = parser.parse_args()

    ctx = ClientContext(site_url).with_client_certificate(
        tenant, client_id=client_id, thumbprint=cert_thumbprint, cert_path=cert_path
    )

    # Step 1 — query with refiners to get category counts
    result = ctx.search.query(
        query_text=args.query,
        refiners=["Author", "ContentType", "FileExtension"],
        row_limit=args.limit,
    ).execute_query()

    print("=== Refiners ===")
    refiners = result.value.PrimaryQueryResult.RefinementResults.Refiners
    for refiner in refiners:
        print(f"  {refiner.Name}:")
        for entry in refiner.Entries:
            print(f"    {entry.RefinementName} ({entry.RefinementCount}) — token: {entry.RefinementToken}")

    # Step 2 — drill down with a refinement filter
    if refiners and refiners[0].Entries:
        token = refiners[0].Entries[0].RefinementToken
        result = ctx.search.query(
            query_text=args.query,
            refinement_filters=[token],
            row_limit=args.limit,
        ).execute_query()
        print(f"\n=== Filtered by {refiners[0].Entries[0].RefinementName} ===")
        results = result.value.PrimaryQueryResult.RelevantResults
        for row in results.Table.Rows:
            print(row.Cells["Path"])


if __name__ == "__main__":
    main()

---

← Back to Searching SharePoint