Дашборд¶

/api/dashboard методы.

`DELETE /api/dashboard/:dashboard-id/public_link`¶

Удалить публичную ссылку на этот дашборд.

Параметры:¶

dashboard-id целое число больше нуля.

`DELETE /api/dashboard/:id`¶

Удалить дашборд. Эта операция также удалит любые вопросы/модели/сегменты/метрики, которые используют эту базу данных.

Параметры:¶

id целое число больше нуля.

`GET /api/dashboard/`¶

Получить Dashboards. С фильтром f (по умолчанию all), ограничивает результаты следующим образом:

all - возвращает все дашборды.
mine - возвращает дашборды, созданные данным пользователем.
archived - возвращаем дашборды, которые были заархивированы. (По умолчанию, эти исключены.).

Параметры:¶

f значение должно быть пустым, или если не пустое, значение должно быть одним из: all, archived, mine.

`GET /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute`¶

Получает значения для заполнения параметров исполнения.

Параметры:¶

dashboard-id целое число больше нуля.
dashcard-id целое число больше нуля.
parameters валидная JSON-строка.

`GET /api/dashboard/:id`¶

Получает дашборд по ID.

Параметры:¶

id целое число больше нуля.

`GET /api/dashboard/:id/params/:param-key/search/:query`¶

Получает возможные значения параметра, ID которого является :param-key содержащий :query. Если значения приходят напрямую из запроса, то опционально ограничивает такие значения, передавая параметры запроса как other-parameter=value, например

;; получить значения дашборда 1 параметр 'abc' который содержит 'Cam' и возможно когда установлен параметр 'def'
;; до 100
 GET /api/dashboard/1/params/abc/search/Cam?def=100

Возвращает первые 1000 значений

Параметры:¶

id целое число больше нуля.
param-key
query
query-params

`GET /api/dashboard/:id/params/:param-key/values`¶

Получить возможные параметры ID которых заданы в :param-key. Опционально ограничивает такие значения, передавая такие параметры запроса, как other-parameter=value, например

;; получить значение параметра 'abc' дашборда 1, которые возможны в том случае, когда параметр 'def' установлен равным 1000
GET /api/dashboard/1/params/abc/values?def=100.

Параметры:¶

id целое число больше нуля.
param-key
query-Параметры

`GET /api/dashboard/:id/revisions`¶

Получить Revisions для дашбордов с ID.

Параметры:¶

id целое число больше нуля.

`GET /api/dashboard/embeddable`¶

Получить список дашбордов, где enable_embedding является true. Дашборды могут быть встроены, используя метод встраивания и подписанный JWT-токен.

`GET /api/dashboard/params/valid-filter-fields`¶

Служебный метод для управления пользовательским интерфейсом дашборда. Допустим, у нас есть набор отфильтрованных элементов Field IDs (предположительно, это могут быть, например, Fields используемые в параметрах) и набор отфильтрованных Field IDs, которые будут использованы для ограничения значений, отфильтрованных Fields. Для каждого отфильтрованного Field ID возвращает подмножество отфильтрованных Field IDs, которые могут быть использованы в связанном запросе фильтра с данными полями.

Пример в связанном запросе фильтра:

GET /api/dashboard/10/params/PARAM_1/values?PARAM_2=100

Предположим, PARAM_1 отвечает Field 1 и PARAM_2 отвечает Fields 2 и 3. Базовый MBQL запрос может либо отфильтровывать, либо не отфильтровывать по значениям Fields 2 и 3, в зависимости от того, есть ли отношение FK, которое устанавливает связь с Field 1. Вы можете использовать этот метод для определения, какое из этих полей (Fields) используется в настоящее время:

GET /api/dashboard/params/valid-filter-fields?filtered=1&filtering=2&filtering=3
;; ->
{1 [2 3]}

Результаты будут возвращены в качестве карты:

`filtered` Field ID -> подмножество `отфильтрованных` Field ID которое может быть использовано для связанных запросов фильтра.

Параметры:¶

