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

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

Предпосылки

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

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

Просьба

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

Метод Запрос URI
ПОЛУЧАЙ https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits

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

Заголовок Тип Описание
Авторизация струна Обязательное. Токен доступа Azure AD в формате Bearer<token>.

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

Параметр Тип Описание Обязательно
applicationId струна Идентификатор продукта настольного приложения, для которого требуется получить данные отчетов об ошибках. Чтобы получить идентификатор продукта классического приложения, откройте любой отчет аналитики для классического приложения в Центре партнеров (например, отчет о работоспособности) и получите идентификатор продукта из URL-адреса. Да
Дата начала дата Начальная дата в диапазоне дат для извлечения данных отчетов об ошибках в формате mm/dd/yyyy. Значение по умолчанию — текущая дата.

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

  • имя файла
  • applicationVersion
  • failureName
  • failureHash
  • символ
  • версия ОС
  • osBuild
  • osRelease
  • eventType
  • рынок
  • тип устройства
  • productName
  • дата
нет
уровень агрегации струна Указывает диапазон времени, для которого требуется получить статистические данные. Может быть одной из следующих строк: день, неделя или месяц. Если не указано, значение по умолчанию равно дню. Если указать неделю или месяц, значения failureName и failureHash ограничены 1000 контейнерами.

нет
сортировать по струна Инструкция, которая упорядочивает значения результирующих данных. Синтаксис — orderby=field [order], field [order],.... Параметр поле может быть одним из следующих строк:
  • имя файла
  • applicationVersion
  • failureName
  • failureHash
  • символ
  • версия ОС
  • osBuild
  • osRelease
  • eventType
  • рынок
  • тип устройства
  • productName
  • дата
Параметр order является необязательным и может быть asc или desc , чтобы указать возрастание или убывание для каждого поля. Значение по умолчанию — asc.

Вот пример строки orderby: orderby=date,market

нет
ГруппаПо струна Инструкция, которая применяет агрегирование данных только к указанным полям. Можно указать следующие поля:
  • failureName
  • failureHash
  • символ
  • версия ОС
  • eventType
  • рынок
  • тип устройства

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

  • дата
  • applicationId
  • applicationName
  • eventCount

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

нет

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

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

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

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

Ответ

Основная часть ответа

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

Коды ошибок

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

Ценность Тип Описание
дата струна Первая дата в диапазоне дат для данных об ошибках в формате "yyyy-mm-dd". Если запрос задает один день, это значение является этой датой. Если запрос задает более длинный диапазон дат, это значение является первой датой в этом диапазоне дат. Для запросов, указывающих уровень агрегирования час, это значение также включает время в формате .
applicationId струна Идентификатор продукта настольного приложения, для которого вы получили данные об ошибках.
названиеПродукта струна Отображаемое имя настольного приложения, полученное из метаданных его связанного исполняемого файла(ов).
appName струна Будет определено
имя файла струна Название исполняемого файла для настольного приложения.
название ошибки струна Имя сбоя, состоящее из четырех частей: один или несколько классов проблем, код проверки исключений и ошибок, имя изображения, в котором произошел сбой, и связанное имя функции.
хеш-сбоя струна Уникальный идентификатор ошибки.
символ струна Символ, назначенный этой ошибке.
osBuild струна Четырехкомпонентный номер сборки ОС, в которой произошла ошибка.
Версия ОС струна Одна из следующих строк, указывающая версию ОС, на которой установлено настольное приложение:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Windows Server 1709
  • Неизвестный
osRelease струна Одна из следующих строк, указывающая релиз или кольцо тестирования (как подпопуляция в пределах версии ОС), в котором произошла ошибка.

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

Для Windows 10:

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

Для Windows Server 1709:

  • РТМ

Для Windows Server 2016:

  • Версия 1607

Для Windows 8.1:

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

Для Windows 7:

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

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

Тип события струна Одна из следующих строк, указывающих тип события ошибки:
  • авария
  • вешать
  • память
  • JSE
рынок струна Код страны рынка девайсов по стандарту ISO 3166.
тип устройства струна Одна из следующих строк, указывающая тип устройства, на котором произошла ошибка:

  • ПК
  • Сервер
  • Таблетка
  • Неизвестный
версия приложения струна Версия исполняемого файла приложения, в которой произошла ошибка.
количество событий число/номер Количество событий, которые относятся к этой ошибке для указанного уровня агрегирования.

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

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

{
  "Value": [
    {
      "date": "2018-02-01",
      "applicationId": "10238467886765136388",
      "productName": "Contoso Demo",
      "appName": "Contoso Demo",
      "fileName": "contosodemo.exe",
      "failureName": "SVCHOSTGROUP_localservice_IN_PAGE_ERROR_c0000006_hardware_disk!Unknown",
      "failureHash": "11242ef3-ebd8-d525-838d-b5497b225695",
      "symbol": "hardware_disk!Unknown",
      "osBuild": "10.0.15063.850",
      "osVersion": "Windows 10",
      "osRelease": "Version 1703",
      "eventType": "crash",
      "market": "US",
      "deviceType": "PC",
      "applicationVersion": "2.2.2.0",
      "eventCount": 0.0012422360248447205
    }
  ],
  "@nextLink": "desktop/failurehits?applicationId=10238467886765136388&aggregationLevel=week&startDate=2018/02/01&endDate2018/02/08&top=1&skip=1",
  "TotalCount": 21
}