Получение данных отчетов об ошибках для приложения

Используйте этот метод в API аналитики Microsoft Store, чтобы получить статистические данные отчетов об ошибках для приложения в формате JSON для заданного диапазона дат и других необязательных фильтров. Этот метод может получить только ошибки, возникшие за последние 30 дней. Эти сведения также доступны в разделе "Сбои" отчета о работоспособности в Центре партнеров.

Дополнительные сведения об ошибках можно получить с помощью сведений об ошибке, получить трассировку стека и скачать методы CAB-файла .

Необходимые компоненты

Чтобы использовать этот метод, сначала необходимо выполнить следующие действия:

  • Если это еще не сделано, выполните все предварительные требования для API аналитики Microsoft Store.
  • Получите маркер доступа Azure AD для использования в заголовке запроса для этого метода. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.

Запросить

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

Способ URI запроса
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits

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

Верхний колонтитул Тип Описание
Авторизация строка Обязательно. Маркер доступа Azure AD в маркере> носителя<формы.

Параметры запроса

Параметр Тип Описание Обязательное поле
applicationId строка Идентификатор магазина приложения, для которого требуется получить данные отчетов об ошибках. Идентификатор Магазина доступен на странице удостоверений приложения в Центре партнеров. Пример идентификатора магазина — 9WZDNCRFJ3Q8. Да
startDate Дата Дата начала в диапазоне дат для получения данных отчетов об ошибках. Значение по умолчанию — текущая дата. Если aggregationLevel имеет день, неделю или месяц, этот параметр должен указать дату в формате mm/dd/yyyy. Если агрегированиеLevelчас, этот параметр может указать дату в формате mm/dd/yyyy или дате и времени в формате yyyy-mm-dd hh:mm:ss.

Примечание. Этот метод может получать только ошибки, возникшие за последние 30 дней.
No
endDate Дата Дата окончания в диапазоне дат для получения данных отчетов об ошибках. Значение по умолчанию — текущая дата. Если aggregationLevel имеет день, неделю или месяц, этот параметр должен указать дату в формате mm/dd/yyyy. Если агрегированиеLevelчас, этот параметр может указать дату в формате mm/dd/yyyy или дате и времени в формате yyyy-mm-dd hh:mm:ss. No
популярное INT Количество строк данных, возвращаемых в запросе. Максимальное значение и значение по умолчанию, если не указано значение 10000. Если в запросе есть больше строк, текст ответа содержит следующую ссылку, которую можно использовать для запроса следующей страницы данных. No
skip INT Количество строк, пропускаемых в запросе. Используйте этот параметр для страницы с помощью больших наборов данных. Например, top=10000 и skip=0 извлекает первые 10000 строк данных, top=10000 и skip=10000 извлекает следующие 10000 строк данных и т. д. No
Фильтр строка Одна или несколько инструкций, которые фильтруют строки в ответе. Каждая инструкция содержит имя поля из текста ответа и значения, связанного с операторами eq или ne, и операторы могут быть объединены с помощью или или. Строковые значения должны быть окружены одними кавычками в параметре фильтра . В тексте ответа можно указать следующие поля:

  • applicationName
  • failureName
  • failureHash
  • Символ
  • osVersion
  • osRelease
  • eventType
  • Рынке
  • deviceType
  • PackageName
  • packageVersion
  • date
No
aggregationLevel строка Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: час, день, неделя или месяц. Если не указано, значение по умолчанию равно дню. Если указать неделю или месяц, значения failureName и failureHash ограничены 1000 контейнерами.

Примечание. Если указать час, вы можете получить данные об ошибках только из предыдущих 72 часов. Чтобы получить данные об ошибках старше 72 часов, укажите день или один из других уровней агрегирования.
No
orderby строка Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поля может быть одной из следующих строк:
  • applicationName
  • failureName
  • failureHash
  • Символ
  • osVersion
  • osRelease
  • eventType
  • Рынке
  • deviceType
  • PackageName
  • packageVersion
  • date

Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc.

Ниже приведен пример строки заказа : orderby=date,market

No
Groupby строка Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • failureName
  • failureHash
  • Символ
  • osVersion
  • eventType
  • Рынке
  • deviceType
  • PackageName
  • packageVersion

Возвращаемые строки данных будут содержать поля, указанные в параметре groupby , а также следующие:

  • date
  • applicationId
  • applicationName
  • deviceCount
  • eventCount

Параметр groupby можно использовать с параметром aggregationLevel . Например: &groupby=failureName,market&aggregationLevel=week

No

Пример запроса

В следующих примерах показано несколько запросов на получение данных отчетов об ошибках. Замените значение applicationId идентификатором Магазина для приложения.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId=9NBLGGGZ5QDR&startDate=1/1/2015&endDate=2/1/2015&top=10&skip=0 HTTP/1.1
Authorization: Bearer <your access token>

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId=9NBLGGGZ5QDR&startDate=8/1/2015&endDate=8/31/2015&skip=0&filter=market eq 'US' and deviceType eq 'phone' HTTP/1.1
Authorization: Bearer <your access token>

Response

Текст ответа

Значение Тип Описание
Значение array Массив объектов, содержащих статистические данные отчетов об ошибках. Дополнительные сведения о данных в каждом объекте см . в разделе об ошибках ниже.
@nextLink строка Если есть дополнительные страницы данных, эта строка содержит универсальный код ресурса (URI), который можно использовать для запроса следующей страницы данных. Например, это значение возвращается, если верхний параметр запроса имеет значение 10000, но для запроса имеется более 10000 строк ошибок.
TotalCount integer Общее количество строк в результатах данных для запроса.

