Creare una query di Data Explorer con l’API
Questa guida spiega come creare una query di Data Explorer utilizzando l’API di Discourse.
Livello utente richiesto: Amministratore
Prerequisiti
Prima di iniziare, assicurati di avere:
- Il plugin Data Explorer installato e abilitato sul tuo sito
- Una chiave API con ambito Globale, associata a un utente admin (vedi Creare e configurare una chiave API)
La creazione di query richiede una chiave API globale. L’ambito granulare “esegui query” consente solo di eseguire query esistenti, non di crearne di nuove.
Creare una query
Per creare una nuova query di Data Explorer, effettua una richiesta POST a /admin/plugins/explorer/queries.
Parametri
| Parametro | Richiesto | Descrizione |
|---|---|---|
query[name] |
Sì | Il nome per la tua query |
query[sql] |
Sì | L’istruzione SQL da eseguire |
query[description] |
No | Una descrizione di cosa fa la query |
query[group_ids] |
No | Array di ID di gruppo che possono accedere a questa query |
Esempio di richiesta
curl -X POST "https://your-site.com/admin/plugins/explorer/queries" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: <username>" \
-F 'query[name]=User count query' \
-F 'query[sql]=SELECT COUNT(*) FROM users'
Esempio di risposta
{
"query": {
"id": 49,
"name": "User count query",
"description": null,
"username": "<username>",
"group_ids": [],
"last_run_at": "2025-03-13T18:41:44.226Z",
"user_id": 1,
"sql": "SELECT COUNT(*) FROM users",
"param_info": [],
"created_at": "2025-03-13T18:41:44.226Z",
"hidden": false
}
}
Nota il valore id nella risposta: ti servirà per eseguire la query. Per i dettagli sull’esecuzione delle query tramite API, consulta Eseguire query di Data Explorer con l’API di Discourse.