filtered должно удовлетворять одному из следующих требований: 1) значение должно быть целым больше нуля. 2) значение должно быть массивом. Каждое значение должно быть целым больше нуля. Массив не может быть пустым
filtering значение должно быть пустым, или если не пустое, должно удовлетворять одному из следующих требований: 1) значение должно быть целым больше нуля. 2) значение должно быть массивом. Каждое значение должно быть целым больше нуля. Массив не может быть пустым

`GET /api/dashboard/public`¶

Получить список дашбордов с публичными UUIDs. Эти дашборды доступны, если включен общий доступ.

`POST /api/dashboard/`¶

Создать новый дашборд.

Параметры:¶

name непустая строка.
description строка, может быть null.
parameters null или массив, каждый элемент которого - карта с ключами :id и :type.
cache_ttl целое число больше нуля, может быть пустым.
collection_id целое число больше нуля, может быть пустым.
collection_position целое число больше нуля, может быть пустым.
_dashboard

`POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query`¶

Run the query associated with a Saved Question (Card) in the context of a Dashboard that includes it.

Параметры:¶

dashboard-id целое число больше нуля.
dashcard-id
card-id
parameters null или массив, каждый элемент которого - карта с ключом :id.

`POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query/:export-format`¶

Запускает запрос, связанный с сохраненным вопросом (card) в контексте Dashboard, который включает его, и возвращает его результаты как файл в указанном формате.

parameters должен быть передан в виде параметра запросы, сериализованного в строку JSON (так как обычно этот метод используется для ‘Загрузки результатов’, которые в свою очередь используют действия формы HTML form ).

Параметры:¶

dashboard-id
dashcard-id
card-id
export-format значение должно быть одним из: api, csv, json, xlsx.
parameters корректная строка JSON или null.
request-parameters

`POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute`¶

Исполняет связанное действие в контексте Dashboard и DashboardCard, которая включена в дашборд.

parameters карта параметров дашборда вместе со значениями. extra_parameters дополнительные пользовательские параметры.

Параметры:¶

dashboard-id целое число больше нуля.
dashcard-id целое число больше нуля.
parameters null или карта со схемой: ( value must be a map with schema: ( p? : pred-name : ) : value must be a map with schema: ( _ : ) )
_body

`POST /api/dashboard/:dashboard-id/public_link`¶

Генерирует общедоступные ссылки для дашборда. Возвращает UUID, который должен использоваться в общедоступных ссылках. Если дашборд уже был размещен, она вернет существующую общедоступную ссылку, а не создаст новую. Общий доступ должен быть включен.

Вы должны обладать правами суперпользователя, чтобы использовать этот метод.

Параметры:¶

dashboard-id целое число больше нуля.

`POST /api/dashboard/:from-dashboard-id/copy`¶

Скопировать дашборд.

Параметры:¶

from-dashboard-id целое число больше нуля.
name непустая строка или null.
description строка или null.
collection_id целое число больше нуля, может быть пустым.
collection_position целое число больше нуля, может быть пустым.
is_deep_copy логическое значение, может быть пустым.
_dashboard

`POST /api/dashboard/:id/revert`¶

Откатить дашборд к предыдущей Редакции.

Параметры:¶

id целое число больше нуля.
revision_id целое число больше нуля.

`POST /api/dashboard/pivot/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query`¶

Выполнить запрос сводной таблицы для конкретного дашборда.

Параметры:¶

dashboard-id целое число больше нуля.
dashcard-id
card-id
parameters null или массив, каждый элемент которого - параметр карты с ключом ‘id’.

`POST /api/dashboard/save`¶

Записать денормализованное описание дашборда.

Параметры:¶

dashboard

`POST /api/dashboard/save/collection/:parent-collection-id`¶

Записать денормализованное описание дашборда в коллекцию с ID :parent-collection-id.

Параметры:¶

parent-collection-id целое число больше нуля.
dashboard

`PUT /api/dashboard/:id`¶

Обновить дашборд.

Обычно, для этого достаточно иметь разрешения на запись для этого дашборда (что означает, что у вас есть соответствующие разрешения для карт, принадлежащих этому дашборду), но чтобы изменить значение “enable_embedding”, вам нужно быть суперпользователем.

Параметры:¶

