获取所有订阅分析信息
适用于:合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心
本文介绍如何获取客户的所有订阅分析信息。
先决条件
- 合作伙伴中心身份验证中所述的凭据。 此方案仅支持使用用户凭据进行身份验证。
REST 请求
请求语法
方法 | 请求 URI |
---|---|
GET | {baseURL}/partner/v1/analytics/subscriptions HTTP/1.1 |
URI 参数
下表列出了可选参数及其说明:
参数 | 类型 | 描述 |
---|---|---|
top | int | 要在请求中返回的数据行数。 如果未指定该值,则最大值和默认值为 10000 。 当查询中存在多行数据时,响应正文中包含的下一个链接可用于请求下一页数据。 |
skip | int | 要在查询中跳过的行数。 使用此参数可以浏览较大的数据集。 例如, top=10000 并 skip=0 检索前 10,000 行数据, top=10000 并 skip=10000 检索接下来的 10,000 行数据。 |
filter | string | 在响应中筛选行的一条或多条语句。 每个筛选器语句都包含响应正文中的字段名称,以及与eq ne 运算符或特定字段contains 关联的值。 语句可以使用 and 或 or . filter 参数中的字符串值必须使用单引号引起来。 有关可筛选的字段列表以及这些字段支持的运算符,请参阅以下部分。 |
aggregationLevel | string | 指定用于检索聚合数据的时间范围。 可以是以下字符串之一:day、week 或 month。 如果未指定该值,则默认值为 dateRange。 仅当日期字段作为 groupBy 参数的一部分传递时,此参数才适用。 |
groupBy | string | 仅将数据聚合应用于指定字段的语句。 |
请求标头
有关详细信息,请参阅合作伙伴中心 REST 标头。
请求正文
无。
请求示例
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0
REST 响应
如果成功,响应正文将包含订阅资源的集合。
响应的成功和错误代码
每个响应都有一个 HTTP 状态代码,指示成功或失败以及额外的调试信息。 使用网络跟踪工具读取此代码、错误类型和其他参数。 有关完整列表,请参阅错误代码。
响应示例
{
"customerTenantId": "76906668-27FC-4F5B-A35C-75A9823E13AF",
"customerName": "TESTORG65656565",
"customerMarket": "US",
"id": "4BF546B2-8998-4838-BEE2-5F1BBE65A04F",
"status": "ACTIVE",
"productName": "OFFICE 365 BUSINESS PREMIUM",
"subscriptionType": "Office",
"autoRenewEnabled": true,
"partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
"friendlyName": "FULL OFFICE SUITE",
"partnerName": "Partner Name",
"providerName": "Provider Name",
"creationDate": "2016-02-04T19:29:38.037",
"effectiveStartDate": "2016-02-04T00:00:00",
"commitmentEndDate": "2019-02-10T00:00:00",
"currentStateEndDate": "2019-02-10T00:00:00",
"trialToPaidConversionDate": null,
"trialStartDate": null,
"trialEndDate": null,
"lastUsageDate": null,
"deprovisionedDate": null,
"lastRenewalDate": "2018-02-10T02:39:57.729",
"licenseCount": 2,
"churnRisk": "High",
"billingCycleName": "MONTHLY"
}