Hex
Запуск и управление проектами Hex
Hex — это совместная платформа для аналитики и data science, которая позволяет создавать, запускать и делиться интерактивными проектами данных и блокнотами. Hex позволяет командам совместно работать над исследованием данных, преобразованием и визуализацией, упрощая превращение анализа в доступные для совместного использования инсайты.
С помощью Hex вы можете:
- Создавать и запускать мощные блокноты: Смешивать SQL, Python и визуализации в едином интерактивном рабочем пространстве.
- Сотрудничать и делиться: Работать вместе с членами команды в реальном времени и публиковать интерактивные приложения данных для более широкой аудитории.
- Автоматизировать и оркестрировать рабочие процессы: Планировать запуски блокнотов, параметризировать запуски с входными данными и автоматизировать задачи обработки данных.
- Визуализировать и сообщать результаты: Превращать результаты анализа в дашборды или интерактивные приложения, которые может использовать любой.
- Интегрироваться с вашим стеком данных: Легко подключаться к хранилищам данных, API и другим источникам.
Интеграция AACFlow Hex позволяет вашим AI-агентам или рабочим процессам:
- Списывать, получать и управлять проектами Hex непосредственно из AACFlow.
- Запускать и отслеживать запуски блокнотов, проверять их статусы или отменять их в рамках более крупных потоков автоматизации.
- Получать результаты запусков и использовать их в процессах и принятии решений, управляемых AACFlow.
- Использовать интерактивные аналитические возможности Hex прямо внутри ваших автоматизированных рабочих процессов AACFlow.
Независимо от того, расширяете ли вы возможности аналитиков, автоматизируете отчетность или внедряете действенные данные в ваши процессы, Hex и AACFlow предоставляют бесшовный способ операционализации аналитики и внедрения данных в работу вашей команды.
Интегрируйте Hex в ваш рабочий процесс. Запускайте проекты, проверяйте статус запуска, управляйте коллекциями и группами, спишите пользователей и просматривайте подключения к данным. Требуется токен API Hex.
Отменить активный запуск проекта Hex.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex |
runId | string | Да | UUID запуска для отмены |
| Параметр | Тип | Описание |
|---|
success | boolean | Был ли запуск успешно отменен |
projectId | string | UUID проекта |
runId | string | UUID отмененного запуска |
Создать новую коллекцию в рабочем пространстве Hex для организации проектов.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
name | string | Да | Название новой коллекции |
description | string | Нет | Опциональное описание коллекции |
| Параметр | Тип | Описание |
|---|
id | string | UUID вновь созданной коллекции |
name | string | Название коллекции |
description | string | Описание коллекции |
creator | object | Создатель коллекции |
↳ email | string | Email создателя |
↳ id | string | UUID создателя |
Получить детали конкретной коллекции Hex по ее ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
collectionId | string | Да | UUID коллекции |
| Параметр | Тип | Описание |
|---|
id | string | UUID коллекции |
name | string | Название коллекции |
description | string | Описание коллекции |
creator | object | Создатель коллекции |
↳ email | string | Email создателя |
↳ id | string | UUID создателя |
Получить детали конкретного подключения к данным, включая тип, описание и флаги конфигурации.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
dataConnectionId | string | Да | UUID подключения к данным |
| Параметр | Тип | Описание |
|---|
id | string | UUID подключения |
name | string | Название подключения |
type | string | Тип подключения (например, snowflake, postgres, bigquery) |
description | string | Описание подключения |
connectViaSsh | boolean | Включено ли SSH-туннелирование |
includeMagic | boolean | Включены ли функции Magic AI |
allowWritebackCells | boolean | Разрешены ли ячейки обратной записи |
Получить детали конкретной группы Hex.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
groupId | string | Да | UUID группы |
| Параметр | Тип | Описание |
|---|
id | string | UUID группы |
name | string | Название группы |
createdAt | string | Метка времени создания |
Получить метаданные и детали конкретного проекта Hex по его ID.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex |
| Параметр | Тип | Описание |
|---|
id | string | UUID проекта |
title | string | Название проекта |
description | string | Описание проекта |
status | object | Статус проекта |
↳ name | string | Название статуса (например, PUBLISHED, DRAFT) |
type | string | Тип проекта (PROJECT или COMPONENT) |
creator | object | Создатель проекта |
↳ email | string | Email создателя |
owner | object | Владелец проекта |
↳ email | string | Email владельца |
categories | array | Категории проекта |
↳ name | string | Название категории |
↳ description | string | Описание категории |
lastEditedAt | string | Метка времени последнего редактирования ISO 8601 |
lastPublishedAt | string | Метка времени последней публикации ISO 8601 |
createdAt | string | Метка времени создания ISO 8601 |
archivedAt | string | Метка времени архивации ISO 8601 |
trashedAt | string | Метка времени перемещения в корзину ISO 8601 |
Получить запуски проекта Hex, инициированные через API, с опциональной фильтрацией по статусу и пагинацией.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex |
limit | number | Нет | Максимальное количество запусков для возврата (1-100, по умолчанию: 25) |
offset | number | Нет | Смещение для пагинированных результатов (по умолчанию: 0) |
statusFilter | string | Нет | Фильтр по статусу запуска: PENDING, RUNNING, ERRORED, COMPLETED, KILLED, UNABLE_TO_ALLOCATE_KERNEL |
| Параметр | Тип | Описание |
|---|
runs | array | Список запусков проекта |
↳ projectId | string | UUID проекта |
↳ runId | string | UUID запуска |
↳ runUrl | string | URL для просмотра запуска |
↳ status | string | Статус запуска (PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL) |
↳ startTime | string | Время начала запуска |
↳ endTime | string | Время окончания запуска |
↳ elapsedTime | number | Затраченное время в секундах |
↳ traceId | string | ID трассировки |
↳ projectVersion | number | Номер версии проекта |
total | number | Общее количество возвращенных запусков |
traceId | string | ID трассировки верхнего уровня |
Вернуть таблицы хранилища данных, запрошенные проектом Hex, включая подключение к данным и названия таблиц.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex |
limit | number | Нет | Максимальное количество таблиц для возврата (1-100) |
| Параметр | Тип | Описание |
|---|
tables | array | Список таблиц хранилища данных, запрошенных проектом |
↳ dataConnectionId | string | UUID подключения к данным |
↳ dataConnectionName | string | Название подключения к данным |
↳ tableName | string | Название таблицы |
total | number | Общее количество возвращенных таблиц |
Проверить статус запуска проекта Hex по его ID запуска.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex |
runId | string | Да | UUID запуска для проверки |
| Параметр | Тип | Описание |
|---|
projectId | string | UUID проекта |
runId | string | UUID запуска |
runUrl | string | URL для просмотра запуска |
status | string | Статус запуска (PENDING, RUNNING, COMPLETED, ERRORED, KILLED, UNABLE_TO_ALLOCATE_KERNEL) |
startTime | string | Время начала запуска ISO 8601 |
endTime | string | Время окончания запуска ISO 8601 |
elapsedTime | number | Затраченное время в секундах |
traceId | string | ID трассировки для отладки |
projectVersion | number | Номер версии проекта |
Список всех коллекций в рабочем пространстве Hex.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
limit | number | Нет | Максимальное количество коллекций для возврата (1-500, по умолчанию: 25) |
sortBy | string | Нет | Сортировка по полю: NAME |
| Параметр | Тип | Описание |
|---|
collections | array | Список коллекций |
↳ id | string | UUID коллекции |
↳ name | string | Название коллекции |
↳ description | string | Описание коллекции |
↳ creator | object | Создатель коллекции |
↳ email | string | Email создателя |
↳ id | string | UUID создателя |
total | number | Общее количество возвращенных коллекций |
Список всех подключений к данным в рабочем пространстве Hex (например, Snowflake, PostgreSQL, BigЗапрос).
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
limit | number | Нет | Максимальное количество подключений для возврата (1-500, по умолчанию: 25) |
sortBy | string | Нет | Сортировка по полю: CREATED_AT или NAME |
sortDirection | string | Нет | Направление сортировки: ASC или DESC |
| Параметр | Тип | Описание |
|---|
connections | array | Список подключений к данным |
↳ id | string | UUID подключения |
↳ name | string | Название подключения |
↳ type | string | Тип подключения (например, athena, bigquery, databricks, postgres, redshift, snowflake) |
↳ description | string | Описание подключения |
↳ connectViaSsh | boolean | Включено ли SSH-туннелирование |
↳ includeMagic | boolean | Включены ли функции Magic AI |
↳ allowWritebackCells | boolean | Разрешены ли ячейки обратной записи |
total | number | Общее количество возвращенных подключений |
Список всех групп в рабочем пространстве Hex с опциональной сортировкой.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
limit | number | Нет | Максимальное количество групп для возврата (1-500, по умолчанию: 25) |
sortBy | string | Нет | Сортировка по полю: CREATED_AT или NAME |
sortDirection | string | Нет | Направление сортировки: ASC или DESC |
| Параметр | Тип | Описание |
|---|
groups | array | Список групп рабочего пространства |
↳ id | string | UUID группы |
↳ name | string | Название группы |
↳ createdAt | string | Метка времени создания |
total | number | Общее количество возвращенных групп |
Список всех проектов в вашем рабочем пространстве Hex с опциональной фильтрацией по статусу.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
limit | number | Нет | Максимальное количество проектов для возврата (1-100) |
includeArchived | boolean | Нет | Включать архивированные проекты в результаты |
statusFilter | string | Нет | Фильтр по статусу: PUBLISHED, DRAFT или ALL |
| Параметр | Тип | Описание |
|---|
projects | array | Список проектов Hex |
↳ id | string | UUID проекта |
↳ title | string | Название проекта |
↳ description | string | Описание проекта |
↳ status | object | Статус проекта |
↳ name | string | Название статуса (например, PUBLISHED, DRAFT) |
↳ type | string | Тип проекта (PROJECT или COMPONENT) |
↳ creator | object | Создатель проекта |
↳ email | string | Email создателя |
↳ owner | object | Владелец проекта |
↳ email | string | Email владельца |
↳ lastEditedAt | string | Метка времени последнего редактирования |
↳ lastPublishedAt | string | Метка времени последней публикации |
↳ createdAt | string | Метка времени создания |
↳ archivedAt | string | Метка времени архивации |
total | number | Общее количество возвращенных проектов |
Список всех пользователей в рабочем пространстве Hex с опциональной фильтрацией и сортировкой.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
limit | number | Нет | Максимальное количество пользователей для возврата (1-100, по умолчанию: 25) |
sortBy | string | Нет | Сортировка по полю: NAME или EMAIL |
sortDirection | string | Нет | Направление сортировки: ASC или DESC |
groupId | string | Нет | Фильтр пользователей по UUID группы |
| Параметр | Тип | Описание |
|---|
users | array | Список пользователей рабочего пространства |
↳ id | string | UUID пользователя |
↳ name | string | Имя пользователя |
↳ email | string | Email пользователя |
↳ role | string | Роль пользователя (ADMIN, MANAGER, EDITOR, EXPLORER, MEMBER, GUEST, EMBEDDED_USER, ANONYMOUS) |
total | number | Общее количество возвращенных пользователей |
Выполнить опубликованный проект Hex. Опционально передавать входные параметры и управлять поведением кэширования.
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex для запуска |
inputParams | json | Нет | JSON-объект входных параметров для проекта (например, {"date": "2024-01-01"}) |
dryRun | boolean | Нет | Если true, выполнить пробный запуск без выполнения проекта |
updateCache | boolean | Нет | (Устарело) Если true, обновить кэшированные результаты после выполнения |
updatePublishedResults | boolean | Нет | Если true, обновить опубликованные результаты приложения после выполнения |
useCachedSqlResults | boolean | Нет | Если true, использовать кэшированные результаты SQL вместо повторного выполнения запросов |
| Параметр | Тип | Описание |
|---|
projectId | string | UUID проекта |
runId | string | UUID запуска |
runUrl | string | URL для просмотра запуска |
runStatusUrl | string | URL для проверки статуса запуска |
traceId | string | ID трассировки для отладки |
projectVersion | number | Номер версии проекта |
Обновить метку статуса проекта Hex (например, одобрение или пользовательские статусы рабочего пространства).
| Параметр | Тип | Обязательный | Описание |
|---|
apiKey | string | Да | Токен API Hex (Personal или Workspace) |
projectId | string | Да | UUID проекта Hex для обновления |
status | string | Да | Новое название статуса проекта (пользовательская метка статуса рабочего пространства) |
| Параметр | Тип | Описание |
|---|
id | string | UUID проекта |
title | string | Название проекта |
description | string | Описание проекта |
status | object | Обновленный статус проекта |
↳ name | string | Название статуса (например, PUBLISHED, DRAFT) |
type | string | Тип проекта (PROJECT или COMPONENT) |
creator | object | Создатель проекта |
↳ email | string | Email создателя |
owner | object | Владелец проекта |
↳ email | string | Email владельца |
categories | array | Категории проекта |
↳ name | string | Название категории |
↳ description | string | Описание категории |
lastEditedAt | string | Метка времени последнего редактирования |
lastPublishedAt | string | Метка времени последней публикации |
createdAt | string | Метка времени создания |
archivedAt | string | Метка времени архивации |
trashedAt | string | Метка времени перемещения в корзину |
