Admin Dashboard Report Reference Guide

documentation admins
, ,
1

Looking for information about the Admin Dashboard Reports? You’re in the right place!

:bookmark: This is a reference guide for describing how the Admin Dashboard Reports function, the data they’re displaying, the corresponding Data Explorer SQL queries, and where to find the Ruby code for each report.

Admin Dashboard Reports

:exclamation: This post is a Wiki! Feel free to add information here you feel may be helpful for other admins, moderators, or developers using Discourse Reports.

Discourse contains several built-in Admin Dashboard Reports that can be useful for exploring stats about a community. To access these reports, you can visit /admin/dashboard/reports on your site ( or click the Reports link at the top of the dashboard). Note that only staff users will have access to these reports.

image
image1035×129 9.75 KB

Data from all users on a site is included in these reports (including staff activity like visiting admin pages). The only condition that is put on users in the reports is that they are ‘real’ users, which is used to exclude the system user from the reports.

Plugins can also add reports to the dashboard with add_report(name, &block).

:gem: Ruby models for most reports are located at: discourse/app/models/concerns/reports/. Some reports also reference: discourse/app/models/report.rb

:bulb: The dashboard-sql topics contain all of the corresponding SQL queries that can be used to generate reports identical to the Admin Dashboard Reports. These queries can be used within the Data Explorer plugin and for Running Data Explorer queries with the Discourse API

Accepted solutions

Displays daily tally of posts marked as solutions.

Ruby code: discourse-solved/plugin.rb at main · discourse/discourse-solved · GitHub

SQL Query: Dashboard Report - Accepted Solutions

Admin Logins

List of admin login times with locations.

Ruby Code: discourse/app/models/concerns/reports/staff_logins.rb

SQL Query: Dashboard Report - Admin Logins

Anonymous

Number of new pageviews by visitors not logged in to an account.

Ruby Code: discourse/app/models/concerns/reports/consolidated_page_views.rb

SQL Query: Dashboard Report - Anonymous

Bookmarks

Number of new topics and posts bookmarked.

Ruby Code: discourse/app/models/concerns/reports/bookmarks.rb

SQL Query: Dashboard Report - Bookmarks

Consolidated Pageviews

Pageviews for logged in users, anonymous users and crawlers.

Ruby Code: discourse/app/models/concerns/reports/consolidated_page_views.rb

SQL Query: Dashboard Report - Consolidated Pageviews

DAU/MAU

Number of members that logged in in the last day divided by number of members that logged in in the last month – returns a % which indicates community ‘stickiness’. Aim for >20%.

Ruby Code: discourse/app/models/concerns/reports/dau_by_mau.rb

SQL Query: Dashboard Report - DAU/MAU

Daily Engaged Users

Number of users that have liked or posted in the last day.

Ruby Code: discourse/app/models/concerns/reports/daily_engaged_users.rb

SQL Query: Dashboard Report - Daily Engaged Users

Emails Sent

Number of new emails sent.

Ruby Code: discourse/app/models/concerns/reports/emails.rb

SQL Query: Dashboard Report - Emails Sent

Flags

Number of new flags.

Ruby Code: discourse/app/models/concerns/reports/flags.rb

SQL Query: Dashboard Report - Flags

Flags Status

List of flags’ statuses including type of flag, poster, flagger, and time to resolution.

Ruby Code: discourse/app/models/concerns/reports/flags_status.rb

SQL Query: Dashboard Report - Flags Status

Likes

Number of new likes.

Ruby Code: discourse/app/models/concerns/reports/likes.rb

SQL Query: Dashboard Report - Likes

Logged In

Number of new pageviews from logged in users.

Ruby Code: discourse/app/controllers/admin/reports_controller.rb#L5

SQL Query: Dashboard Report - Logged In

Moderator Activity

List of moderator activity including flags reviewed, reading time, topics created, posts created, personal messages created, and revisions.

SQL Query: Dashboard Report - Moderator Activity

Moderator Warning

Number of warnings sent by personal messages from moderators.

Ruby Code: discourse/app/models/concerns/reports/moderator_warning_private_messages.rb

SQL Query: Dashboard Report - Moderator Warnings

New Contributors

Number of users who made their first post during this period.

