Udostępnij za pośrednictwem


Uzyskiwanie wszystkich interfejsów API zestawów danych dla komercyjnej platformy handlowej

Interfejs API Pobierz wszystkie zestawy danych pobiera wszystkie dostępne zestawy danych. Zestawy danych zawierają listę tabel, kolumn, metryk i zakresów czasu.

Składnia żądania

Metoda Identyfikator URI żądania
GET https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledDataset?datasetName={Dataset Name}

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
datasetName string Nie Filtruj, aby uzyskać szczegółowe informacje tylko o jednym zestawie danych

Ł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

Przykład ładunku odpowiedzi:

{
   "Value":[
      {
         "DatasetName ":"string",
         "SelectableColumns":[
            "string"
         ],
         "AvailableMetrics":[
            "string"
         ],
         "AvailableDateRanges ":[
            "string"
         ]
      }
   ],
   "TotalCount":int,
   "Message":"<Error Message>",
   "StatusCode": int
}

Słownik

W tej tabeli zdefiniowano kluczowe elementy odpowiedzi:

Parametr Opis
DatasetName Nazwa zestawu danych, który definiuje ten obiekt tablicy
SelectableColumns Nieprzetworzone kolumny, które można określić w wybranych kolumnach
AvailableMetrics Nazwy kolumn agregacji/metryk, które można określić w wybranych kolumnach
AvailableDateRanges Zakres dat, który może być używany w zapytaniach raportu dla zestawu danych
NextLink Łącze do następnej strony, jeśli dane są podzielone na strony
TotalCount Liczba zestawów danych w tablicy Value
StatusCode Kod wyniku. Możliwe wartości to 200, 400, 401, 403, 500