API подсчета данных [бета]

Описание	Вызов этой конечной точки путем предоставления типа подсчета данных и объекта полезной нагрузки запроса в строке JSON для получения данных подсчета в формате JSON.
Конечная точка	{CubeHostAddress}/API/v1/загрузка {CubeHostAddress}: https://cube.footfallcam.com (если вы используете локальное решение, обратитесь в службу поддержки FootfallCam по адресу хоста)
Способ доставки	POST
Заголовки	Авторизация: значение токена возвращается из API «Сгенерировать токен доступа» указав имя пользователя и пароль
Тело - пример JSON	{ "запрос": { "меры": [ "ИмяЭтогоКуба.FC01_SUM", "ИмяЭтогоКуба.FC01_AVG", "ИмяЭтогоКуба.FC02_SUM", "ИмяЭтогоКуба.FC02_AVG" ], "Размеры времени": [ { "dimension": "ИмяКуба.Время", "диапазон дат": [ "2021-10-01T10:00:00.000", «2021-10-31» ], "зернистость": "час" } ], "заказ": [ [ "ИмяЭтогоКуба.FC01_SUM", "desc" ] ], "фильтры": [ { "member": "ИмяЭтогоКуба.CompanyId", "оператор": "равно", "значения": [ "1001" ] }, { "member": "ИмяЭтогоКуба.BranchId", "оператор": "равно", "значения": [ "2001", "2001" ] }, { "member": "ИмяЭтогоКуба.ИмяВетки", "оператор": "равно", "значения": [ "Название ветки1", "ВетвьНазвание2" ] }, { "member": "ЭтоИмяКуба.AreaId", "оператор": "равно", "значения": [ "3001", "3002", "3003" ] } ], "Габаритные размеры": [ "ИмяЭтогоКуба.CompanyId", "ИмяЭтогоКуба.ИмяКомпании", "ИмяЭтогоКуба.ИдентификаторВетви", "ИмяЭтогоКуба.ИмяВетки", "ИмяЭтогоКуба.IdОбласти", "ИмяЭтогоКуба.ИмяОбласти" ], "лимит" : 50000 } }
Описание тела	Имя куба должно быть указано в полезной нагрузке, а его доступные поля зависят от выбранного куба. Пожалуйста, обратитесь список кубов для деталей куба запрос (объект): чтобы определить полезную нагрузку для данных запроса Меры (список строк): для определения списка кодов метрик и типа агрегации. timeDimensions (список объектов): содержит объект для определения параметров, связанных со временем. размер (строка): чтобы указать размер для применения параметров, связанных со временем. dateRange (список строк): чтобы указать время начала и окончания для запроса данных. Пример: "2021-10-01T10:00:00.000", "2021-10-31" granularity (string): для определения степени детализации данных по времени. Пример: минута, час, день, неделя, месяц, год порядок (список строк) : чтобы указать порядок данных. Каждый второстепенный список содержит имя поля для применения упорядочения и соответствующий тип упорядочения. Пример: ["ThisCubeName.FC01_SUM", "desc"] фильтры (список объектов): для определения фильтрации данных запроса. член (строка): чтобы указать измерение для применения фильтра. оператор (строка): для определения типа фильтра. Пример: равно, не равно, содержит, не содержит values (список строк): указать значение для фильтрации данных. размеры (список строк): чтобы указать измерение для отображения в данных результатов, аналогично оператору «Выбрать» в запросе SQL. limit (int, необязательный): чтобы указать максимальное количество записей возвращаемых данных. Значение по умолчанию будет 10000 (если не указано в полезной нагрузке), максимальное значение 50000.
Ответ 1 — пример JSON	{ "ошибка": "Продолжить ожидание", "сцена": { "stage": "Выполнение запроса", "прошедшее время": 5003 } }
Ответ 1 Описание	Ответ «Продолжить ожидание» просто указывает на то, что серверной части может потребоваться некоторое время для выполнения запроса и возврата результата. Это не связано с неудачным вызовом API, запрос выполняется на бэкэнде. Повторите попытку позже, и API вернет результат, как только серверная часть завершит выполнение запроса.
Ответ 2 — пример JSON	{ "запрос": {}, "данные": [ { "cube3.CompanyId": "18330", "cube3.CompanyName": "ДемоКомпания", "cube3.BranchId": "23097", "cube3.BranchName": "UKSite01", "cube3.AreaId": "-1", "cube3.ИмяОбласти": нуль, "cube3.Time.hour": "2022-01-15T11:00:00.000", "cube3.Time": "2022-01-15T11:00:00.000", "куб3.FC01_SUM": 200, "куб3.FC01_MAX": 180, "куб3.FC01_AVG": 100, "куб3.FC01_MIN": 20, "куб3.FC02_SUM": 188, "куб3.FC02_MAX": 171, "куб3.FC02_AVG": 94, "куб3.FC02_MIN": 17 }, { "cube3.CompanyId": "18330", "cube3.CompanyName": "ДемоКомпания", "cube3.BranchId": "23097", "cube3.BranchName": "UKSite01", "cube3.AreaId": "-1", "cube3.ИмяОбласти": нуль, "cube3.Time.hour": "2022-01-07T15:00:00.000", "cube3.Time": "2022-01-07T15:00:00.000", "куб3.FC01_SUM": 175, "куб3.FC01_MAX": 100, "куб3.FC01_AVG": 87.5, "куб3.FC01_MIN": 75, "куб3.FC02_SUM": 174, "куб3.FC02_MAX": 95, "куб3.FC02_AVG": 87, "куб3.FC02_MIN": 79 }, { "cube3.CompanyId": "18330", "cube3.CompanyName": "ДемоКомпания", "cube3.BranchId": "23097", "cube3.BranchName": "UKSite01", "cube3.AreaId": "-1", "cube3.ИмяОбласти": нуль, "cube3.Time.hour": "2022-01-15T13:00:00.000", "cube3.Time": "2022-01-15T13:00:00.000", "куб3.FC01_SUM": 171, "куб3.FC01_MAX": 151, "куб3.FC01_AVG": 85.5, "куб3.FC01_MIN": 20, "куб3.FC02_SUM": 166, "куб3.FC02_MAX": 146, "куб3.FC02_AVG": 83, "куб3.FC02_MIN": 20 } ], "lastRefreshTime": "2022-01-19T07:35:41.259Z", "обновитьКлючевые значения": [ [ { "refresh_key": "13688147" } ] ], "используемые преагрегаты": {}, "преобразованный запрос": {}, "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1", "аннотация": {}, "источник данных": "по умолчанию", "dbType": "престодб", "extDbType": "кубстор", "внешний": ложь, "медленный запрос": ложь }
Ответ 2 Описание	Результат подсчета данных будет в разделе «данные» в виде списка объектов, другая дополнительная информация может быть удалена в будущем.

Обновлено в феврале 22, 2023