SharePoint 2013 中使用代码获取 search reports(Top_Queries, Abandoned_Queries,No_Result_Queries )_spservicecontext.getdefaultproxy.getsearchreport-CSDN博客

本文链接：https://blog.csdn.net/abrahamcheng/article/details/14212289

本文介绍了如何在SharePoint 2013环境中通过代码获取Search Reports，包括Top_Queries、Abandoned_Queries和No_Result_Queries。为了在页面上展示这些报表，开发者需要使用特定的代码，并在运行时可能需要提权。文章提供了引用DLL和代码示例。

摘要由CSDN通过智能技术生成

本文讲述如何在SharePoint 2013 中使用代码获取 search reports(Top_Queries, Abandoned_Queries,No_Result_Queries )。

SharePoint 2013中提供多种report，供SharePoint 开发和管理人员分析和改进SharePoint search 服务(可以在管理中心的search service 设置中找到这些报表)：

但是很多情况下，普通客户也想在页面中看到这些报表，那这种情况就需要使用代码取 search report 的数据了。

这里贡献一段用控制台应用程序读 report 数据的代码，注意如果要在 web part里面使用这些代码必须提权 (SPSecurity.RunWithElevatedPrivileges):

1. 首先在控制台应用程序中添加Dll引用

Microsoft.Office.Server.dll
Microsoft.Office.Server.Search.dll
Microsoft.Office.Server.Search.Applications.dll
Microsoft.SharePoint.dll

2. 将控制台应用程序的Target platform 改为X64

3. Program.cs代码如下：

using Microsoft.Office.Server.Search.Administration;
using Microsoft.Office.Server.Search.Analytics;
using Microsoft.Office.Server.Search.Query;
using Microsoft.SharePoint;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            if (args.Length != 2)
            {
                Console.WriteLine("Please use : GetTopSearchQueryText.exe siteUrl topNumber");
            }
            else
            {
                try
                {
                    using (SPSite oSPsite = new SPSite(args[0]))
                    {
                        Microsoft.SharePoint.SPServiceContext context = SPServiceContext.GetContext(oSPsite);
                        SearchServiceApplicationProxy searchProxy = context.GetDefaultProxy(typeof(SearchServiceApplicationProxy)) as SearchServiceApplicationProxy;
                        SearchServiceApplicationInfo ssai = searchProxy.GetSearchServiceApplicationInfo();
                        SearchServiceApplication searchApp = SearchService.Service.SearchServiceApplications.First<SearchServiceApplication>();                       
                        for (int i = 0; i < 100; i++)
                        {
                            var reports = searchApp.GetSearchReport(i, Guid.Empty, oSPsite.ID, DateTime.Now.AddMonths(-2), false, uint.Parse(args[1]));
                            // GetSearchReport 的第一参数 report type 含义，微软的文档没有说，就让传int32,经过笔者循环验证的结论
                            // 1 : Top_Queries
                            // 2: Abandoned_Queries
                            // 3: No_Result_Queries

                            Console.WriteLine("reports.Count:" + reports.Count);
                            foreach (QueryReportData report in reports)
                            {
                                Console.WriteLine("Query:" + report.Query + ", count:" + report.Count + ", Scope:" + report.Scope);
                            }
                        }                        
                    }
                }
                catch (Exception ex)
                {
                    Console.WriteLine("error:"  + ex.Message);
                    Console.WriteLine("StackTrace:" + ex.StackTrace);
                }

                Console.WriteLine("Press any key to exit");
                Console.ReadKey();
            }
        }
    }
}