Получение аналитики подписки, сгруппированных по датам или условиям

Мақала
03/08/2023

Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government

Как получить аналитические сведения о подписке для клиентов, сгруппированных по датам или условиям.

Предварительные условия

Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности только с учетными данными пользователя.

Запрос REST

Синтаксис запроса

Метод	Универсальный код ресурса (URI) запроса
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Параметры универсального кода ресурса (URI)

Используйте следующие обязательные параметры пути, чтобы определить организацию и сгруппировать результаты.

Имя	Тип	Обязательно	Описание
groupby_queries	пары строк и dateTime	Да	Термины и даты для фильтрации результата.

Синтаксис GroupBy

Параметр group by должен быть составлен в виде ряда значений полей, разделенных запятыми.

Фильтр без кодировки выглядит следующим образом:

?groupby=termField1,dateField1,termField2

В следующей таблице показан список поддерживаемых полей для группирования.

Поле	Тип	Описание
customerTenantId	строка	Строка в формате GUID, идентифицирующая клиент клиента.
customerName	строка	Имя клиента.
customerMarket	строка	Страна или регион, в которые клиент ведет бизнес.
идентификатор	строка	Строка в формате GUID, определяющая подписку.
status	строка	Состояние подписки. Поддерживаемые значения: "ACTIVE", "SUSPENDED" или "DEPROVISIONED".
productName	строка	Имя продукта.
subscriptionType	строка	Тип подписки. Примечание. В этом поле учитывается регистр. Поддерживаемые значения: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Логическое	Значение типа , указывающее, продлевается ли подписка автоматически.
partnerId	строка	Идентификатор партнера. Для прямого торгового посредника этот параметр будет иметь значение PartnerID партнера. Для косвенного торгового посредника этот параметр будет иметь значение PartnerID непрямого торгового посредника.
friendlyName	строка	Имя подписки.
partnerName	строка	Имя партнера, для которого была приобретена подписка
providerName	строка	Если транзакция подписки предназначена для косвенного торгового посредника, имя поставщика — это косвенный поставщик, купивший подписку.
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	Количество строк данных, возвращаемых в запросе. Если значение не указано, максимальное значение и значение по умолчанию — 10 000. Если в запросе содержится больше строк, то тело ответа будет содержать ссылку «Далее», которую можно использовать для запроса следующей страницы данных
skip	INT	Количество строк, пропускаемых в запросе. Используйте этот параметр для постраничного перемещения по большим наборам данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 — следующие 10 000 строк данных.
фильтр	строка	Одно или несколько выражений для фильтрации строк в ответе. Каждая инструкция filter содержит имя поля из текста ответа и значение, связанное `eq`с оператором , `ne`или для определенных полей `contains` . Операторы можно комбинировать с помощью `and` или `or`. В параметре filter строковые значения должны быть заключены в одиночные кавычки. Список полей, которые можно отфильтровать, и операторы, поддерживаемые этими полями, см. в следующем разделе.
aggregationLevel	строка	Определяет диапазон времени, для которого требуется получить сводные данные. Можно использовать следующие строки: day, week или month. Если значение не указано, значение по умолчанию — dateRange. Примечание. Этот параметр применяется только в том случае, если поле даты передается как часть параметра groupBy.
Groupby	строка	Выражение, которое применяет агрегирование данных только к указанным полям.

Заголовки запроса

Дополнительные сведения см. в статье о заголовках 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
}

См. также раздел

Аналитика Центра партнеров. Ресурсы

Бөлісу құралы: