Obtenir l’analytique des abonnements groupée par dates ou conditions

Article
06/19/2023

S’applique à : Espace partenaires | Espace partenaires géré par 21Vianet | Espace partenaires de Microsoft Cloud for US Government

Comment obtenir des informations d’analyse d’abonnement pour vos clients regroupés par dates ou conditions.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification de l’utilisateur uniquement.

Demande REST

Syntaxe de la requête

Méthode	URI de requête
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Paramètres URI

Utilisez les paramètres de chemin d’accès requis suivants pour identifier votre organization et regrouper les résultats.

Nom	Type	Obligatoire	Description
groupby_queries	paires de chaînes et dateTime	Oui	Termes et dates pour filtrer le résultat.

Syntaxe GroupBy

Le groupe par paramètre doit être composé sous la forme d’une série de valeurs de champ séparées par des virgules.

Voici un exemple d’encodage :

?groupby=termField1,dateField1,termField2

Le tableau suivant montre la liste des champs pris en charge pour group by.

Champ	Type	Description
customerTenantId	chaîne	Chaîne au format GUID qui identifie le client client.
customerName	string	Nom du client.
customerMarket	chaîne	Pays/région dans lequel le client fait affaire.
id	string	Chaîne au format GUID qui identifie l’abonnement.
status	string	État de l'abonnement. Les valeurs prises en charge sont : « ACTIVE », « SUSPENDED » ou « DEPROVISIONED ».
ProductName	chaîne	Nom du produit.
subscriptionType	chaîne	Type d’abonnement. Remarque : ce champ respecte la casse. Les valeurs prises en charge sont : « Office », « Azure », « Microsoft365 », « Dynamics », « EMS ».
autoRenewEnabled	Boolean	Valeur indiquant si l’abonnement est renouvelé automatiquement.
partnerId	chaîne	The PartnerID. Pour un revendeur direct, ce paramètre sera l’ID de partenaire du partenaire. Pour un revendeur indirect, ce paramètre sera l’ID de partenaire du revendeur indirect.
friendlyName	string	Nom de l'abonnement.
partnerName	chaîne	Nom du partenaire pour lequel l’abonnement a été acheté
providerName	chaîne	Lorsque la transaction d’abonnement concerne le revendeur indirect, le nom du fournisseur est le fournisseur indirect qui a acheté l’abonnement.
creationDate	Chaîne au format date/heure UTC	Date de création de l’abonnement.
effectiveStartDate	Chaîne au format date/heure UTC	Date de démarrage de l’abonnement.
commitmentEndDate	Chaîne au format date/heure UTC	Date de fin de l’abonnement.
currentStateEndDate	Chaîne au format date/heure UTC	Date à laquelle le status actuel de l’abonnement va changer.
trialToPaidConversionDate	Chaîne au format date/heure UTC	Date à laquelle l’abonnement passe de la version d’évaluation à payante. La valeur par défaut est null.
trialStartDate	Chaîne au format date/heure UTC	Date à laquelle la période d’évaluation de l’abonnement a démarré. La valeur par défaut est null.
lastUsageDate	Chaîne au format date/heure UTC	Date de la dernière utilisation de l’abonnement. La valeur par défaut est null.
deprovisionedDate	Chaîne au format date/heure UTC	Date à laquelle l’abonnement a été déprovisionné. La valeur par défaut est null.
lastRenewalDate	Chaîne au format date/heure UTC	Date du dernier renouvellement de l’abonnement. La valeur par défaut est null.

Champs de filtrage

Le tableau suivant répertorie les champs de filtre facultatifs et leurs descriptions :

Champ	Type	Description
top	int	Le nombre de lignes de données à renvoyer dans la requête. Si la valeur n’est pas spécifiée, la valeur maximale et la valeur par défaut sont 10000. Si la requête comporte davantage de lignes, le corps de la réponse inclut un lien sur lequel vous cliquez pour solliciter la page suivante de données.
skip	int	Le nombre de lignes à ignorer dans la requête. Utilisez ce paramètre pour parcourir de grands ensembles de données. Par exemple, top=10000 et skip=0 récupèrent les 10 000 premières lignes de données, top=10000 et skip=100000 récupèrent les 10000 lignes de données suivantes.
filter	chaîne	Une ou plusieurs instructions qui filtrent les lignes de la réponse. Chaque instruction de filtre contient un nom de champ du corps de la réponse et une valeur associée à l’opérateur `eq`, `ne`ou pour certains champs.`contains` Les instructions peuvent être combinées à l’aide de `and` ou `or`. Les valeurs de chaîne doivent être entourées par des guillemets dans le paramètre filter. Consultez la section suivante pour obtenir la liste des champs qui peuvent être filtrés et les opérateurs pris en charge avec ces champs.
aggregationLevel	chaîne	Indique la plage de temps pendant laquelle récupérer les données agrégées. Il peut s’agit des chaînes suivantes : day, week ou month. Si la valeur n’est pas spécifiée, la valeur par défaut est dateRange. Remarque : ce paramètre s’applique uniquement lorsqu’un champ de date est passé dans le cadre du paramètre groupBy.
Groupby	chaîne	Une instruction qui applique l’agrégation des données uniquement sur les champs spécifiés.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de demande

Aucun.

Exemple de requête

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0

Réponse REST

En cas de réussite, le corps de la réponse contient une collection de ressources d’abonnement regroupées selon les conditions et dates spécifiées.

Codes d’erreur et de réussite de la réponse

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur.

Exemple de réponse

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

Voir aussi

Analytique de l’Espace partenaires - Ressources

Partager via