Obtenir des données d’insights

Utilisez cette méthode dans l’API d’analyse du Microsoft Store pour obtenir des données d’insights sur les acquisitions, l’intégrité et les métriques d’utilisation d’une application pendant une plage de dates donnée et d’autres filtres facultatifs. Ces informations sont également disponibles dans le rapport Insights de l’Espace partenaires.

Prérequis

Pour utiliser cette méthode, vous devez d’abord effectuer les opérations suivantes :

  • Si vous ne l’avez pas déjà fait, remplissez toutes les conditions préalables pour l’API d’analyse du Microsoft Store.
  • Obtenez un jeton d’accès Azure AD à utiliser dans l’en-tête de requête de cette méthode. Une fois que vous avez récupéré le jeton d’accès, vous avez 60 minutes pour l’utiliser avant qu’il n’expire. Une fois le jeton arrivé à expiration, vous pouvez en obtenir un nouveau.

Requête

Syntaxe de la requête

Méthode URI de demande
GET https://manage.devcenter.microsoft.com/v1.0/my/analytics/insights

En-tête de requête

En-tête Type Description
Autorisation string Obligatoire. Jeton d’accès Azure AD sous la formeJeton> du porteur<.

Paramètres de la demande

Paramètre Type Description Obligatoire
applicationId string ID store de l’application pour laquelle vous souhaitez récupérer des données d’insights. Si vous ne spécifiez pas ce paramètre, le corps de la réponse contient des données d’insights pour toutes les applications inscrites sur votre compte. Non
startDate Date Date de début dans la plage de dates des données d’insights à récupérer. La valeur par défaut est de 30 jours avant la date actuelle. Non
endDate Date Date de fin dans la plage de dates des données d’insights à récupérer. La valeur par défaut est la date actuelle. Non
filter string Une ou plusieurs instructions qui filtrent les lignes de la réponse. Chaque instruction contient un nom de champ à partir du corps de la réponse et de la valeur associés aux opérateurs eq ou ne, et les instructions peuvent être combinées à l’aide de et ou . Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter. Par exemple, filter=dataType eq 'acquisition'.

Vous pouvez spécifier les champs de filtre suivants :

  • Achat
  • Santé
  • Utilisation
Oui

Exemple de requête

L’exemple suivant illustre une demande d’obtention de données d’insights. Remplacez la valeur applicationId par l’ID Windows Store de votre application.

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>

response

Response body

Valeur Type Description
Valeur tableau Tableau d’objets qui contiennent des données d’insights pour l’application. Pour plus d’informations sur les données de chaque objet, consultez la section Valeurs d’insight ci-dessous.
TotalCount int Nombre total de lignes dans les résultats de la requête.

Valeurs d’insight

Les éléments du tableau Value comportent les valeurs suivantes :

Valeur Type Description
applicationId string ID store de l’application pour laquelle vous récupérez des données d’insights.
insightDate string Date à laquelle nous avons identifié le changement dans une métrique spécifique. Cette date représente la fin de la semaine au cours de laquelle nous avons détecté une augmentation ou une diminution significative d’une métrique par rapport à la semaine précédente.
dataType string L’une des chaînes suivantes qui spécifie la zone d’analyse générale décrite par cet insight :

  • Achat
  • Santé
  • Utilisation
insightDetail tableau Une ou plusieurs valeurs InsightDetail qui représentent les détails de l’insight actuel.

Valeurs InsightDetail

Valeur Type Description
FactName string Une des valeurs suivantes qui indique la métrique décrite par l’insight actuel ou la dimension actuelle, en fonction de la valeur dataType .
  • Pour l’intégrité, cette valeur est toujours HitCount.
  • Pour l’acquisition, cette valeur est toujours AcquisitionQuantity.
  • Pour l’utilisation, cette valeur peut être l’une des chaînes suivantes :
    • DailyActiveUsers
    • EngagementDurationMinutes
    • DailyActiveDevices
    • DailyNewUsers
    • DailySessionCount
Sous-dimensions tableau Un ou plusieurs objets qui décrivent une seule métrique pour l’insight.
PercentChange string Pourcentage que la métrique a changé sur l’ensemble de votre base de clients.
DimensionName string Nom de la métrique décrite dans la dimension actuelle. Les exemples incluent EventType, Market, DeviceType, PackageVersion, AcquisitionType, AgeGroup et Gender.
DimensionValue string Valeur de la métrique décrite dans la dimension actuelle. Par exemple, si DimensionName est EventType, DimensionValue peut se bloquer ou se bloquer.
FactValue string Valeur absolue de la métrique à la date à laquelle l’insight a été détecté.
Sens string Direction du changement (positif ou négatif).
Date string Date à laquelle nous avons identifié la modification liée à l’insight actuel ou à la dimension actuelle.

Notes

Les modifications d’Insights récupérées ne concernent que les 30 derniers jours d’acquisitions, de données d’intégrité et/ou d’utilisation.

Exemple de requête et de réponse

Les extraits de code suivants illustrent quelques exemples de requête et de corps de réponse JSON pour ces demandes.

Exemple de demande

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>

Exemple de réponse

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