Status200
Ресурс

Dashboard

Create and manage Dashboards to visualize your data in a single place

Модель Dashboard

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    name
    Тип
    TextОбязательно
    Описание

    Any friendly name of this object

  • Имя
    slug
    Тип
    SlugОбязательно
    Описание

    Friendly globally unique name for your object

  • Имя
    description
    Тип
    Long Text
    Описание

    Friendly description that will help you remember

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    labels
    Тип
    Label
    Описание

    Relation to Labels Array where this object is categorized in.

  • Имя
    dashboardViewConfig
    Тип
    JSONОбязательно
    Описание

    Configuration of Dashboard View

GETorPOST/api/dashboard/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Dashboard». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/dashboard/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "dashboardViewConfig": true,
    "name": true,
    "projectId": true,
    "slug": true,
    "createdByUser": true
  },
  "query": {
    "name": "Production Monitoring Dashboard"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376dc120-28fe-11f1-b591-3fdcef396aba",
      "dashboardViewConfig": {
        "components": [],
        "layout": "grid"
      },
      "name": "Production Monitoring Dashboard",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "production-monitoring-dashboard",
      "createdByUser": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "376dc121-28fe-11f1-b591-3fdcef396aba",
      "dashboardViewConfig": {
        "components": [],
        "layout": "grid"
      },
      "name": "Production Monitoring Dashboard",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "production-monitoring-dashboard",
      "createdByUser": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "376dc122-28fe-11f1-b591-3fdcef396aba",
      "dashboardViewConfig": {
        "components": [],
        "layout": "grid"
      },
      "name": "Production Monitoring Dashboard",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "production-monitoring-dashboard",
      "createdByUser": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    }
  ]
}
GETorPOST/api/dashboard/:id/get-item

Получить по ID

Возвращает объект «Dashboard» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/dashboard/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "dashboardViewConfig": true,
    "name": true,
    "projectId": true,
    "slug": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "376dc120-28fe-11f1-b591-3fdcef396aba",
  "dashboardViewConfig": {
    "components": [],
    "layout": "grid"
  },
  "name": "Production Monitoring Dashboard",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "slug": "production-monitoring-dashboard",
  "createdByUser": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}
POST/api/dashboard/count

Количество

Возвращает количество ваших объектов «Dashboard».

Необязательное тело запроса

Запрос количества

POST
/api/dashboard/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "name": "Production Monitoring Dashboard"
  }
}

Ответ

{
  "count": 107
}
POST/api/dashboard

Создать Dashboard

Создаёт новый объект.

Запрос создания

POST
/api/dashboard
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "dashboardViewConfig": {
      "components": [],
      "layout": "grid"
    },
    "name": "Production Monitoring Dashboard",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "createdByUser": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "createdByUserId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
  }
}

Ответ

{
  "_id": "376dc120-28fe-11f1-b591-3fdcef396aba",
  "dashboardViewConfig": {
    "components": [],
    "layout": "grid"
  },
  "name": "Production Monitoring Dashboard",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "slug": "production-monitoring-dashboard",
  "createdByUser": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}
PUT/api/dashboard/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/dashboard/:id/update-item
GET/api/dashboard/:id/update-item

Запрос обновления

PUT
/api/dashboard/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "dashboardViewConfig": {
      "components": [],
      "layout": "grid"
    },
    "name": "Production Monitoring Dashboard",
    "description": "Dashboard for monitoring production infrastructure and services"
  }
}

Ответ

{}
DELETE/api/dashboard/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/dashboard/:id/delete-item
GET/api/dashboard/:id/delete-item

Запрос удаления

DELETE
/api/dashboard/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Dashboard

  • Project Owner
  • Project Admin
  • Project Member
  • Read Dashboard
  • Read All Project Resources

Права на создание

Нужны для создания Dashboard

  • Project Owner
  • Project Admin
  • Create Dashboard

Права на обновление

Нужны для обновления Dashboard

  • Project Owner
  • Project Admin
  • Edit Dashboard

Права на удаление

Нужны для удаления Dashboard

  • Project Owner
  • Project Admin
  • Delete Dashboard