parameters null или массив, каждый элемент которого - карта с ключами :id и :type.
points_of_interest строка или null.
description строка или null.
archived логическое значение, может быть пустым.
collection_position целое число больше нуля, может быть пустым.
show_in_getting_started логическое значение, может быть пустым.
enable_embedding логическое значение, может быть пустым.
collection_id целое число больше нуля, может быть пустым.
dash-updates
name непустая строка или null.
caveats строка или null.
embedding_params действительный параметр встраиваемой карты или null.
cache_ttl целое число больше нуля, может быть пустым.
id
position целое число больше нуля, может быть пустым.

`PUT /api/dashboard/:id/cards`¶

Обновить Карты и Закладки на дашборде. Текст запроса должен иметь форму:

{:cards [{:id                 ... ; DashboardCard ID
          :size_x             ...
          :size_y             ...
          :row                ...
          :col                ...
          :parameter_mappings ...
          :series             [{:id 123
                                ...}]}
         ...]
:ordered_tabs [{:id       ... ; DashboardTab ID
                :name     ...}]}.

Параметры:¶

id целое число больше нуля.
cards последовательность карт, в которых идентификаторы уникальны.
ordered_tabs последовательность карт, в которых идентификаторы уникальны, или null.

<< Назад к разделу API

Дашборд¶

DELETE /api/dashboard/:dashboard-id/public_link¶

Параметры:¶

DELETE /api/dashboard/:id¶

Параметры:¶

GET /api/dashboard/¶

Параметры:¶

GET /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute¶

Параметры:¶

GET /api/dashboard/:id¶

Параметры:¶

GET /api/dashboard/:id/params/:param-key/search/:query¶

Параметры:¶

GET /api/dashboard/:id/params/:param-key/values¶

Параметры:¶

GET /api/dashboard/:id/related¶

Параметры:¶

GET /api/dashboard/:id/revisions¶

Параметры:¶

GET /api/dashboard/embeddable¶

GET /api/dashboard/params/valid-filter-fields¶

Параметры:¶

GET /api/dashboard/public¶

POST /api/dashboard/¶

Параметры:¶

POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query¶

Параметры:¶

POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query/:export-format¶

Параметры:¶

POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute¶

Параметры:¶

POST /api/dashboard/:dashboard-id/public_link¶

Параметры:¶

POST /api/dashboard/:from-dashboard-id/copy¶

Параметры:¶

POST /api/dashboard/:id/revert¶

Параметры:¶

POST /api/dashboard/pivot/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query¶

Параметры:¶

POST /api/dashboard/save¶

Параметры:¶

POST /api/dashboard/save/collection/:parent-collection-id¶

Параметры:¶

PUT /api/dashboard/:id¶

Параметры:¶

PUT /api/dashboard/:id/cards¶

Параметры:¶

`DELETE /api/dashboard/:dashboard-id/public_link`¶

`DELETE /api/dashboard/:id`¶

`GET /api/dashboard/`¶

`GET /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute`¶

`GET /api/dashboard/:id`¶

`GET /api/dashboard/:id/params/:param-key/search/:query`¶

`GET /api/dashboard/:id/params/:param-key/values`¶

`GET /api/dashboard/:id/related`¶

`GET /api/dashboard/:id/revisions`¶

`GET /api/dashboard/embeddable`¶

`GET /api/dashboard/params/valid-filter-fields`¶

`GET /api/dashboard/public`¶

`POST /api/dashboard/`¶

`POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query`¶

`POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query/:export-format`¶

`POST /api/dashboard/:dashboard-id/dashcard/:dashcard-id/execute`¶

`POST /api/dashboard/:dashboard-id/public_link`¶

`POST /api/dashboard/:from-dashboard-id/copy`¶

`POST /api/dashboard/:id/revert`¶

`POST /api/dashboard/pivot/:dashboard-id/dashcard/:dashcard-id/card/:card-id/query`¶

`POST /api/dashboard/save`¶

`POST /api/dashboard/save/collection/:parent-collection-id`¶

`PUT /api/dashboard/:id`¶

`PUT /api/dashboard/:id/cards`¶