Criar dashboard no Grafana Cloud, por uma API
Cria um dashboard a partir do seu JSON em spec, na raiz ou em uma pasta. Envie metadata.name com o uid desejado, ou metadata.generateName com um prefixo para um uid aleatório. Um uid já em uso responde 409.
- Identificador
- grafana_create_dashboard
A chamada
POST https://connect.reportei.com/api/tools/grafana_create_dashboard/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"namespace": "<namespace>",
"metadata": {},
"spec": {}
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| namespace | string | Sim | stacks- followed by the instance ID shown under Details of the Grafana instance in the Grafana Cloud portal, for example stacks-123456. |
| metadata | object | Sim | Identity and folder of the new dashboard. |
| spec | object | Sim | The dashboard JSON model: title, panels, templating, time, refresh and the other dashboard fields. |
Conexões possíveis
O seu cliente conecta a conta do Grafana Cloud uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Na conexão, o cliente informa também {stack}: o endereço da conta dele na API do app.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/grafana_create_dashboard. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Grafana Cloud
- Listar dashboardsGETLista os dashboards da stack. Cada item traz metadata.name, o uid que as outras ferramentas pedem, o uid da pasta na anotação grafana.app/folder do metadata e o JSON inteiro do dashboard em spec, com seu title. Mantenha limit pequeno; quando metadata.continue vier, envie-o como continue para a próxima página.
- Obter dashboardGETRetorna um dashboard: metadata, com o uid em name, o resourceVersion e a anotação de pasta, e o JSON do dashboard em spec, com title, panels, variáveis e intervalo de tempo.
- Atualizar dashboardPUTSubstitui um dashboard por uma nova versão do seu JSON. Leia-o antes com Get dashboard, altere spec e envie o spec inteiro, pois campos omitidos são removidos. Envie o resourceVersion que você leu para não sobrescrever uma mudança mais nova; um desatualizado responde 409.
- Listar pastasGETLista as pastas da stack que o token enxerga, cada uma com metadata.name, o uid que os campos de pasta das outras ferramentas pedem, a pasta pai na anotação grafana.app/folder do metadata e o título em spec. Quando metadata.continue vier, envie-o como continue para a próxima página.
- Criar pastaPOSTCria uma pasta na raiz ou dentro de outra pasta. Envie metadata.name com o uid desejado, ou metadata.generateName com um prefixo para um uid aleatório.
- Atualizar pastaPUTRenomeia uma pasta ou a move para dentro de outra. Envie o título e, quando houver, o pai na anotação grafana.app/folder, pois a chamada substitui a pasta.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
