Uzyskiwanie interfejsu API zapytań dotyczących raportów dla komercyjnej platformy handlowej

Interfejs API Pobieranie zapytań raportów pobiera wszystkie zapytania, które są dostępne do użycia w raportach. Domyślnie pobiera wszystkie zapytania systemowe i zdefiniowane przez użytkownika.

Składnia żądania

Metoda	Identyfikator URI żądania
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

Nagłówek żądania

Nagłówek	Type	Opis
Autoryzacja	string	Wymagany. Token dostępu firmy Microsoft Entra w formularzu Bearer <token>
Typ zawartości	string	Application/JSON

Parametr ścieżki

Brak

Parametr zapytania

Nazwa parametru	Type	Wymagane	Opis
queryId	string	Nie	Filtruj, aby uzyskać szczegółowe informacje dotyczące tylko zapytań o identyfikatorze podanym w argumencie
queryName	string	Nie	Filtruj, aby uzyskać szczegółowe informacje o tylko zapytaniach o nazwie podanej w argumencie
IncludeSystemQueries	boolean	Nie.	Uwzględnij wstępnie zdefiniowane zapytania systemowe w odpowiedzi. Domyślna wartość to Prawda.
IncludeOnlySystemQueries	boolean	Nie.	Uwzględnij tylko zapytania systemowe w odpowiedzi. Wartość domyślna to Fałsz

Ładunek żądania

Brak

Słownik

Brak

Response

Ładunek odpowiedzi jest ustrukturyzowany w następujący sposób:

Kod odpowiedzi: 200, 400, 401, 403, 404, 500

Ładunek odpowiedzi:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Słownik

W tej tabeli opisano kluczowe definicje elementów w odpowiedzi.

Parametr	Opis
QueryId	Unikatowy identyfikator UUID zapytania
Name	Nazwa nadana kwerendzie w momencie tworzenia zapytania
Description	Opis podany podczas tworzenia zapytania
Query	Ciąg zapytania raportu
Type	Ustaw wartość na userDefined dla zapytań utworzonych przez użytkownika i system dla wstępnie zdefiniowanych zapytań systemowych
User	Identyfikator użytkownika, który utworzył zapytanie
CreatedTime	Czas tworzenia zapytania
TotalCount	Liczba zestawów danych w tablicy Value
StatusCode	Kod wyniku. Możliwe wartości to 200, 400, 401, 403, 500