Exécutez des requêtes Data Explorer avec l'API Discourse

[Discourse]

This guide explains how to use the Discourse API to create, run, and manage queries with the Data Explorer plugin.

Required user level: Administrator

Virtually any action that can be performed through the Discourse user interface can also be triggered with the Discourse API.

This document provides a comprehensive overview for utilizing the API specifically in conjunction with the Data Explorer plugin.

For a general overview of how to find the correct API request for an action, see: Reverse engineer the Discourse API.

Running a Data Explorer query

To run a Data Explorer query via the API, make a POST request to /admin/plugins/explorer/queries/<query-id>/run. You can find the query ID by visiting it through your Discourse site and checking the id parameter in the address bar.

Below is an example query with an ID of 20 that returns topics by views on a specified date:

--[params]
-- date :viewed_at

SELECT
topic_id,
COUNT(1) AS views_for_date
FROM topic_views
WHERE viewed_at = :viewed_at
GROUP BY topic_id
ORDER BY views_for_date DESC

This query can be run from a terminal with:

curl -X POST "https://your-site-url/admin/plugins/explorer/queries/20/run" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: system" \
-F 'params={"viewed_at":"2019-06-10"}'

Note that you’ll need to replace the <api-key>, <your-site-url> with your API key and domain.

Creating a query via the API

To create a Data Explorer query via the API, you’ll need to make a POST request to /admin/plugins/explorer/queries.

You will also need to specify the query name and sql to use for the new query in the API call.

Below is an example of how to create a new query using the API:

curl -X POST "https://your-site-url/admin/plugins/explorer/queries" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: <username>" \
-F 'query[name]=Example Query' \
-F 'query[sql]=SELECT COUNT(*) FROM users'

This API call will return a response like:

{"query":{"id":49,"name":"Example Query","description":null,"username":"<username>","group_ids":[],"last_run_at":null,"user_id":1,"sql":"SELECT COUNT(*) FROM users","param_info":[],"created_at":"2025-03-13T18:41:44.226Z","hidden":false}}%

You can then run the query by using the query ID from the response (in this case, 49 ).

Returned results will be structured within the rows field.

Handling large datasets

The Data Explorer plugin limits results to 1000 rows by default. To paginate through larger datasets, you can use the example query below:

--[params]
-- integer :limit = 100
-- integer :page = 0
SELECT * 
FROM generate_series(1, 10000)
OFFSET :page * :limit 
LIMIT :limit

To fetch the results page-by-page, increment the page parameter in the request:

curl -X POST "https://your-site-url/admin/plugins/explorer/queries/27/run" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: system" \
-F 'params={"page":"0"}'

Stop when result_count is zero.

For additional information about handling large datasets, see: Result Limits and Exporting Queries

Removing relations data from the results

When Data Explorer queries are run through the user interface, a relations object is added to the results. This data is used for rendering the user in UI results, but you are unlikely to need it when running queries via the API.

To remove that data from the results, add a download=true parameter with your request:

curl -X POST "https://your-site-url/admin/plugins/explorer/queries/27/run" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: system" \
-F 'params={"page":"0"}' \
-F "download=true"

API authentication

Details about generating an API key for the requests can be found here: Create and configure an API key.

If the API key is only going to be used to run Data Explorer queries, you can select “Granular” from the Scope drop down menu, then select the “run queries” scope.

FAQs

Is there any api endpoint I can use to get the list of reports and the ID numbers? I want to build a dropdown with the list in it?

Yes, you can make an authenticated GET request to /admin/plugins/explorer/queries.json to get a list of all queries on the site.

Is it possible to send parameters with the post request?

Yes, include SQL parameters using the -F option, as shown in the examples.

Is CSV export for queries supported by the API?

While JSON output is standard, you can manually convert results to CSV. Native CSV export is no longer supported.

Additional resources

• Create and configure an API key
• GitHub - lee-dohm/execute-discourse-query: Executes a Discourse data-explorer query via the API
• Reverse engineer the Discourse API

[37Rb (Ryan)]

@simon

La prise en charge de limit=ALL pour les exportations CSV

Ce commentaire semble impliquer que vous pouvez faire une exportation CSV à partir de l’API. Est-ce possible ? Je suis juste curieux car j’ai besoin des données au format CSV. Je peux toujours les obtenir au format JSON et les convertir en CSV, mais s’il existe un moyen intégré d’obtenir du CSV, ce serait un peu plus facile.

[francis_exalate (Francis Martens (Exalate))]

Est-il possible de faire une requête « comme créé ou mis à jour dans les 50 dernières secondes » ?

[Canapin (Coin-coin le Canapin)]

L’IA dit

-- [params]
-- int :seconds = 50

SELECT
    p.id AS post_id,
    p.created_at,
    p.updated_at,
    p.raw AS post_content,
    p.user_id,
    t.title AS topic_title,
    t.id AS topic_id
FROM posts p
INNER JOIN topics t ON t.id = p.topic_id
WHERE
    (EXTRACT(EPOCH FROM (NOW() - p.created_at)) <= :seconds
    OR EXTRACT(EPOCH FROM (NOW() - p.updated_at)) <= :seconds)
    AND p.deleted_at IS NULL
    AND t.deleted_at IS NULL
ORDER BY p.created_at DESC
LIMIT 50

J’ai fait un test rapide, ça semble fonctionner

[Moin]

Je ne vois pas le « j’aime  » que j’ai ajouté à une publication en utilisant votre requête.

Je pense que vous devez utiliser post_actions

--[params]
--string :timespan = 50 seconds

SELECT post_id,
       user_id,
       created_at,
       updated_at,
       deleted_at
FROM  post_actions
WHERE post_action_type_id=2 AND updated_at > NOW() - INTERVAL :timespan

