Crear una consulta de Explorador de Datos con la API
Esta guía explica cómo crear una consulta de Data Explorer utilizando la API de Discourse.
Nivel de usuario requerido: Administrador
Requisitos previos
Antes de comenzar, asegúrate de tener:
- El plugin Data Explorer instalado y habilitado en tu sitio
- Una clave de API con el alcance Global, asociada a un usuario administrador (consulta Crear y configurar una clave de API)
Crear consultas requiere una clave de API global. El alcance granular “ejecutar consultas” solo permite ejecutar consultas existentes, no crear nuevas.
Crear una consulta
Para crear una nueva consulta de Data Explorer, realiza una solicitud POST a /admin/plugins/discourse-data-explorer/queries.
Parámetros
| Parámetro | Requerido | Descripción |
|---|---|---|
query[name] |
Sí | El nombre para tu consulta |
query[sql] |
Sí | La sentencia SQL a ejecutar |
query[description] |
No | Una descripción de lo que hace la consulta |
query[group_ids] |
No | Array de IDs de grupos que pueden acceder a esta consulta |
Solicitud de ejemplo
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'
Respuesta de ejemplo
{
"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
}
}
Observa el valor id en la respuesta, lo necesitarás para ejecutar la consulta. Para obtener detalles sobre cómo ejecutar consultas a través de la API, consulta Ejecutar consultas de Data Explorer con la API de Discourse.