Rapportquery's-API uitproberen

  • Artikel

Met deze API wordt een rapportquery-instructie uitgevoerd. De API retourneert slechts 100 records die u als partner kunt gebruiken om te controleren of de gegevens zijn zoals verwacht.

Belangrijk

Deze API heeft een time-out voor het uitvoeren van query's van 100 seconden. Als u merkt dat de API langer dan 100 seconden duurt, is de kans groot dat de query syntactisch correct is of dat u anders een andere foutcode dan 200 zou hebben ontvangen. De werkelijke rapportgeneratie wordt doorgegeven als de querysyntaxis juist is.

Aanvraagsyntaxis

Methode Aanvraag-URI
GET https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledQueries/testQueryResult?<exportQuery={querytext}\|queryId={queryId}>

Aanvraagheader

Koptekst Type Description
Autorisatie tekenreeks Vereist. Het Microsoft Entra-toegangstoken in het formulier Bearer <token>
Inhoudstype tekenreeks Application/JSON

Padparameter

Geen

Queryparameter

Parameternaam Type Vereist Beschrijving
exportQuery tekenreeks Nee Rapportquerytekenreeks die moet worden uitgevoerd
queryId tekenreeks Nee Een geldige bestaande query-id. Wederzijds exclusief met queryreeks die is opgegeven in de parameter exportQuery
Starttime tekenreeks Nee Begintijd van waaruit we de gegevens willen. Hiermee wordt de tijdsduur overschreven die is opgegeven in de query
Eindtijd tekenreeks Nee Eindtijd totdat we de gegevens willen. Hiermee wordt de tijdsduur overschreven die is opgegeven in de query

Nettolading aanvragen

Geen

Woordenlijst aanvragen

Geen

Respons

De nettolading van het antwoord is als volgt gestructureerd:

Antwoordcode: 200, 400, 401, 403, 404, 500

Voorbeeld van nettolading van antwoord:

Top 100 rows of query execution
{
  "Value": [
    {
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0,
}

Woordenlijst voor antwoorden

In deze tabel worden de belangrijkste elementen in het antwoord gedefinieerd:

Parameter Description
TotalCount Aantal gegevenssets in de waardematrix
Bericht Statusbericht van de uitvoering van de API
StatusCode Resultaatcode. De mogelijke waarden zijn 200, 400, 401, 403, 500