获取按搜索查询筛选的订阅分析信息

项目
12/21/2023

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

如何获取按搜索查询筛选的客户的订阅分析信息。

先决条件

合作伙伴中心身份验证中所述的凭据。此方案仅支持使用用户凭据进行身份验证。

REST 请求

请求语法

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

URI 参数

使用以下必需的路径参数来标识组织并筛选搜索。

名称	类型	必需	说明
filter_string	string	是	要应用于订阅分析的筛选器。有关在此参数中使用的语法、字段和运算符，请参阅筛选器语法和筛选器字段部分。

筛选器语法

筛选器参数必须组合为一系列字段、值和运算符组合。可以使用或or运算符组合and多个组合。

未编码的示例如下所示：

String：?filter=Field operator 'Value'
布尔：?filter=Field operator Value
包含 ?filter=contains(field,'value')

筛选器字段

请求的筛选器参数包含一个或多个语句，用于筛选响应中的行。每个语句都包含一个与或ne运算符关联的eq字段和值。某些字段还支持 contains/gegtlt> 和le运算符。可以使用或or运算符组合and语句。

下面是筛选器字符串的示例：

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

下表显示了筛选器参数支持的字段和支持运算符的列表。字符串值必须用单引号括起来。

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

请求标头

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

请求正文

无。

请求示例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
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: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd

{
    "customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "customerName": "SURFACE TEST2",
    "customerMarket": "US",
    "id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
    "status": "ACTIVE",
    "productName": "UNKNOWN",
    "subscriptionType": "Azure",
    "autoRenewEnabled": true,
    "partnerId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "friendlyName": "MICROSOFT AZURE",
    "creationDate": "2017-06-02T23:11:58.747",
    "effectiveStartDate": "2017-06-02T00:00:00",
    "commitmentEndDate": null,
    "currentStateEndDate": null,
    "trialToPaidConversionDate": null,
    "trialStartDate": null,
    "trialEndDate": null,
    "lastUsageDate": null,
    "deprovisionedDate": null,
    "lastRenewalDate": null,
    "licenseCount": 0
}

另请参阅

合作伙伴中心分析 - 资源

通过