Obtener datos de insightsGet insights data

Use este método en la API de análisis de Microsoft Store para obtener información relacionada con las adquisiciones, mantenimiento y métricas de uso para una aplicación durante un intervalo de fechas determinado y los demás filtros opcionales.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. Esta información también está disponible en el informe Insights en el centro de partners.This information is also available in the Insights report in Partner Center.

Requisitos previosPrerequisites

Para usar este método, primero debes hacer lo siguiente:To use this method, you need to first do the following:

  • Si aún no lo has hecho, completa todos los requisitos previos para la API de análisis de Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store analytics API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud de este método.Obtain an Azure AD access token to use in the request header for this method. Después de obtener un token de acceso, tienes 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Sintaxis de la solicitudRequest syntax

MétodoMethod URI de la solicitudRequest URI
GETGET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights

Encabezado de la solicitudRequest header

EncabezadoHeader TipoType DescripciónDescription
AutorizaciónAuthorization stringstring Obligatorio.Required. El token de acceso de Azure AD en el formulario portador < token>.The Azure AD access token in the form Bearer <token>.

Parámetros de solicitudRequest parameters

ParámetroParameter TipoType DescripciónDescription RequeridoRequired
applicationIdapplicationId stringstring El Store ID de la aplicación para el que desea recuperar datos de insights.The Store ID of the app for which you want to retrieve insights data. Si no especifica este parámetro, el cuerpo de respuesta contendrá datos de información para todas las aplicaciones registradas en su cuenta.If you do not specify this parameter, the response body will contain insights data for all apps registered to your account. NoNo
startDatestartDate fechadate La fecha de inicio del intervalo de fechas de datos de insights para recuperar.The start date in the date range of insights data to retrieve. El valor predeterminado es 30 días antes de la fecha actual.The default is 30 days before the current date. NoNo
endDateendDate fechadate La fecha de finalización del intervalo de fechas de datos de insights para recuperar.The end date in the date range of insights data to retrieve. El valor predeterminado es la fecha actual.The default is the current date. NoNo
filterfilter stringstring Una o más instrucciones que filtran las filas de la respuesta.One or more statements that filter the rows in the response. Cada instrucción contiene un nombre de campo del cuerpo de la respuesta y un valor asociados a los operadores eq o ne; asimismo, puedes combinar las instrucciones mediante and u 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. Ten en cuenta que en el parámetro filter los valores de la cadena deben estar entre comillas simples.String values must be surrounded by single quotes in the filter parameter. Por ejemplo, Filtro = tipo de datos eq 'adquisición'.For example, filter=dataType eq 'acquisition'.

Puede especificar los campos de filtro siguientes:You can specify the following filter fields:

  • Adquisiciónacquisition
  • Estadohealth
  • Uso deusage
NoNo

Ejemplo de solicitudRequest example

El ejemplo siguiente muestra una solicitud de obtención de datos de insights.The following example demonstrates a request for getting insights data. Sustituye el valor applicationId por el id. de la Tienda de la aplicación.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>

RespuestaResponse

Cuerpo de la respuestaResponse body

ValorValue TipoType DescripciónDescription
ValorValue arrayarray Una matriz de objetos que contienen datos de información de la aplicación.An array of objects that contain insights data for the app. Para obtener más información acerca de los datos de cada objeto, vea el valores Insight sección más adelante.For more information about the data in each object, see the Insight values section below.
TotalCountTotalCount enteroint El número total de filas del resultado de datos de la consulta.The total number of rows in the data result for the query.

Valores de informaciónInsight values

Los elementos de la matriz Value contienen los siguientes valores.Elements in the Value array contain the following values.

ValorValue TipoType DescripciónDescription
applicationIdapplicationId stringstring El identificador de Store de la aplicación para el que va a recuperar datos de insights.The Store ID of the app for which you are retrieving insights data.
insightDateinsightDate stringstring La fecha en la que hemos identificado que el cambio en una métrica específica.The date on which we identified the change in a specific metric. Esta fecha representa el final de la semana en que se detectó un aumento significativo o disminuir en una métrica en comparación con la semana anterior a éste.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 datosdataType stringstring Una de las siguientes cadenas que especifica el área de análisis general que describe esta información:One of the following strings that specifies the general analytics area that this insight describes:

  • Adquisiciónacquisition
  • Estadohealth
  • Uso deusage
insightDetailinsightDetail arrayarray Uno o varios InsightDetail valores que representan los detalles para obtener información actual.One or more InsightDetail values that represent the details for current insight.

Valores de InsightDetailInsightDetail values

ValorValue TipoType DescripciónDescription
FactNameFactName stringstring Uno de los siguientes valores que indica la métrica que describe la información actual o la dimensión actual, según la 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 mantenimiento, este valor es siempre HitCount.For health, this value is always HitCount.
  • Para adquisición, este valor es siempre cantidad de adquisición.For acquisition, this value is always AcquisitionQuantity.
  • Para uso, este valor puede ser una de las siguientes cadenas:For usage, this value can be one of the following strings:
    • dailyActiveUsersDailyActiveUsers
    • engagementDurationMinutesEngagementDurationMinutes
    • dailyActiveDevicesDailyActiveDevices
    • dailyNewUsersDailyNewUsers
    • dailySessionCountDailySessionCount
SubDimensionsSubDimensions arrayarray Uno o más objetos que describen una sola métrica para la perspectiva.One or more objects that describe a single metric for the insight.
CambioPorcentualPercentChange stringstring El porcentaje que ha cambiado la métrica a través de la base de clientes todo.The percentage that the metric changed across your entire customer base.
DimensionNameDimensionName stringstring El nombre de la métrica que se describe en la dimensión actual.The name of the metric described in the current dimension. Algunos ejemplos son EventType, mercado, DeviceType, PackageVersion, AcquisitionType, Grupo de edad y sexo.Examples include EventType, Market, DeviceType, PackageVersion, AcquisitionType, AgeGroup and Gender.
DimensionValueDimensionValue stringstring El valor de la métrica que se describe en la dimensión actual.The value of the metric that is described in the current dimension. Por ejemplo, si DimensionName es EventType, DimensionValue podría ser bloqueo o bloqueo .For example, if DimensionName is EventType, DimensionValue might be crash or hang.
FactValueFactValue stringstring El valor absoluto de la métrica en la fecha en que se ha detectado la recomendación.The absolute value of the metric on the date the insight was detected.
DirecciónDirection stringstring La dirección del cambio (positivo o negativo).The direction of the change (Positive or Negative).
FechaDate stringstring La fecha en la que hemos identificado que el cambio relacionado con la información actual o la dimensión actual.The date on which we identified the change related to the current insight or the current dimension.

Ejemplo de respuestaResponse example

En el ejemplo siguiente se muestra el cuerpo de una respuesta JSON de ejemplo realizada para esta solicitud.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
}