Udostępnij za pośrednictwem

Uzyskiwanie wszystkich zestawów danych za pośrednictwem API dla komercyjnej platformy handlowej

  • Artykuł

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

Składnia żądania

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

Nagłówek żądania

nagłówka Typ Opis
Autoryzacja struna Wymagane. Token dostępu firmy Microsoft Entra w postaci Bearer <token>
Typ zawartości struna Application/JSON

parametr ścieżki

Żaden

parametr zapytania

nazwa parametru typu wymagane Opis
datasetName struna Nie Filtruj, aby uzyskać szczegółowe informacje tylko o jednym zestawie danych

Treść żądania

Żaden

Słownik

Żaden

Odpowiedź

Ł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:

parametru 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