Ruby Code: discourse/app/models/concerns/reports/new_contributors.rb

SQL Query: Dashboard Report - New Contributors

Notify Moderators

Number of times moderators have been privately notified by a flag.

Ruby Code: discourse/app/models/concerns/reports/notify_moderators_private_messages.rb

SQL Query: Dashboard Report - Notify Moderators

Notify User

Number of times users have been privately notified by a flag.

Ruby Code: discourse/app/models/concerns/reports/notify_user_private_messages.rb

SQL Query: Dashboard Report - Notify User

Overall Sentiment

Number of posts classified either positive or negative with the “Sentiment” AI, over a specified period.

Ruby Code:

SQL Query: Dashboard Report - Overall Sentiment

Pageviews

Number of new pageviews from all visitors. Same as the total for Consolidated Pageviews.

Discourse uses the follow query to determine total pageviews:

SQL Query: Dashboard Report - Consolidated Pageviews

Post Edits

Number of new post edits.

Ruby Code: discourse/app/models/concerns/reports/post_edits.rb

SQL Query: Dashboard Report - Post Edits

Posts

New posts created during the selected time period

Ruby Code: discourse/app/models/concerns/reports/posts.rb

SQL Query: Dashboard Report - Posts

Post Emotion

Number of posts classified by AI with one of following emotions: Sadness, Surprise, Fear, Anger, Joy, Disgust - group by poster trust level, over a specified period.

Ruby Code: discourse-ai/lib/sentiment/entry_point.rb at main · discourse/discourse-ai · GitHub

SQL Query: Dashboard Report - Post Emotion

Reactions

List most recent reactions.

Ruby code: discourse-reactions/plugin.rb at main · discourse/discourse-reactions · GitHub

SQL Query: Dashboard Report - Reactions

Signups

New account registrations for this period.

Ruby Code: discourse/app/models/concerns/reports/signups.rb

SQL Query: Dashboard Report - Signups

Suspicious Logins

Details of new logins that differ suspiciously from previous logins.

Ruby Code: discourse/app/models/concerns/reports/suspicious_logins.rb

SQL Query: Dashboard Report - Suspicious Logins

System

Number of personal messages sent automatically by the System.

Ruby Code: discourse/app/models/concerns/reports/system_private_messages.rb

SQL Query: Dashboard Report - System

Time to first response

Average time (in hours) of the first response to new topics.

Ruby Code: discourse/app/models/concerns/reports/time_to_first_response.rb

SQL Query: Dashboard Report - Time to First Response

Top Ignored / Muted Users

Users who have been muted and/or ignored by many other users.

Ruby Code: discourse/app/models/concerns/reports/top_ignored_users.rb

SQL Query: Dashboard Report - Top Ignored / Muted Users

Top Referred Topics

Topics that have received the most clicks from external sources.

Ruby Code: discourse/app/models/concerns/reports/top_referred_topics.rb

SQL Query: Dashboard Report - Top Referred Topics

Top Referrers

Users listed by number of clicks on links they have shared.

Ruby Code: discourse/app/models/concerns/reports/top_referrers.rb

SQL Query: Dashboard Report - Top Referrers

Top Traffic Sources

External sources that have linked to this site the most.

Ruby Code: discourse/app/models/concerns/reports/top_traffic_sources.rb

SQL Query: Dashboard Report - Top Traffic Sources

Top Uploads

List all uploads by extension, filesize and author.

Ruby Code: discourse/app/models/concerns/reports/top_uploads.rb

SQL Query: Dashboard Report - Top Uploads

Top Users by likes received

Top 10 users who have received likes.

Ruby Code: discourse/app/models/concerns/reports/top_users_by_likes_received.rb

SQL Query: Dashboard Report - Top Users by Likes Received

Top Users by likes received from a user with a lower trust level

Top 10 users in a higher trust level being liked by people in a lower trust level.

Ruby Code: discourse/app/models/concerns/reports/top_users_by_likes_received_from_inferior_trust_level.rb

SQL Query: Dashboard Report - Top Users by Likes Received from a User with a Lower Trust Level

Top Users by likes received from a variety of people

Top 10 users who have had likes from a wide range of people.

Ruby Code: discourse/app/models/concerns/reports/top_users_by_likes_received_from_a_variety_of_people.rb

