获取桌面应用程序的见解数据

在 Microsoft Store 分析 API 中使用此方法,可获取与添加到 Windows 桌面应用程序计划的桌面应用程序的运行状况指标相关的见解数据。 也可以在合作伙伴中心的桌面应用程序运行状况报告中获取此数据。

先决条件

若要使用此方法,首先需要执行以下操作:

  • 完成 Microsoft Store 分析 API 的所有先决条件(如果尚未这样做)。
  • 获取 Azure AD 访问令牌,以供在此方法的请求标头中使用。 获取访问令牌后,在它到期前,你有 60 分钟的使用时间。 该令牌到期后,可以获取新的令牌。

请求

请求语法

方法 请求 URI
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/insights

请求头

标头 类型 说明
授权 字符串 必需。 Azure AD 访问令牌的格式为 Bearertoken<>。

请求参数

参数 类型 描述 必需
applicationId string 要为其获取见解数据的桌面应用程序的产品 ID。 若要获取桌面应用程序的产品 ID,请在合作伙伴中心打开桌面应用程序的分析报告(如运行状况报告)并从 URL 检索产品 ID。 如果不指定此参数,响应正文将包含注册到你帐户的所有应用的见解数据。
startDate date 要检索的见解数据的日期范围中的开始日期。 默认值为当前日期之前的 30 天。
endDate date 要检索的见解数据的日期范围中的结束日期。 默认是当前日期。
filter string 在响应中筛选行的一条或多条语句。 每条语句包含的响应正文中的字段名称和值使用 eqne 运算符进行关联,并且语句可以使用 andor 进行组合。 filter 参数中的字符串值必须使用单引号引起来。 例如,filter=dataType eq 'acquisition'

目前,此方法仅支持筛选器 运行状况

请求示例

以下示例演示获取见解数据的请求。 将 applicationId 值替换为桌面应用程序的相应值。

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/insights?applicationId=10238467886765136388&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'health' HTTP/1.1
Authorization: Bearer <your access token>

响应

响应正文

类型 说明
Value array 包含应用见解数据的对象数组。 有关每个对象中的数据的详细信息,请参阅下面的见解值部分。
TotalCount int 查询的数据结果中的行总数。

见解值

Value 数组中的元素包含以下值。

Value 类型 说明
applicationId string 要为其检索见解数据的桌面应用程序的产品 ID。
insightDate string 一个日期,我们在该日期确定了特定指标中的更改。 该日期表示一周的结束,在该周内我们检测到指标与上周相比明显增加或减少。
dataType string 一个字符串,指定此见解通知的常规分析区域。 目前,此方法仅支持 health
insightDetail array 一个或多个 InsightDetail 值,表示当前见解的详细信息。

InsightDetail 值

类型 描述
FactName string 一个字符串,指示当前见解或当前维度描述的指标。 目前,此方法仅支持值 HitCount
SubDimensions array 一个或多个对象,用于描述见解的单个指标。
PercentChange string 指标在整个客户群中变化的百分比。
DimensionName string 当前维度中描述的指标的名称。 示例包括 EventType、Market、DeviceType 和 PackageVersion
DimensionValue string 当前维度中描述的指标的值。 例如,如果 DimensionName 为 EventType,则 DimensionValue 可能为 crash 或 hang
FactValue string 指标在检测到见解之日的绝对值。
方向 string 更改的方向(Positive 或 Negative)。
日期 string 一个日期,我们在该日期确定了与当前见解或当前维度相关的更改。

响应示例

以下示例举例说明此请求的 JSON 响应正文。

{
  "Value": [
    {
      "applicationId": "9NBLGGGZ5QDR",
      "insightDate": "2018-06-03T00:00:00",
      "dataType": "health",
      "insightDetail": [
        {
          "FactName": "HitCount",
          "SubDimensions": [
            {
              "FactName:": "HitCount",
              "PercentChange": "21",
              "DimensionValue:": "DE",
              "FactValue": "109",
              "Direction": "Positive",
              "Date": "6/3/2018 12:00:00 AM",
              "DimensionName": "Market"
            }
          ],
          "DimensionValue": "crash",
          "Date": "6/3/2018 12:00:00 AM",
          "DimensionName": "EventType"
        },
        {
          "FactName": "HitCount",
          "SubDimensions": [
            {
              "FactName:": "HitCount",
              "PercentChange": "71",
              "DimensionValue:": "JP",
              "FactValue": "112",
              "Direction": "Positive",
              "Date": "6/3/2018 12:00:00 AM",
              "DimensionName": "Market"
            }
          ],
          "DimensionValue": "hang",
          "Date": "6/3/2018 12:00:00 AM",
          "DimensionName": "EventType"
        },
      ],
      "insightId": "9CY0F3VBT1AS942AFQaeyO0k2zUKfyOhrOHc0036Iwc="
    }
  ],
  "@nextLink": null,
  "TotalCount": 2
}