Criar uma consulta do Data Explorer com a API
Este guia prático explica como criar uma consulta do Data Explorer usando a API do Discourse.
Nível de usuário necessário: Administrador
Pré-requisitos
Antes de começar, certifique-se de que você tem:
- O plugin Data Explorer instalado e habilitado em seu site
- Uma chave de API com escopo Global, associada a um usuário administrador (consulte Criar e configurar uma chave de API)
A criação de consultas exige uma chave de API global. O escopo granular “executar consultas” permite apenas a execução de consultas existentes, e não a criação de novas.
Criar uma consulta
Para criar uma nova consulta do Data Explorer, faça uma requisição POST para /admin/plugins/discourse-data-explorer/queries.
Parâmetros
| Parâmetro | Necessário | Descrição |
|---|---|---|
query[name] |
Sim | O nome para sua consulta |
query[sql] |
Sim | A instrução SQL a ser executada |
query[description] |
Não | Uma descrição do que a consulta faz |
query[group_ids] |
Não | Array de IDs de grupo que podem acessar esta consulta |
Exemplo de requisição
curl -X POST "https://your-site.com/admin/plugins/discourse-data-explorer/queries" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: \u003capi-key\u003e" \
-H "Api-Username: \u003cusername\u003e" \
-F 'query[name]=User count query' \
-F 'query[sql]=SELECT COUNT(*) FROM users'
Exemplo de resposta
{
"query": {
"id": 49,
"name": "User count query",
"description": null,
"username": "\u003cusername\u003e",
"group_ids": [],
"last_run_at": "2025-03-13T18:41:44.226Z",
"user_id": 1,
"is_default": false,
"sql": "SELECT COUNT(*) FROM users",
"param_info": [],
"created_at": "2025-03-13T18:41:44.226Z",
"hidden": false
}
}
Observe o valor id na resposta, você precisará dele para executar a consulta. Para detalhes sobre como executar consultas via API, consulte Executar consultas do Data Explorer com a API do Discourse.