SQL Query: Dashboard Report - Top Users by Likes Received From a Variety of People

Topics

New topics created during this period.

Ruby Code: discourse/app/models/concerns/reports/topics.rb

SQL Query: Dashboard Report - Topics

Topics with no response

Number of new topics created that did not receive a response.

Ruby Code: discourse/app/models/concerns/reports/topics_with_no_response.rb

SQL Query: Dashboard Report - Topics with No Response

Trending Search Terms

Most popular search terms with their click-through rates.

Ruby Code: discourse/app/models/concerns/reports/trending_search.rb

SQL Query: Dashboard Report - Trending Search Terms

Trust Level growth

Number of users who increased their Trust Level during this period.

The Trust Level Growth report is pulling data from the user_histories table in the Discourse database. Specifically, this report is counting the number of times a user_histories.action is recorded for an increase in a user trust level.

Ruby Code: discourse/app/models/concerns/reports/trust_level_growth.rb

SQL Query: Dashboard Report - Trust Level Growth

Unaccepted policies

This dashboard report identifies topics with policies that have not been accepted by certain users.

Ruby code: discourse-policy/plugin.rb at main · discourse/discourse-policy · GitHub

SQL Query: Dashboard Report - Unaccepted Policies

User Flagging Ratio

List of users ordered by ratio of staff response to their flags (disagreed to agreed).

Ruby Code: discourse/app/models/concerns/reports/user_flagging_ratio.rb

SQL Query: Dashboard Report - User Flagging Ratio

User notes

List most recent user notes.

Ruby code: discourse-user-notes/plugin.rb at main · discourse/discourse-user-notes · GitHub

SQL Query: Dashboard Report - User Notes

User Profile Views

Total new views of user profiles.

Ruby Code: discourse/app/models/concerns/reports/profile_views.rb

SQL Query: Dashboard Report - User Profile Views

User Visits

The total number of user visits in the forum for the selected time period (today, yesterday, last 7 days, etc).

A User Visit is counted anytime a unique logged in user visits the site, up to once per day. For example, if a user visited a site every day within a week, Discourse would count that as 7 user visits.

Ruby Code: discourse/app/models/concerns/reports/visits.rb

SQL Query: Dashboard Report - User Visits

User Visits (mobile)

Number of unique users who visited using a mobile device.

Ruby Code: discourse/app/models/concerns/reports/mobile_visits.rb

SQL Query: Dashboard Report - User Visits

User-to-User (excluding replies)

Number of newly initiated personal messages.

Ruby Code: discourse/app/models/concerns/reports/user_to_user_private_messages.rb

SQL Query: Dashboard Report - User-to-User

User-to-User (with replies)

Number of all new personal messages and responses.

Ruby Code: discourse/app/models/concerns/reports/user_to_user_private_messages_with_replies.rb

SQL Query: Dashboard Report - User-to-User

Users per Trust Level

Number of users grouped by trust level.

Ruby Code: discourse/app/models/concerns/reports/users_by_trust_level.rb

SQL Query: https://meta.discourse.org/t/dashboard-report-users-per-trust-level/288565

Users per Type

Number of users grouped by admin, moderator, suspended, and silenced.

Ruby Code: discourse/app/models/concerns/reports/users_by_type.rb

SQL Query: https://meta.discourse.org/t/dashboard-report-users-per-type/288569

Web Crawler Pageviews

Total pageviews from web crawlers over time.

Ruby Code: discourse/app/models/report.rb

SQL Query: https://meta.discourse.org/t/dashboard-report-web-crawler-pageviews/294745

Web Crawler User Agents

List of web crawler user agents, sorted by pageviews.

Ruby Code: discourse/app/models/concerns/reports/web_crawlers.rb

SQL Query: https://meta.discourse.org/t/dashboard-report-web-crawler-user-agents/294762

14 Likes
3

I don’t see a link to this on /admin. Am I failing to read? It would seem that this should be more discoverable. I think that I knew that these reports were here but looked and couldn’t find them.

Though it took me just a few minutes to find, it might be nice to add something like

3 Likes
4

Screenshot 2022-09-28 at 08-26-34 Admin - Sandbox Discourse Kit
Screenshot 2022-09-28 at 08-26-34 Admin - Sandbox Discourse Kit1103×139 12.6 KB

