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

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

  • Статья

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

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

Метод URI запроса
ПОЛУЧИТЬ https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledDataset?datasetName={Dataset Name}

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

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

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

Нет

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

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

Пейлоад запроса

Никакой

глоссарий

Нет

Ответ

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

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

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

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

глоссарий

Эта таблица определяет ключевые элементы в ответе:

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