Obter insights de dadosGet insights data

Uso desse método na API de análise de Microsoft Store para obter insights de dados relacionado a aquisições, integridade e métricas de uso para um aplicativo durante um determinado intervalo de datas e outros filtros opcionais.Use this method in the Microsoft Store analytics API to get insights data related to acquisitions, health, and usage metrics for an app during a given date range and other optional filters. Essas informações também estão disponíveis na relatório de Insights no Partner Center.This information is also available in the Insights report in Partner Center.

Pré-requisitosPrerequisites

Para usar este método, primeiro você precisa do seguinte:To use this method, you need to first do the following:

  • Se você não tiver feito isso, conclua todos os pré-requisitos para a API de análise da Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtenha um token de acesso do Azure AD a ser usado no cabeçalho da solicitação para este método.Obtain an Azure AD access token to use in the request header for this method. Depois de obter um token de acesso, você terá 60 minutos para usá-lo antes que ele expire.After you obtain an access token, you have 60 minutes to use it before it expires. Depois que o token expirar, você poderá obter um novo.After the token expires, you can obtain a new one.

SolicitaçãoRequest

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights

Cabeçalho da solicitaçãoRequest header

CabeçalhoHeader TipoType DescriçãoDescription
AutorizaçãoAuthorization cadeia de caracteresstring Obrigatório.Required. O token de acesso do AD do Azure no formato portador < token>.The Azure AD access token in the form Bearer <token>.

Parâmetros solicitadosRequest parameters

ParâmetroParameter TipoType DescriçãoDescription ObrigatórioRequired
applicationIdapplicationId cadeia de caracteresstring O Store ID do aplicativo para o qual você deseja recuperar os dados de insights.The Store ID of the app for which you want to retrieve insights data. Se você não especificar esse parâmetro, o corpo da resposta conterá dados para todos os aplicativos registrados para sua conta do insights.If you do not specify this parameter, the response body will contain insights data for all apps registered to your account. NãoNo
startDatestartDate datedate A data de início no intervalo de datas de dados do insights para recuperar.The start date in the date range of insights data to retrieve. O padrão é 30 dias antes da data atual.The default is 30 days before the current date. NãoNo
endDateendDate datedate A data final no intervalo de datas de dados do insights para recuperar.The end date in the date range of insights data to retrieve. O padrão é a data atual.The default is the current date. NãoNo
filterfilter cadeia de caracteresstring Uma ou mais instruções que filtram as linhas na resposta.One or more statements that filter the rows in the response. 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-se and ou or.Each statement contains a field name from the response body and value that are associated with the eq or ne operators, and statements can be combined using and or or. Valores de cadeia de caracteres devem estar entre aspas simples no parâmetro filter.String values must be surrounded by single quotes in the filter parameter. Por exemplo, filtro = eq 'aquisição de tipo de dados'.For example, filter=dataType eq 'acquisition'.

Você pode especificar os campos de filtro a seguir:You can specify the following filter fields:

  • Aquisiçãoacquisition
  • Integridadehealth
  • Usousage
NãoNo

Exemplo de solicitaçãoRequest example

O exemplo a seguir demonstra uma solicitação de obtenção de insights de dados.The following example demonstrates a request for getting insights data. Substitua o valor de applicationId pela ID da Loja de seu app.Replace the applicationId value with the Store ID for your app.

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>

RespostaResponse

Corpo da respostaResponse body

ValorValue TipoType DescriçãoDescription
ValorValue matrizarray Uma matriz de objetos que contêm dados de insights para o aplicativo.An array of objects that contain insights data for the app. Para obter mais informações sobre os dados em cada objeto, consulte a valores de Insight seção abaixo.For more information about the data in each object, see the Insight values section below.
TotalCountTotalCount intint O número total de linhas no resultado dos dados da consulta.The total number of rows in the data result for the query.

Valores de InsightInsight values

Os elementos na matriz Value contêm os valores a seguir.Elements in the Value array contain the following values.

ValorValue TipoType DescriçãoDescription
applicationIdapplicationId cadeia de caracteresstring A ID de Store do aplicativo para o qual você está recuperando dados do insights.The Store ID of the app for which you are retrieving insights data.
insightDateinsightDate cadeia de caracteresstring A data em que nós identificamos que a alteração em uma métrica específica.The date on which we identified the change in a specific metric. Essa data representa o fim da semana em que foi detectado um aumento significativo ou diminuir em uma métrica em comparação com a semana antes disso.This date represents the end of the week in which we detected a significant increase or decrease in a metric compared to the week before that.
Tipo de dadosdataType cadeia de caracteresstring Uma das seguintes cadeias de caracteres que especifica a área de análise geral que descreve esse insight:One of the following strings that specifies the general analytics area that this insight describes:

  • Aquisiçãoacquisition
  • Integridadehealth
  • Usousage
