dashboards

Atualiza uma Dashboard.

put/v1/reports/dashboards/{_id}

Request

  • Base URL: http://localhost:8888/api
  • URL: http://localhost:8888/api/v1/reports/dashboards/{_id}
  • Auth: API key in header authorization

Path parameters

ID da Dashboard.

Request body

namestring required

Nome da Dashboard

activeboolean

Status da Dashboard

orderinteger

Ordem da Dashboard

keystring

Key da Dashboard

graphsstring[]

Lista de gráficos para essa Dashboard

Example request

{
  "name": "My Dashboard",
  "active": true,
  "order": 1,
  "key": "my-dashboard",
  "graphs": [
    "candidates_avg"
  ]
}

Response

Sucesso de Retorno!

_idstring

ID da Dashboard

keystring

Key da Dashboard

namestring

Título da Dashboard

defaultboolean

Define se a Dashboard é Padrão

activeboolean

Define se a Dashboard está ativa.

implementedboolean

Parâmetro que define se o Dashboard está implementada.

orderinteger

Ordem da Dashboard

Example response

{
  "_id": "636baff4c4984127856d2f63",
  "key": "minha-dashboard-legal",
  "name": "Minha Dashboard Legal",
  "default": true,
  "active": true,
  "implemented": true,
  "order": 1,
  "graphs": [
    {
      "_id": "636baff4c4984127856d2f63",
      "key": "meu-grafico-legal",
      "name": "Meu Gráfico Legal",
      "param_key": "candidates",
      "active": true,
      "order": 1,
      "enabled": true,
      "plans": [
        "free",
        "premium",
        "admin"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.