Поделиться через

Получение всех API наборов данных для коммерческой платформы

  • Статья

API получения всех наборов данных возвращает полный список доступных наборов данных. Список наборов данных содержит таблицы, столбцы, метрики и диапазоны времени.

Синтаксис запроса

Method URI запроса
GET https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledDataset?datasetName={Dataset Name}

Заголовок запроса

Верхний колонтитул Тип Description
Авторизация строка Обязательный. Маркер доступа Microsoft Entra в форме Bearer <token>
Тип контента строка Application/JSON

Параметр пути

нет

Параметр запроса

Имя параметра Тип Обязательное поле Description
datasetName строка Нет Фильтр для получения сведений только об одном наборе данных

Полезные данные запроса

нет

Словарь терминов

нет

Response

Полезные данные ответа имеют следующий формат:

Код ответа: 200, 400, 401, 403, 404, 500

Пример полезных данных ответа:

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

Словарь терминов

В следующей таблице описаны ключевые элементы ответа.

Параметр Description
DatasetName Имя набора данных, определяемого этим объектом массива.
SelectableColumns Необработанные столбцы, которые можно указать в операции SELECT COLUMNS.
AvailableMetrics Имена столбцов агрегирования и метрик, которые можно указать в операции SELECT COLUMNS.
AvailableDateRanges Диапазон дат, который можно использовать в запросах отчета для набора данных.
NextLink Ссылка на следующую страницу, если данные разбиваются на страницы.
TotalCount Число наборов данных в массиве Value.
StatusCode Код результата. Возможные значения — 200, 400, 401, 403, 500