Yeah, might be nice in a PM to staff to mention them when a site is first created. :thinking:

1 Like
5

:crying_cat_face:

Sorry. I sure thought I’d seen it somewhere before.

You just can’t get people to read stuff. . . .Except I could read the source code to find how to do it in a plugin?

But maybe update the above to

I think that might be what really threw me. (But no, I have no excuse.)

6

I made the topic a wiki, go for it! :+1:

2 Likes
7

That doesn’t match the UI (the UI uses 20%), which one should it be?

2 Likes
8

Nice catch. It was recently updated to 20%. I’ll make the change in the OP. :slight_smile: :+1:

2 Likes
13

Hi @SaraDev Can this report output be obtained with an SQL query? Can you share it?
Thanks

1 Like
14

Yes, you can use the following SQL report for Top Traffic Sources:

-- [params]
-- date :start_date = 01/05/2023
-- date :end_date = 03/06/2023

WITH count_links AS (
  
SELECT COUNT(*) AS clicks,
       ind.name AS domain
FROM incoming_links il
  INNER JOIN posts p ON p.deleted_at ISNULL AND p.id = il.post_id
  INNER JOIN topics t ON t.deleted_at ISNULL AND t.id = p.topic_id
  INNER JOIN incoming_referers ir ON ir.id = il.incoming_referer_id
  INNER JOIN incoming_domains ind ON ind.id = ir.incoming_domain_id
WHERE t.archetype = 'regular'
  AND il.created_at::date BETWEEN :start_date AND :end_date 
GROUP BY ind.name
ORDER BY clicks DESC
), 

count_topics AS (
  
SELECT COUNT(DISTINCT p.topic_id) AS topics,
       ind.name AS domain
FROM incoming_links il
INNER JOIN posts p ON p.deleted_at ISNULL AND p.id = il.post_id
INNER JOIN topics t ON t.deleted_at ISNULL AND t.id = p.topic_id
INNER JOIN incoming_referers ir ON ir.id = il.incoming_referer_id
INNER JOIN incoming_domains ind ON ind.id = ir.incoming_domain_id
WHERE t.archetype = 'regular'
  AND il.created_at > (CURRENT_TIMESTAMP - INTERVAL '30 DAYS')
GROUP BY ind.name
) 

SELECT cl.domain, 
       cl.clicks AS "Clicks", 
       ct.topics AS "Topics"
FROM count_links cl
JOIN count_topics ct ON cl.domain = ct.domain
LIMIT 10

With this query note that the date parameters accepts dates in the format of day/month/year.

1 Like
16

Hi @SaraDev, thank you for sharing the query.
A more general question reg this report, and the incoming_links table actually - it only represents traffic for posts pages and not the traffic to all the forum pages, right?

Context: I’m looking to analyze trends in the forum overall traffic and I was hoping to get the overall traffic by sources from the Top Traffic Sources report.
But while the overall traffic is ~ 272K in the last month (users and anons), the total clicks in the traffic sources report for the same timeframe is only 59K.
Also, I see that you use inner join with the topics and posts tables which means that if there is no post_id attached to the click you don’t count it.

Can you please confirm my conclusion and perhaps explain a bit about the logic behind the incoming_links table?

17

Hi @SaraDev I ran this query and the result does not precisely match the Posts report in the general tab.
E.G for Nov 30th:
Query = 112 posts
Report = 120 posts
Can you please check the gap?
Thanks

1 Like
18

Just an FYI @Yotam_Hagay - even though Sara’s the OP, the guide is the responsibility of everyone :slight_smile: :discourse: There’s no need for an @mention on each post. :slight_smile:

2 Likes
19

Thank you @JammyDodger for clarifying.
Is there anyone else I can tag or turn to to get an answer?

1 Like
20

The results of this query are slightly different than the Time to first response report:
On November 8th for example:
Query: 93 Hours
Report: 116 Hours
Can someone advise?

1 Like
21

I think some of these may take some time to research. I’m having a look into it myself to see if I can see what’s going on (though the gap between my SQL skills and my ruby skills is quite large :slight_smile:).

But keep the findings coming as it would be great to firm all this information up. :+1:

2 Likes
22

