获取见解数据

使用 Microsoft Store 分析 API 中的此方法,可获取与使用给定日期范围和其他可选筛选器时应用的购置、运行状况和使用情况指标相关的见解数据。 还可以在合作伙伴中心的见解报告中获取此信息。

先决条件

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

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

请求

请求语法

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

请求头

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

请求参数

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

可以指定以下筛选器字段:

  • acquisition
  • health
  • 用法

请求示例

以下示例演示获取见解数据的请求。 将 applicationId 值替换为你的应用的 Store ID。

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

响应

响应正文

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

见解值

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

Value 类型 说明
applicationId string 要检索见解数据的应用的 Store ID。
insightDate string 一个日期,我们在该日期确定了特定指标中的更改。 该日期表示一周的结束,在该周内我们检测到指标与上周相比明显增加或减少。
dataType string 以下字符串之一,指定此见解描述的一般分析区域:

  • acquisition
  • health
  • 用法
insightDetail array 一个或多个 InsightDetail 值,表示当前见解的详细信息。

InsightDetail 值

类型 描述
FactName string 以下值之一,指示当前见解或当前维度基于 dataType 值描述的指标。
  • 对于 health,此值始终为 HitCount
  • 对于 acquisition,此值始终为 AcquisitionQuantity
  • 对于 usage,此值可以为以下字符串之一:
    • DailyActiveUsers
    • EngagementDurationMinutes
    • DailyActiveDevices
    • DailyNewUsers
    • DailySessionCount
SubDimensions array 一个或多个对象,用于描述见解的单个指标。
PercentChange string 指标在整个客户群中变化的百分比。
DimensionName string 当前维度中描述的指标的名称。 示例包括 EventType、Market、DeviceType、PackageVersion、AcquisitionType、AgeGroup 和 Gender
DimensionValue string 当前维度中描述的指标的值。 例如,如果 DimensionName 为 EventType,则 DimensionValue 可能为 crash 或 hang
FactValue string 指标在检测到见解之日的绝对值。
方向 string 更改的方向(Positive 或 Negative)。
日期 string 一个日期,我们在该日期确定了与当前见解或当前维度相关的更改。

注意

检索的见解更改将仅持续 30 天的购置、运行状况和/或使用情况数据。

请求和响应示例

如下代码片段展示了这些请求的一些示例请求和 JSON 响应正文。

示例请求

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=7/12/2022&endDate=7/29/2022&filter=dataType eq 'acquisition' or dataType eq 'health'
HTTP/1.1
Authorization: Bearer <your access token>

示例响应

{
    "Value": [
        {
            "id": "8cdb672c7893bd33a3dec48ededdc676602a1361f3209ab4f3e0982672fc198f",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-27T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-27 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "DeviceType",
                            "DimensionValue": "Tablet",
                            "Date": "2022-07-27 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 16.091954022988507,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 28.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "6b8849ecb043c6e5ecdd1c20040c0a371e9ab176eff77f7312b0489e19379225",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-26T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-26 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "DeviceType",
                            "DimensionValue": "Tablet",
                            "Date": "2022-07-26 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 28.048780487804876,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 30.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "93115e855fec507385bab17251f49c33bcbc1b62c603e5c7863e327ba94bf160",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-20T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-20 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "GB",
                            "Date": "2022-07-20 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 3.3035714285714284,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 158.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "4814abe710042a2798b453d8821909c246c389dde814e6678da7189211410604",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-24T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-24 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "DO",
                            "Date": "2022-07-24 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 13.533834586466165,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 8.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "7941070bb17904f3ef4e19de9659110cb52e18ecfb637ad724e2da749445a860",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-21T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-21 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "AT",
                            "Date": "2022-07-21 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 0.0,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 17.0
                        }
                    ]
                },
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-21 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "SE",
                            "Date": "2022-07-21 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 21.686746987951807,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 5.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "55905f5458617b65669eb115cc28ebd7296841bd2ff3f8e2546ade1d5e93f68d",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-13T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-13 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "LK",
                            "Date": "2022-07-13 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 11.111111111111111,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 9.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "9ce9317bf4d0f903de51a49d00a07cf4b4a8ac4457fd1e2886493bd38ceac0b7",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-19T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "Acquisition",
                    "DimensionValue": "Free",
                    "Date": "2022-07-19 00:00:00",
                    "Direction": "Negative",
                    "PercentChange": 12.188725230475788,
                    "FactName": "AcquisitionQuantity",
                    "FactQuantity": 2470,
                    "SubDimensions": []
                }
            ]
        }
    ],
    "TotalCount": 7
}