Получение всех аналитических сведений о подписках
Область применения: Центр партнеров | Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud for US Government
В этой статье описывается, как получить все сведения об аналитике подписок для клиентов.
Необходимые компоненты
- Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности только с учетными данными пользователя.
Запрос REST
Синтаксис запроса
Метод | URI запроса |
---|---|
GET | {baseURL}/partner/v1/analytics/subscriptions HTTP/1.1 |
Параметры универсального кода ресурса (URI)
В следующей таблице перечислены необязательные параметры и их описания:
Параметр | Тип | Описание |
---|---|---|
top | целое | Количество строк данных, возвращаемых в запросе. Если значение не указано, максимальное значение и значение 10000 по умолчанию. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. |
skip | целое | Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10 000 строк данных и top=10000 skip=10000 извлекает следующие 10 000 строк данных. |
Фильтр | строка | Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция фильтра содержит имя поля из текста ответа и значение, связанное с eq оператором , ne или для определенных полей contains . Операторы можно объединить с помощью and или or . Строковые значения должны быть окружены одними кавычками в параметре фильтра . В следующем разделе приведен список полей, которые можно фильтровать и операторы, поддерживаемые этими полями. |
aggregationLevel | строка | Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если значение не указано, значение по умолчанию — dateRange. Этот параметр применяется только в том случае, если поле даты передается как часть параметра groupBy . |
Groupby | строка | Инструкция, которая применяет агрегирование данных только к указанным полям. |
Заголовки запросов
Дополнительные сведения см. в статье о заголовках 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": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"customerName": "TESTORG65656565",
"customerMarket": "US",
"id": "4BF546B2-8998-4838-BEE2-5F1BBE65A04F",
"status": "ACTIVE",
"productName": "OFFICE 365 BUSINESS PREMIUM",
"subscriptionType": "Office",
"autoRenewEnabled": true,
"partnerId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"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"
}