Partilhar via


Obter dados de relatório de erros para seu aplicativo

Use esse método na API de análise da Microsoft Store para obter dados agregados de relatório de erros para seu aplicativo no formato JSON para um determinado intervalo de datas e outros filtros opcionais. Este método só pode recuperar erros que ocorreram nos últimos 30 dias. Essas informações também estão disponíveis na seção Falhas do relatório Saúde no Partner Center.

Você pode recuperar informações de erro adicionais usando os métodos obter detalhes do erro, obter rastreamento da pilhae baixar arquivo CAB.

Pré-requisitos

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

  • Se ainda não tiver feito isso, preencha todos os pré-requisitos para a API de análise da Microsoft Store.
  • Obter um token de acesso do Azure AD para usar no cabeçalho da solicitação para este método. Depois de obter um token de acesso, você tem 60 minutos para usá-lo antes que ele expire. Depois que o token expirar, você poderá obter um novo.

Solicitar

Sintaxe da solicitação

Método Solicitar URI
OBTER https://manage.devcenter.microsoft.com/v1.0/my/analytics/failurehits

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Necessário. O token de acesso do Azure AD no formato portador<token>.

Parâmetros de solicitação

Parâmetro Tipo Descrição Necessário
applicationId string O ID da loja da aplicação para a qual deseja recuperar dados de relatório de erros. O ID da Loja está disponível na página Identidade do aplicativo no Partner Center. Um exemplo de ID da Loja é 9WZDNCRFJ3Q8. 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. O padrão é a data atual. Se o nível de agregação for dia, semanaou mês, esse parâmetro deverá especificar uma data no formato mm/dd/yyyy. Se nível de agregação for uma hora, este parâmetro poderá especificar uma data no formato mm/dd/yyyy ou uma data e hora no formato yyyy-mm-dd hh:mm:ss.

Nota: Este método só pode recuperar erros que ocorreram nos últimos 30 dias.
Não
Data de fim data A data final no intervalo de datas dos dados de relatório de erros a serem recuperados. O padrão é a data atual. Se agregaçãoLevel for dia, semanaou mês, esse parâmetro deverá especificar uma data no formato mm/dd/yyyy. Se agregaçãoLevel for hora, esse parâmetro poderá especificar uma data no formato mm/dd/yyyy ou uma data e hora no formato yyyy-mm-dd hh:mm:ss. Não
Início Int O número de linhas de dados a serem retornadas na solicitação. O valor máximo e o valor padrão, se não especificado, é 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 este 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
filtrar string Uma ou mais declarações que filtram as linhas na resposta. Cada instrução contém um nome de campo do corpo de resposta e um valor que estão associados aos operadores eq ou ne, e as instruções podem ser combinadas usando e ou ou. Os valores de strings devem ser rodeados por aspas simples no filtro do parâmetro. Você pode especificar os seguintes campos do corpo da resposta:

  • applicationName
  • nomeDoErro
  • failureHash
  • símbolo
  • osVersion
  • osRelease
  • TipoDeEvento
  • mercado
  • deviceType
  • packageName
  • versão do pacote
  • data
Não
nível de agregação cadeia de caracteres Especifica o intervalo de tempo para o qual recuperar dados agregados. Pode ser uma das seguintes cadeias de caracteres: hora, dia, semanaou mês. Se não for especificado, o padrão será dia. Se especificares semana ou mês, os valores failureName e failureHash serão limitados a mil buckets.

Nota: Se você especificar hora, poderá recuperar dados de erro somente das 72 horas anteriores. Para recuperar dados de erro com mais de 72 horas, especifique dia ou um dos outros níveis de agregação.
Não
ordenar por string Uma instrução que ordena os valores dos dados de resultado. A sintaxe é *orderby=field [order]. O campo e o parâmetro podem ser uma (e apenas uma) das seguintes strings:
  • applicationName
  • failureName
  • failureHash
  • símbolo
  • osVersion
  • osRelease
  • tipo de evento
  • mercado
  • tipo de dispositivo
  • packageName
  • packageVersion
  • data

O parâmetro de ordem é opcional e pode ser asc ou desc para especificar a ordem crescente ou decrescente para cada campo. O padrão é asc.