For the Posts one, I think the stock report is also counting topic posts as well as ones from system users, but also only targeting those with post_type 1 (that is, not whispers, small action posts, or moderator actions)

I think the SQL would look more like this:

--[params]
-- date :start_date
-- date :end_date

SELECT 
    p.created_at::date AS "Day",
    COUNT(p.id) AS "Count"
FROM posts p
INNER JOIN topics t ON t.id = p.topic_id AND t.deleted_at ISNULL
WHERE p.created_at::date BETWEEN :start_date AND :end_date
    AND p.deleted_at ISNULL
    AND t.archetype = 'regular'
    AND p.post_type = 1
GROUP BY p.created_at::date
ORDER BY 1

Could you run that on your site and see if it marries up?

2 Likes
23

Thanks Jammy, will check!
I’m currently working on a Time to first response analysis so I’d appreciate if you could take a look at this one as well.

1 Like
24

Having a look at the SQL version, I think it’s missing the AND p.user_id <> t.user_id to exclude replies from the OP. If I add that in it gives me the accurate time between the OP and the first response from someone else:

--[params]
-- date :date_start
-- date :date_end

WITH first_reply AS (
    SELECT 
        p.topic_id, 
        MIN(post_number) post_number, 
        t.created_at
    FROM posts p
    INNER JOIN topics t ON (p.topic_id = t.id)
    WHERE p.deleted_at IS NULL
        AND p.user_id <> t.user_id
        AND p.post_number != 1
        AND p.post_type = 1
        AND p.user_id > 0
        AND t.user_id > 0
        AND t.deleted_at IS NULL
        AND t.archetype = 'regular'
        AND t.created_at::date BETWEEN :date_start AND :date_end
    GROUP BY p.topic_id, t.created_at
    ORDER BY 2 DESC
)

SELECT 
    p.topic_id, 
    fr.created_at::date dt_topic_created,
    (p.created_at - fr.created_at) response_time
FROM posts p
INNER JOIN first_reply fr 
    ON fr.topic_id = p.topic_id 
    AND fr.post_number = p.post_number
    AND p.created_at > fr.created_at
ORDER BY response_time

I also think the stock report is in decimal rather than hours and minutes like the SQL. I’ll have another crack at getting it to match. :+1:

Just a small update to include the AVG so it’s more similar to the output of the stock report:

--[params]
-- date :date_start
-- date :date_end

WITH first_reply AS (
    SELECT 
        p.topic_id, 
        MIN(post_number) post_number, 
        t.created_at
    FROM posts p
    INNER JOIN topics t ON p.topic_id = t.id
    WHERE p.deleted_at IS NULL
        AND p.user_id <> t.user_id
        AND p.post_type = 1
        AND p.user_id > 0
        AND t.user_id > 0
        AND t.deleted_at IS NULL
        AND t.archetype = 'regular'
        AND t.created_at::date BETWEEN :date_start AND :date_end
    GROUP BY p.topic_id, t.created_at
)

SELECT 
    fr.created_at::date dt_topic_created,
    AVG(p.created_at - fr.created_at) response_time
FROM posts p
INNER JOIN first_reply fr 
    ON fr.topic_id = p.topic_id 
    AND fr.post_number = p.post_number
    AND p.created_at > fr.created_at
GROUP BY fr.created_at::date
ORDER BY response_time

This seems to marry up with the stock report as long as you take into account that one is in decimal and one in HH:MM. I’m sure there’s a way to convert the SQL response_time to decimal but the HH:MM seems like a more intuitive way of doing it. (I think there are also some extra criteria in there that may not be necessary, but also could be a safety guard against unusual circumstances, so I’ve ultimately left those bits as is until I can say for sure one way or the other :slight_smile:)

Could you run this one and see how it matches up?

3 Likes
25

Yes, it now adds up to the numbers shown in the stock report, thank you!
Just one comment -
I found that the Avg function below brings back missing results in case the time is > 24h (a # of days section is missing I guess).

AVG(p.created_at - fr.created_at)::time response_time

1 Like
26

Ah yes, casting to time was a poor choice. :slight_smile: If you remove the ::time it will revert back to the more accurate (though harder on the eyes) version.

I’ll edit the one above as well. :+1:

2 Likes