Hi, I would like to create some weekly statistic reports using the REST API. I will be doing this for forum linkingyourthinking com but I would like to start early before I have gotten the keys from the administrator which might take a while, since they are in the middle of a 6 week workshop. So I was hoping to begin right now with try.discourse.org, Is that possible? I have tried curl -X GET https://try.discourse.org/site.json and it works nicely.

You can set up a local development instance of discourse for such work. It is fairly simple to do so. See Set up a local Discourse Development Environment?

Thanks for the tip! Will there by any demo data in such an instance: users, groups and posts?

There will be some default seeded data but you’re always free to create some data as per your own need.

[image] orli: So I was hoping to begin right now with try.discourse.org, Is that possible? I have tried curl -X GET https://try.discourse.org/site.json and it works nicely. If you are doing reports on public data on try.discourse.org you won’t need the API keys, as the GET requests will work just fine without it!

Thank you! I don’t have the terminology clear for me right now. I want to list all groups for each group, list group member statistics: seen, posts, read time, … do this on a weekly basis and mail to the group leaders/guides. That data is probably not public?

It is! Discourse aims to be an open and crawleable platform by default. In fact you can even do the same on Meta. [image] orli: list all groups curl https://meta.discourse.org/g.json [image] orli: for each group, list group member statistics: seen, posts, read time, … curl https://meta.discourse.org/groups/translators/members.json?offset=0&order=&asc=true&filter= https://meta.discourse.org/u/falco/summary.json [image] orli: do this on a weekly basis and mail to the group leaders/guides. Group leader data will be on the first request. :slightly_smiling_face:

The api username will tell Discourse which capabilities are enabled. An admin or a regular user don’t have the same capabilities, and using one or another will restrict what you can achieve using the api. the api key is the password to be used with the api username.

So in my scenario I only want to use the discourse api and my confusion is that every user who is using my app can create post, like, comment other features so now do i want to create api-username and api-key for each user to use respective api’s?

have you read the api documentation? especially this [image] User API keys specification Integrations Discourse contains a system for generating API keys per user if a very specific protocol is followed. This feature facilitates “application” access to Discourse instances without needing to involve moderators. High level description At a high level: Client (desktop app, browser plugin, mobile app) generates a private/public key pair and return url Client redirects to a route on discourse giving discourse its public key Discourse gets approval from user to use app Discourse generat… also these [image] Discourse REST API Documentation Integrations Discourse API Please view the Discourse API Documentation site for detailed info: https://docs.discourse.org information_source Authentication API requests must use HTTP header based authentication. Pass your Api-Key and Api-Username as HTTP headers. Authentication via query parameters or request body is not supported (this was removed in April 2020). Please see the example cURL request below. The only API endpoints that continue to support credentials in query parameters are requests to…

"Api-Key" and "Api-Username" for try.discourse.org?

Development

Tarun_Sharma (Tarun Sharma) January 28, 2025, 10:41am 8

Hi can anyone tell me the difference and usage of Api-key and Api-Username.

Topic		Replies	Views
Allow API use by regular users, not just admins Development rest-api	6	1648	February 14, 2023
User API keys specification Integrations rest-api , reference	69	38589	September 22, 2025
Create apikey for user programmatically as admin Development rest-api	8	2237	February 26, 2024
Access via Discourse API, key and/or user rejected Development rest-api	2	985	December 1, 2023
New to API, 403 Errors Development rest-api	12	3681	August 11, 2017

"Api-Key" and "Api-Username" for try.discourse.org?

Related topics