Partilhar via

Obter dados de insights

  • Artigo

Use esse método na API de análise da Microsoft Store para obter dados de insights relacionados a aquisições, integridade e métricas de uso de um aplicativo durante um determinado intervalo de datas e outros filtros opcionais. Essas informações também estão disponíveis no relatório Insights no Partner Center.

Pré-requisitos

Para usar este 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. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.

Solicitar

Sintaxe da solicitação

Método URI da solicitação
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.

Parâmetros da solicitação

Parâmetro Tipo Descrição Obrigatório
applicationId string A ID da Loja do aplicativo para o qual você deseja recuperar dados de insights. Se você não especificar esse parâmetro, o corpo da resposta conterá dados de insights para todos os aplicativos registrados em sua conta. Não
startDate date A data de início no intervalo de datas dos dados do insights a serem recuperados. O padrão é 30 dias antes da data atual. Não
endDate date A data de término no intervalo de datas dos dados do insights a serem recuperados. O padrão é a data atual. Não
filtro string Uma ou mais instruções que filtram as linhas na 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 sequência devem estar entre aspas simples no parâmetro filter. Por exemplo, filter=dataType eq 'acquisition'.

Você pode especificar os seguintes campos de filtro:

  • aquisição
  • Saúde
  • usage
 Sim

Exemplo de solicitação

O exemplo a seguir demonstra uma solicitação para obter dados de insights. Substitua o valor applicationId pela ID da Store para seu aplicativo.

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=6/1/2018&endDate=6/15/2018&filter=dataType eq 'acquisition' or dataType eq 'health' HTTP/1.1
Authorization: Bearer <your access token>

Resposta

Corpo da resposta

Valor Type Descrição
Valor matriz Uma matriz de objetos que contêm dados de insights para o aplicativo. Para obter mais informações sobre os dados em cada objeto, consulte a seção Valores do Insight abaixo.
TotalCount int O número total de linhas no resultado de dados da consulta.

Valores do Insight

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

Valor Type Descrição
applicationId string A ID da Loja do aplicativo para o qual você está recuperando dados de insights.
Data de insight string A data em que identificamos a mudança em uma métrica específica. Essa data representa o final da semana em que detectamos um aumento ou diminuição significativa em uma métrica em comparação com a semana anterior.
dataType string Uma das seguintes cadeias de caracteres que especifica a área de análise geral descrita por esse insight:

  • aquisição
  • Saúde
  • usage
insightDetalhe matriz Um ou mais valores InsightDetail que representam os detalhes do insight atual.

Valores InsightDetail

Valor Type Descrição
Nome do Fato string Um dos valores a seguir que indica a métrica que o insight atual ou a dimensão atual descreve, com base no valor dataType .
  • Para integridade, esse valor é sempre HitCount.
  • Para aquisição, esse valor é sempre AcquisitionQuantity.
  • Para uso, esse valor pode ser uma das seguintes cadeias de caracteres:
    • Usuários ativos diários
    • DuraçãoDeEngajamentoMinutos
    • Dispositivos ativos diários
    • DailyNewUsers
    • Contagem de Sessões Diárias
Subdimensões matriz Um ou mais objetos que descrevem uma única métrica para o insight.
Variação percentual string A porcentagem em que a métrica mudou em toda a sua base de clientes.
DimensionName string O nome da métrica descrita na dimensão atual. Os exemplos incluem EventType, Market, DeviceType, PackageVersion, AcquisitionType, AgeGroup e Gender.
DimensionValue string O valor da métrica descrita na dimensão atual. Por exemplo, se DimensionName for EventType, DimensionValue poderá falhar ou travar.
Valor de fato string O valor absoluto da métrica na data em que o insight foi detectado.
Direção string A direção da mudança (Positiva ou Negativa).
Data string A data em que identificamos a mudança relacionada ao insight atual ou à dimensão atual.

Observação

As alterações do Insights recuperadas serão apenas para os últimos 30 dias de dados de aquisição, integridade e/ou uso.

Exemplo de solicitação e resposta

Os snippets de código a seguir demonstram alguns exemplos de solicitações e o corpo da resposta JSON para estas solicitações.

Solicitação de Exemplo

GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights?applicationId=9NBLGGGZ5QDR&startDate=7/12/2022&endDate=7/29/2022&filter=dataType eq 'acquisition' or dataType eq 'health'
HTTP/1.1
Authorization: Bearer <your access token>

Resposta de exemplo

{
    "Value": [
        {
            "id": "8cdb672c7893bd33a3dec48ededdc676602a1361f3209ab4f3e0982672fc198f",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-27T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-27 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "DeviceType",
                            "DimensionValue": "Tablet",
                            "Date": "2022-07-27 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 16.091954022988507,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 28.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "6b8849ecb043c6e5ecdd1c20040c0a371e9ab176eff77f7312b0489e19379225",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-26T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-26 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "DeviceType",
                            "DimensionValue": "Tablet",
                            "Date": "2022-07-26 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 28.048780487804876,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 30.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "93115e855fec507385bab17251f49c33bcbc1b62c603e5c7863e327ba94bf160",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-20T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-20 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "GB",
                            "Date": "2022-07-20 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 3.3035714285714284,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 158.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "4814abe710042a2798b453d8821909c246c389dde814e6678da7189211410604",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-24T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-24 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "DO",
                            "Date": "2022-07-24 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 13.533834586466165,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 8.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "7941070bb17904f3ef4e19de9659110cb52e18ecfb637ad724e2da749445a860",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-21T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-21 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "AT",
                            "Date": "2022-07-21 00:00:00",
                            "Direction": "Positive",
                            "PercentChange": 0.0,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 17.0
                        }
                    ]
                },
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-21 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "SE",
                            "Date": "2022-07-21 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 21.686746987951807,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 5.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "55905f5458617b65669eb115cc28ebd7296841bd2ff3f8e2546ade1d5e93f68d",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-13T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "AcquisitionType",
                    "DimensionValue": "Free",
                    "Date": "2022-07-13 00:00:00",
                    "FactName": "AcquisitionQuantity",
                    "SubDimensions": [
                        {
                            "DimensionName": "Market",
                            "DimensionValue": "LK",
                            "Date": "2022-07-13 00:00:00",
                            "Direction": "Negative",
                            "PercentChange": 11.111111111111111,
                            "FactName": "AcquisitionQuantity",
                            "FactQuantity": 9.0
                        }
                    ]
                }
            ]
        },
        {
            "id": "9ce9317bf4d0f903de51a49d00a07cf4b4a8ac4457fd1e2886493bd38ceac0b7",
            "applicationId": "9NBLGGGZ5QDR",
            "insightDate": "2022-07-19T00:00:00",
            "dataType": "acquisition",
            "insightDetail": [
                {
                    "DimensionName": "Acquisition",
                    "DimensionValue": "Free",
                    "Date": "2022-07-19 00:00:00",
                    "Direction": "Negative",
                    "PercentChange": 12.188725230475788,
                    "FactName": "AcquisitionQuantity",
                    "FactQuantity": 2470,
                    "SubDimensions": []
                }
            ]
        }
    ],
    "TotalCount": 7
}