Ошибочные значения

Элементы в массиве значений содержат следующие значения.

Значение Тип Описание
Дата строка Первая дата в диапазоне дат для данных об ошибках в формате yyyy-mm-dd. Если запрос задает один день, это значение является этой датой. Если запрос задает более длинный диапазон дат, это значение является первой датой в этом диапазоне дат. Для запросов, указывающих значение агрегированияLevel часа, это значение также включает значение времени в форматеhh:mm:ss.
applicationId строка Идентификатор приложения, для которого требуется получить данные об ошибках.
applicationName строка Отображаемое имя приложения.
failureName строка Имя сбоя, состоящего из четырех частей: одного или нескольких классов проблем, кода исключения или ошибки проверка кода, имени изображения, в котором произошла ошибка, и связанного имени функции.
failureHash строка Уникальный идентификатор ошибки.
symbol строка Символ, назначенный этой ошибке.
osVersion строка Одна из следующих строк, указывающая версию ОС, в которой произошла ошибка:
  • Windows Телефон 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Телефон 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Unknown
osRelease строка Одна из следующих строк, указывающая выпуск ОПЕРАЦИОННОй системы или кольцо переключения (как подпопление в версии ОС), в котором произошла ошибка.

Для Windows 11: версия 2110

Для Windows 10:

  • Версия 1507
  • Версия 1511
  • Версия 1607
  • Версия 1703
  • Версия 1709
  • Версия 1803
  • Предварительная версия выпуска
  • Быстрая предварительная оценка
  • Медленное выполнение программы предварительной оценки

Для Windows Server 1709:

  • RTM

Для Windows Server 2016

  • Версия 1607

Для Windows 8.1:

  • Обновление 1

Для Windows 7:

  • Пакет обновления 1

Если выпуск ОС или кольцо полетов неизвестно, это поле имеет значение Unknown.

eventType строка Одна из следующих строк:
  • Аварии
  • Повесить
  • memory
  • Jse
на рынок строка Код страны ISO 3166 рынка устройств.
deviceType строка Одна из следующих строк, указывающих тип устройства, на котором произошла ошибка:
  • ПК
  • Для телефонов
  • Console-Xbox One
  • Серия Xbox X консоли
  • Интернет вещей
  • Голографической
  • Unknown
PackageName строка Уникальное имя пакета приложения, связанного с этой ошибкой.
packageVersion строка Версия пакета приложения, связанного с этой ошибкой.
deviceCount number Количество уникальных устройств, соответствующих этой ошибке для указанного уровня агрегирования.
eventCount number Количество событий, которые относятся к этой ошибке для указанного уровня агрегирования.

Примечание.

Этот метод может получить только ошибки, возникшие за последние 30 дней.

Пример запроса и ответа

В следующем фрагменте кода показан пример текста запроса и текста ответа JSON для этого запроса.

Пример запроса

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits?applicationId=9NBLGGGZ5QDR&startDate=07/02/2022&endDate=07/20/2022&top=10&skip=0&filter=market eq 'US'&groupby=failureName,failureHash,symbol,osVersion,eventType,market,deviceType,packageName,packageVersion,osRelease&orderby=date
HTTP/1.1
Authorization: Bearer <your access token>

Пример ответа

{
    "Value": [
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_BlockedOn_FileIO_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_Microsoft.Contoso Demo!unknown_error_in_application",
            "failureHash": "c21da75f-ea4d-538b-cfec-73654ef810b9",
            "symbol": "Microsoft.Contoso Demo!unknown_error_in_application",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "PC",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 6.0,
            "eventCount": 1.05263157894737
        },
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_BlockedOn_FileIO_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_Microsoft.Contoso Demo!unknown_error_in_application",
            "failureHash": "c21da75f-ea4d-538b-cfec-73654ef810b9",
            "symbol": "Microsoft.Contoso Demo!unknown_error_in_application",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "Unknown",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 7.14285714285714,
            "eventCount": 1.05263157894737
        },
        {
            "date": "2022-07-21",
            "applicationId": "9NBLGGGZ5QDR",
            "applicationName": "Contoso Demo",
            "failureName": "APPLICATION_HANG_Microsoft.Contoso Demo!CEServices.InternalLiveTileUpdaterRuntime_dfffffff_twinapi.appcore.dll!WaitCoalesced",
            "failureHash": "233e04bb-7a3d-eb28-c316-1120aa9defc0",
            "symbol": "twinapi.appcore.dll!WaitCoalesced",
            "osVersion": "6.3.9600",
            "osRelease": "RTM",
            "osArchitecture": null,
            "eventType": "hang",
            "market": "US",
            "deviceType": "PC",
            "praid": null,
            "packageName": "microsoft.Contoso Demo_2.5.2.34894_x86__8wekyb3d8bbwe",
            "packageVersion": "2.5.2.34894",
            "ram": null,
            "massStorage": null,
            "cpu": null,
            "cpuManufacturer": null,
            "cpuFamilyName": null,
            "sandboxId": null,
            "deviceCount": 6.0,
            "eventCount": 8.94736842105263
        }
    ],
    "@nextLink": "failurehits?applicationId=9NBLGGGZ5QDR&aggregationLevel=day&startDate=2022/07/02&endDate=2022/07/21&top=10&skip=10&groupby=failureName,failureHash,symbol,osVersion,eventType,market,deviceType,packageName,packageVersion,osRelease&filter=market eq 'US'&orderby=date",
    "TotalCount": 443
}