Compartilhar via

Obtenha dados de relatório de erros para seu aplicativo para desktop

Use esse método na API de análise da Microsoft Store para obter dados de relatório de erros agregados para um aplicativo da área de trabalho que você adicionou ao programa aplicativo de área de trabalho do Windows. Esse método só pode recuperar erros ocorridos nos últimos 30 dias. Essas informações também estão disponíveis no relatório de Saúde para aplicativos de desktop no Partner Center.

Pré-requisitos

Para usar esse método, primeiro você precisa fazer o seguinte:

  • Se você ainda não fez isso, conclua todos os pré-requisitos da API de análise da Microsoft Store.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para esse método. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.

Solicitação

Sintaxe da solicitação

Método URI de solicitação
OBTER https://manage.devcenter.microsoft.com/v1.0/my/analytics/desktop/failurehits

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização corda Obrigatório O token de acesso do Azure AD no formato Bearer<token>.

Parâmetros de solicitação

Parâmetro Tipo Descrição Obrigatório
ID do aplicativo corda A ID do produto do aplicativo da área de trabalho para o qual você deseja recuperar dados de relatório de erros. Para obter a identificação do produto de um aplicativo da área de trabalho, abra qualquer relatório de análise de para seu aplicativo da área de trabalho no Partner Center (como o relatório Health) e recupere a identificação do produto da URL. Sim
Data de Início data A data de início no intervalo de datas dos dados de relatório de erros a serem recuperados, no formato mm/dd/yyyy. O padrão é a data atual.

Observação: Este método só pode recuperar erros ocorridos nos últimos 30 dias.		 Não
data de término data A data de término no intervalo de datas dos dados de relatório de erros a serem recuperados, no formato mm/dd/yyyy. O padrão é a data atual. Não
Início int O número de linhas de dados a serem retornados na solicitação. O valor máximo e o valor padrão se não especificado for 10000. Se houver mais linhas na consulta, o corpo da resposta incluirá um próximo link que você pode usar para solicitar a próxima página de dados. Não
pular int O número de linhas a serem ignoradas na consulta. Use esse parâmetro para percorrer grandes conjuntos de dados. Por exemplo, top=10000 e skip=0 recupera as primeiras 10000 linhas de dados, top=10000 e skip=10000 recupera as próximas 10000 linhas de dados e assim por diante. Não
filtro corda Uma ou mais declarações que filtram as linhas da resposta. Cada instrução contém um nome de campo do corpo da resposta e um valor associados aos operadores eq ou ne, e as instruções podem ser combinadas usando and ou or. Os valores de cadeia de caracteres devem ser cercados por aspas simples no parâmetro de filtro . Você pode especificar os seguintes campos do corpo da resposta:

  • Filename
  • Versão do aplicativo
  • nome da falha
  • falhaHash
  • símbolo
  • OSVersion
  • osBuild
  • osRelease
  • tipo de evento
  • mercado
  • tipoDeDispositivo
  • produtoNome
  • data
 Não
nível de agregação corda Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: dia, semana ou mês. Se não for especificado, o padrão será dia. Se você especificar semana ou mês, os valores failureName e failureHash serão limitados a 1000 buckets.

 Não
pedido por corda Uma instrução que ordena os valores dos dados resultantes. A sintaxe é orderby=field [order],field [order],.... O parâmetro field pode ser uma das seguintes strings:
  • Filename
  • Versão do aplicativo
  • nome da falha
  • falhaHash
  • símbolo
  • OSVersion
  • osBuild
  • osRelease
  • tipo de evento
  • mercado
  • tipoDeDispositivo
  • produtoNome
  • data
O parâmetro order é opcional e pode ser asc ou desc para especificar ordem ascendente ou descendente para cada campo. O padrão é asc.

Aqui está um exemplo de string orderby: orderby=date,market

 Não
groupby corda Uma instrução que aplica a agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos:
  • nome da falha
  • falhaHash
  • símbolo
  • OSVersion
  • tipo de evento
  • mercado
  • tipoDeDispositivo

