获取按日期或条款分组的订阅分析

  • 项目

适用于：合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心

如何获取按日期或条款分组的客户的订阅分析信息。

必备条件

REST 请求

请求语法

方法 请求 URI
GET {baseURL}/partner/v1/analytics/subscriptions？groupby={groupby_queries}

URI 参数

使用以下必需的路径参数来标识组织并对结果进行分组。

名称 类型 必须 说明
groupby_queries 字符串对和 dateTime 是 用于筛选结果的术语和日期。

GroupBy 语法

分组依据参数必须组成为一系列逗号分隔的字段值。

未编码的示例如下所示：

?groupby=termField1,dateField1,termField2

下表显示了分组依据支持的字段列表。

字段 类型 说明
customerTenantId string 标识客户租户的 GUID 格式字符串。
customerName string 客户的名称。
customerMarket 字符串 客户开展业务的国家/地区。
id 字符串 一个 GUID 格式的字符串，用于标识订阅。
status 字符串 订阅状态。 支持的值为：“ACTIVE”、“SUSPENDED”或“DEPROVISIONED”。
productName string 产品的名称。
subscriptionType string 订阅类型。 注意：此字段区分大小写。 支持的值为：“Office”、“Azure”、“Microsoft365”、“Dynamics”、“EMS”。
autoRenewEnabled 布尔 一个值，该值指示是否自动续订订阅。
partnerId string PartnerID。 对于直接经销商，此参数将是合作伙伴的 PartnerID。 对于间接经销商，此参数将是间接经销商的 PartnerID。
friendlyName 字符串 订阅的名称。
partnerName 字符串 为其购买订阅的合作伙伴的名称
ProviderName string 如果订阅事务针对的是间接经销商，则提供商名称是购买订阅的间接提供商。
creationDate 采用 UTC 日期/时间格式的字符串 创建订阅的日期。
effectiveStartDate 采用 UTC 日期/时间格式的字符串 订阅的开始日期。
commitmentEndDate 采用 UTC 日期/时间格式的字符串 订阅结束日期。
currentStateEndDate 采用 UTC 日期/时间格式的字符串 订阅的当前状态将更改的日期。
trialToPaidConversionDate 采用 UTC 日期/时间格式的字符串 订阅从试用转换为付费的日期。 默认值为 null。
trialStartDate 采用 UTC 日期/时间格式的字符串 订阅试用期开始的日期。 默认值为 null。
lastUsageDate 采用 UTC 日期/时间格式的字符串 上次使用订阅的日期。 默认值为 null。
deprovisionedDate 采用 UTC 日期/时间格式的字符串 取消预配订阅的日期。 默认值为 null。
lastRenewalDate 采用 UTC 日期/时间格式的字符串 上次续订订阅的日期。 默认值为 null。

筛选器字段

下表列出了可选筛选器字段及其说明：

字段 类型 说明
top int 要在请求中返回的数据行数。 如果未指定该值，则最大值和默认值为 10000。 当查询中存在多行数据时，响应正文中包含的下一个链接可用于请求下一页数据。
skip int 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如，top=10000 和 skip=0 检索前 10000 行数据，top=10000 和 skip=10000 检索接下来的 10000 行数据。
filter string 在响应中筛选行的一条或多条语句。 每个筛选器语句都包含响应正文中的字段名称和一个与 eq、 ne或 某些字段 contains 的 运算符关联的值。 可以使用 或 or组合and语句。 filter 参数中的字符串值必须使用单引号引起来。 有关可筛选的字段的列表以及这些字段支持的运算符的列表，请参阅以下部分。
aggregationLevel string 指定用于检索聚合数据的时间范围。 可以是以下字符串之一：day、week 或 month。 如果未指定该值，则默认值为 dateRange。 注意：仅当日期字段作为 groupBy 参数的一部分传递时，此参数才适用。
groupBy string 仅将数据聚合应用于指定字段的语句。

请求标头

有关详细信息，请参阅合作伙伴中心 REST 标头。

请求正文

无。

请求示例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
Content-Type: application/json
Content-Length: 0

REST 响应

如果成功，响应正文将包含按指定术语和日期分组的 订阅 资源的集合。

响应的成功和错误代码

每个响应都带有一个 HTTP 状态代码，用于指示成功或失败以及其他调试信息。 请使用网络跟踪工具来读取此代码、错误类型和其他参数。 有关完整列表，请参阅错误代码。

响应示例

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

另请参阅

合作伙伴中心分析 - 资源