Version avec de plus beaux résultats

--[params]
--string :timespan = 50 seconds
--boolean :include_in_timespan_deleted = false

SELECT
  post_id,
  user_id,
  CASE
    WHEN EXTRACT(EPOCH FROM (NOW() - created_at)) < 60 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - created_at))), ' seconds ago')
    WHEN EXTRACT(EPOCH FROM (NOW() - created_at)) < 3600 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - created_at)) / 60), ' minutes ago')
    WHEN EXTRACT(EPOCH FROM (NOW() - created_at)) < 86400 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - created_at)) / 3600), ' hours ago')
    ELSE CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - created_at)) / 86400), ' days ago')
  END AS relative_created_at,
  CASE
    WHEN EXTRACT(EPOCH FROM (NOW() - updated_at)) < 60 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - updated_at))), ' seconds ago')
    WHEN EXTRACT(EPOCH FROM (NOW() - updated_at)) < 3600 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - updated_at)) / 60), ' minutes ago')
    WHEN EXTRACT(EPOCH FROM (NOW() - updated_at)) < 86400 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - updated_at)) / 3600), ' hours ago')
    ELSE CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - updated_at)) / 86400), ' days ago')
  END AS relative_updated_at,
  CASE
    WHEN deleted_at IS NULL THEN 'no'
    WHEN EXTRACT(EPOCH FROM (NOW() - deleted_at)) < 60 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - deleted_at))), ' seconds ago')
    WHEN EXTRACT(EPOCH FROM (NOW() - deleted_at)) < 3600 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - deleted_at)) / 60), ' minutes ago')
    WHEN EXTRACT(EPOCH FROM (NOW() - deleted_at)) < 86400 THEN CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - deleted_at)) / 3600), ' hours ago')
    ELSE CONCAT(ROUND(EXTRACT(EPOCH FROM (NOW() - deleted_at)) / 86400), ' days ago')
  END AS relative_deleted_at
FROM
  post_actions
WHERE
  post_action_type_id = 2
  AND updated_at > NOW() - INTERVAL :timespan
  AND (
    :include_in_timespan_deleted = false
    OR (deleted_at IS NOT NULL AND deleted_at > NOW() - INTERVAL :timespan)
  )

[Canapin (Coin-coin le Canapin)]

Oooh j’ai mal lu ! J’ai lu la phrase comme « Est-il possible de faire une requête comme « créé ou mis à jour au cours des 50 dernières secondes » ? »

(notez la position de la virgule simple)

[francis_exalate (Francis Martens (Exalate))]

Merci à tous,

J’ai posté ici car c’est là que ask.discourse m’a dirigé.
Je cherche à savoir si l’API offre cette fonctionnalité.

[Canapin (Coin-coin le Canapin)]

Oui, bien sûr.

Vous créez la requête dans l’explorateur de données, puis vous exécutez la requête via l’API comme décrit dans ce guide.

Je viens d’exécuter la requête de Moin via l’API et elle a correctement renvoyé les résultats attendus.

[tanya_byrne (kukulaka)]

Je me posais la même question. JSON est-il le seul moyen d’exporter des données via l’API ou l’export CSV est-il également pris en charge pour Data Explorer ?

[francis_exalate (Francis Martens (Exalate))]

Merci à tous,

Désolé pour ma réponse tardive - j’étais hors ligne pendant un moment.

Ce que je fais actuellement, c’est rechercher tous les sujets/messages créés aujourd’hui, et filtrer les sujets/messages mis à jour avant l’horodatage.

[Canapin (Coin-coin le Canapin)]

@francis_exalate

Ce que je fais actuellement, c’est rechercher tous les sujets/messages créés aujourd’hui, et filtrer les sujets/messages mis à jour avant l’horodatage.

Si vous ne voulez pas vous salir les mains, vous pouvez demander au bot sur ask.discourse.com. Il est généralement assez précis en ce qui concerne les requêtes SQL relatives à Discourse (mais ne supposez pas qu’il a raison, vérifiez le code pour être sûr).

[srinivas.chilukuri]

@Discourse

-H "Content-Type: multipart/form-data; `

---

L’en-tête Content-Type est-il correct ?
Dans les outils de développement, lors de l’inspection d’une requête Data Explorer avec des paramètres, l’en-tête Content-Type apparaît comme suit :

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Cependant, la commande cURL actuelle inclut :

-H "Content-Type: multipart/form-data;"

---

[blake (Blake Erickson)]

• multipart/form-data
• application/x-www-form-urlencoded
• application/json

sont tous des types de contenu valides que vous pouvez utiliser lors de la création d’une requête API.

[srinivas.chilukuri]

@blake
language python
library requests
Pourriez-vous fournir une requête d’exemple d’API Data Explorer qui inclut trois paramètres
référez-vous à Topic qui indique que les paramètres doivent être strictement entre guillemets doubles.

[blake (Blake Erickson)]

Bien sûr, voici un exemple utilisant Python :

import json
import requests

API_KEY      = "VOTRE_CLE_API"
API_USERNAME = "system"
QUERY_ID     = 20
SITE_URL     = "https://votre-url-de-site"

# toutes les valeurs doivent être des chaînes de caractères
params = {
    "user_id":   "2",
    "viewed_at": "2019-06-10",
    "limit":     "5"
}

# Data Explorer attend les paramètres sous forme de chaîne encodée en JSON
payload = {
    "params": json.dumps(params)
}

url = f"{SITE_URL}/admin/plugins/explorer/queries/{QUERY_ID}/run"
headers = {
    "Api-Key":       API_KEY,
    "Api-Username":  API_USERNAME,
    "Content-Type":  "application/json"
}

r = requests.post(url, headers=headers, json=payload)
r.raise_for_status()
print(r.json())