As linhas de dados retornadas conterão os campos especificados no parâmetro groupby , bem como o seguinte:

  • data
  • ID do aplicativo
  • nome_do_aplicativo
  • contagem de eventos

O parâmetro groupby pode ser usado com o parâmetro aggregationLevel . Por exemplo: &groupby=failureName,market&aggregationLevel=week

 Não

Exemplo de solicitação

Os exemplos a seguir demonstram várias solicitações para obter dados de relatório de erros. Substitua o valor applicationId pela ID do produto para seu aplicativo da área de trabalho.

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>

Resposta

Corpo da resposta

Valor Tipo Descrição
Valor conjunto Uma matriz de objetos que contêm dados de relatório de erros agregados. Para obter mais informações sobre os dados em cada objeto, consulte a seção de valores de erro abaixo.
@nextLink corda Se houver páginas adicionais de dados, essa cadeia de caracteres conterá um URI que você pode usar para solicitar a próxima página de dados. Por exemplo, esse valor será retornado se o parâmetro principal da solicitação for definido para 10.000, mas houver mais de 10.000 linhas contendo erros na consulta.
ContagemTotal número inteiro O número total de linhas no resultado dos dados da consulta.

Valores de erro

Os elementos na matriz Value contêm os valores a seguir.

Valor Tipo Descrição
data corda A primeira data no intervalo de datas para os dados de erro, no formato yyyy-mm-dd. Se a solicitação especificar um único dia, esse valor será essa data. Se a solicitação especificar um intervalo de datas mais longo, esse valor será a primeira data nesse intervalo de datas. Para solicitações que especificam um valor agregaçãoLevel de hora, esse valor também inclui um valor de tempo no formato hh:mm:ss.
ID do aplicativo corda O código do produto do aplicativo para desktop para o qual você recuperou dados de erro.
nomeDoProduto corda O nome de exibição do aplicativo de desktop derivado dos metadados do(s) executável(is) associado(s).
nome_do_aplicativo corda TBD
nome do arquivo corda O nome do arquivo executável do aplicativo de desktop.
Nome da falha corda O nome da falha, que é composta por quatro partes: uma ou mais classes de problema, um código de verificação de exceção/bug, o nome da imagem em que ocorreu a falha e o nome da função associada.
HashDeFalha corda O identificador exclusivo do erro.
símbolo corda O símbolo atribuído a esse erro.
osBuild corda O número de build de quatro partes do sistema operacional no qual o erro ocorreu.
osVersion corda Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional na qual o aplicativo da área de trabalho está instalado:

  • Windows 7
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Windows Server 2016
  • Servidor Windows 1709
  • Desconhecido
osRelease corda Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional ou o anel de pré-lançamento (como uma subpopulação dentro da versão do sistema operacional) na qual o erro ocorreu.

Para Windows 11: Versão 2110

Para Windows 10:

  • Versão 1507
  • Versão 1511
  • Versão 1607
  • Versão 1703
  • Versão 1709
  • Versão 1803
  • Versão prévia
  • Insider Rápido
  • Insider Lento

Para Windows Server 1709:

  • RTM

Para Windows Server 2016:

  • Versão 1607

Para Windows 8.1:

  • Atualização 1

Para Windows 7:

  • Pacote de serviços 1

Se a versão do sistema operacional ou o anel de lançamento de software for desconhecido, este campo terá valor Desconhecido.
tipo de evento corda Uma das seguintes cadeias de caracteres que indica o tipo de evento de erro:
  • falha
  • travamento
  • memória
  • apenas
mercado corda O código de país ISO 3166 do mercado de dispositivos.
tipo de dispositivo corda Uma das seguintes cadeias de caracteres que especifica o tipo de dispositivo no qual o erro ocorreu:

  • Computador
  • Servidor
  • Tabuleta
  • Desconhecido
versão do aplicativo corda A versão do executável do aplicativo na qual o erro ocorreu.
contagemDeEventos número O número de eventos atribuídos a esse erro para o nível de agregação especificado.

Exemplo de resposta

Veja a seguir um exemplo de corpo de resposta JSON para essa solicitação.

{
  "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
}
  • Last updated on