Eine Data Explorer-Abfrage mit der API erstellen
In dieser Anleitung erfahren Sie, wie Sie eine Data Explorer-Abfrage mithilfe der Discourse API erstellen.
Erforderliches Benutzerniveau: Administrator
Voraussetzungen
Stellen Sie vor Beginn sicher, dass Sie Folgendes haben:
- Das Plugin Data Explorer ist auf Ihrer Seite installiert und aktiviert
- Ein API-Schlüssel mit dem Umfang Global, der einem Admin-Benutzer zugeordnet ist (siehe API-Schlüssel erstellen und konfigurieren)
Das Erstellen von Abfragen erfordert einen globalen API-Schlüssel. Der granulare Umfang „Abfragen ausführen“ erlaubt nur das Ausführen vorhandener Abfragen, nicht das Erstellen neuer.
Eine Abfrage erstellen
Um eine neue Data Explorer-Abfrage zu erstellen, senden Sie eine POST-Anfrage an /admin/plugins/explorer/queries.
Parameter
| Parameter | Erforderlich | Beschreibung |
|---|---|---|
query[name] |
Ja | Der Name für Ihre Abfrage |
query[sql] |
Ja | Die auszuführende SQL-Anweisung |
query[description] |
Nein | Eine Beschreibung dessen, was die Abfrage tut |
query[group_ids] |
Nein | Array von Gruppen-IDs, die auf diese Abfrage zugreifen können |
Beispielanfrage
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'
Beispielantwort
{
"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
}
}
Beachten Sie den Wert id in der Antwort – Sie benötigen diesen, um die Abfrage auszuführen. Details zum Ausführen von Abfragen über die API finden Sie unter Data Explorer-Abfragen mit der Discourse API ausführen.