How to create a data explorer query with the APIs?

Development
,

AI-generated summary

Creating a Data Explorer Query with the APIs

Tanay_Suthar is having trouble finding the API call to create a Data Explorer query. pfaffman suggests reverse-engineering the Discourse API.

After trying this, Tanay_Suthar realizes that two separate calls are needed: a POST call to /admin/plugins/explorer/queries to generate a query ID, and a PUT call to /admin/plugins/explorer/queries/id to edit the query. However, Tanay_Suthar wonders if it’s possible to create a query in a single API call without knowing the ID.

Arkshine suggests making a POST request with the same payload values as PUT. Tanay_Suthar tries this but gets an internal server error. Arkshine then provides the correct way to format the query, using -F 'query[name]=test1234' -F 'query[sql]=SELECT * FROM topics'. This solution works, as confirmed by Tanay_Suthar.

1

I’m in process of creating a query with data explorer with the APIs. I’m having a hard time finding the actual API call to create a query.

There is an endpoint to run the query /admin/plugins/explorer/queries/<query_id>/run ; however don’t see to create it.

Can anyone help ?

2

Have you tried to Reverse engineer the Discourse API?

3

Thanks for sharing the article of Reverse engineer the discourse API ;

I’ve gone through it and realised that there should be two separate calls need to be made.

First should be, the POST call to /admin/plugins/explorer/queries , which will generate the ID associated with the query.

Secondly, the PUT call needs to be made on /admin/plugins/explorer/queries/id to edit the default query.

But I’m wondering whether there is a provision to create the query(by making the single API call) directly without knowing the ID.

Let me know if that’s possible.

5

You should be able to make a POST request with the same payload values as PUT.
Did you try?

6

Here is the query which I tried by making POST API call.

curl -X POST https://api-discourse-XXXXXXXXXXXXX/admin/plugins/explorer/queries
-H “Content-Type: multipart/form-data;”
-H “Api-Key: 46811cc32XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”
-H “Api-Username: abcdefg2”
-F ‘query={“name”:“test1234”, “sql”:“SELECT * FROM topics”}’

However, I’m getting an error as below.

{“status”:500,“error”:“Internal Server Error”}%

Not sure what could be wrong.

7

I think the correct way is the following:

-F 'query[name]=test1234'
-F 'query[sql]=SELECT * FROM topics'
8

Thanks @Arkshine for the help.

It worked..!!