Aqui está um exemplo orderby string: orderby=date

Nota: Qualquer parâmetro deve ser da lista suportada por groupby.

Não
agrupar por string Uma instrução que aplica a agregação de dados somente aos campos especificados. Você pode especificar os seguintes campos:
  • failureName
  • failureHash
  • símbolo
  • osVersion
  • tipoDeEvento
  • mercado
  • tipo de dispositivo
  • packageName
  • versãoDoPacote

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

  • data
  • ID de aplicação
  • applicationName
  • contadorDeDispositivos
  • eventCount

O parâmetro groupby pode ser usado com o parâmetro aggregationLevel. Por exemplo: &agrupar por=nomeDeFalha,mercado&nívelDeAgregação=semana

Nota: Os parâmetros não podem conter duplicatas.
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 da Loja da sua aplicação.

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>

Resposta

Corpo de resposta

Valor Tipo Descrição
Valor matriz Uma matriz de objetos que contêm dados agregados de relatório de erros. Para obter mais informações sobre os dados em cada objeto, consulte a seção relativa aos valores de erro abaixo.
@nextLink string 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 superior da solicitação estiver definido como 10000, mas houver mais de 10000 linhas de erros para a consulta.
Contagem Total inteiro O número total de linhas no resultado de dados para a consulta.

Valores de erro

Os elementos na matriz Value contêm os seguintes valores.

Valor Tipo Descrição
data string A primeira data no intervalo de datas para os dados de erro, especificada 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 maior, esse valor será a primeira data nesse intervalo de datas. Para solicitações que especificam um valor aggregationLevel à hora, este valor também inclui um horário no formato hh:mm:ss.
applicationId string O ID da loja da app para a qual pretende recuperar dados de erro.
nome_do_aplicativo string O nome para exibição da aplicação.
nomeFalha cadeia de caracteres O nome da falha, que é composto por quatro partes: uma ou mais classes de problema, um código de verificação de exceção/bug, o nome da imagem onde a falha ocorreu e o nome da função associada.
failureHash string O identificador exclusivo do erro.
símbolo string O símbolo atribuído a este erro.
osVersão string Uma das seguintes cadeias de caracteres que especifica a versão do sistema operacional na qual o erro ocorreu:
  • Windows Phone 7.5
  • Windows Phone 8
  • Windows Phone 8.1
  • Windows Phone 10
  • Windows 8
  • Windows 8.1
  • Windows 10
  • Windows 11
  • Desconhecido
osLançamento string Uma das seguintes cadeias de caracteres que especifica a versão do sistema operativo ou o anel de distribuição (como uma subpopulação dentro da versão do sistema operativo) na qual o erro ocorreu.

Para Windows 11: versão 2110

Para o 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 Fast
  • Insider Slow

Para o Windows Server 1709:

  • RTM

Para o Windows Server 2016:

  • Versão 1607

Para o Windows 8.1:

  • Atualização 1

Para o Windows 7:

  • Service Pack 1

Se a versão do SO ou o anel de distribuição for desconhecido, este campo tem o valor Desconhecido.

tipo de evento string Uma das seguintes cadeias de caracteres:
  • falha
  • pendurar
  • memória
  • JSE
mercado string O código de país ISO 3166 do mercado de dispositivos.
Tipo de dispositivo string Uma das seguintes cadeias de caracteres que indica o tipo de dispositivo no qual o erro ocorreu:
  • PC
  • Telefone
  • Console-Xbox Um
  • Console-Xbox Série X
  • IoT
  • holográfica
  • Desconhecido
Nome do pacote string O nome exclusivo do pacote do aplicativo associado a esse erro.
packageVersion string A versão do pacote do aplicativo que está associada a esse erro.
deviceCount número O número de dispositivos únicos que correspondem a este erro para o nível de agregação especificado.
contagemDeEventos número O número de eventos atribuídos a esse erro para o nível de agregação especificado.

Observação

Este método só pode recuperar erros que ocorreram nos últimos 30 dias.

Exemplo de solicitação e resposta

O trecho de código a seguir demonstra uma solicitação de exemplo e um corpo de resposta JSON para essas solicitações.

Pedido de amostra

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>

Exemplo de resposta

{
    "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
}