insightDetailinsightDetail matrizarray Um ou mais InsightDetail valores que representam os detalhes para o insight atual.One or more InsightDetail values that represent the details for current insight.

Valores de InsightDetailInsightDetail values

ValorValue TipoType DescriçãoDescription
FactNameFactName cadeia de caracteresstring Um dos valores a seguir que indica a métrica que descreve ao insight atual ou a dimensão atual, com base nas dataType valor.One of the following values that indicates the metric that the current insight or current dimension describes, based on the dataType value.
  • Para integridade, esse valor é sempre contagem de ocorrências.For health, this value is always HitCount.
  • Para aquisição, esse valor é sempre AcquisitionQuantity.For acquisition, this value is always AcquisitionQuantity.
  • Para uso, esse valor pode ser uma das seguintes cadeias de caracteres:For usage, this value can be one of the following strings:
    • dailyActiveUsersDailyActiveUsers
    • engagementDurationMinutesEngagementDurationMinutes
    • dailyActiveDevicesDailyActiveDevices
    • dailyNewUsersDailyNewUsers
    • dailySessionCountDailySessionCount
SubDimensionsSubDimensions matrizarray Um ou mais objetos que descrevem uma única métrica para o insight.One or more objects that describe a single metric for the insight.
PercentChangePercentChange cadeia de caracteresstring A porcentagem que a métrica alterou em sua base de todo o cliente.The percentage that the metric changed across your entire customer base.
DimensionNameDimensionName cadeia de caracteresstring O nome da métrica descrito na dimensão atual.The name of the metric described in the current dimension. Os exemplos incluem EventType, mercado, DeviceType, PackageVersion, AcquisitionType, Grupoetário e sexo.Examples include EventType, Market, DeviceType, PackageVersion, AcquisitionType, AgeGroup and Gender.
DimensionValueDimensionValue cadeia de caracteresstring O valor da métrica que é descrito na dimensão atual.The value of the metric that is described in the current dimension. Por exemplo, se DimensionName é EventType, DimensionValue pode ser falha ou travar .For example, if DimensionName is EventType, DimensionValue might be crash or hang.
FactValueFactValue cadeia de caracteresstring O valor absoluto da métrica na data em que a análise foi detectado.The absolute value of the metric on the date the insight was detected.
DireçãoDirection cadeia de caracteresstring A direção da alteração (positivo ou negativo).The direction of the change (Positive or Negative).
DataDate cadeia de caracteresstring A data em que nós identificamos que a alteração relacionada à percepção atual ou a dimensão atual.The date on which we identified the change related to the current insight or the current dimension.

Exemplo de respostaResponse example

O código a seguir demonstra um exemplo de corpo de resposta JSON para essa solicitação.The following example demonstrates an example JSON response body for this request.

{
  "Value": [
    {
      "applicationId": "9NBLGGGZ5QDR",
      "insightDate": "2018-06-03T00:00:00",
      "dataType": "health",
      "insightDetail": [
        {
          "FactName": "HitCount",
          "SubDimensions": [
            {
              "FactName:": "HitCount",
              "PercentChange": "21",
              "DimensionValue:": "DE",
              "FactValue": "109",
              "Direction": "Positive",
              "Date": "6/3/2018 12:00:00 AM",
              "DimensionName": "Market"
            }
          ],
          "DimensionValue": "crash",
          "Date": "6/3/2018 12:00:00 AM",
          "DimensionName": "EventType"
        },
        {
          "FactName": "HitCount",
          "SubDimensions": [
            {
              "FactName:": "HitCount",
              "PercentChange": "71",
              "DimensionValue:": "JP",
              "FactValue": "112",
              "Direction": "Positive",
              "Date": "6/3/2018 12:00:00 AM",
              "DimensionName": "Market"
            }
          ],
          "DimensionValue": "hang",
          "Date": "6/3/2018 12:00:00 AM",
          "DimensionName": "EventType"
        },
      ],
      "insightId": "9CY0F3VBT1AS942AFQaeyO0k2zUKfyOhrOHc0036Iwc="
    }
  ],
  "@nextLink": null,
  "TotalCount": 2
}