Topics

Get the top topics filtered by period

GET

https://discourse.example.com/top.json

curl -X GET 'https://discourse.example.com/top.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string'

const response = await fetch('https://discourse.example.com/top.json', {
  method: 'GET',
  headers: {
    'Api-Key': 'string',
    'Api-Username': 'string',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://discourse.example.com/top.json',
    headers={
        'Api-Key': 'string',
        'Api-Username': 'string',
    },
)
print(response.text)

200

{
  "users": [
    {
      "id": 0,
      "username": "string",
      "name": "string",
      "avatar_template": "string"
    }
  ],
  "primary_groups": [],
  "topic_list": {
    "can_create_topic": true,
    "draft": "string",
    "draft_key": "string",
    "draft_sequence": 0,
    "for_period": "string",
    "per_page": 0,
    "topics": [
      {
        "id": 0,
        "title": "string",
        "fancy_title": "string",
        "slug": "string",
        "posts_count": 0,
        "reply_count": 0,
        "highest_post_number": 0,
        "image_url": "string",
        "created_at": "string",
        "last_posted_at": "string",
        "bumped": true,
        "bumped_at": "string",
        "archetype": "string",
        "unseen": true,
        "last_read_post_number": 0,
        "unread_posts": 0,
        "pinned": true,
        "unpinned": true,
        "visible": true,
        "closed": true,
        "archived": true,
        "notification_level": 0,
        "bookmarked": true,
        "liked": true,
        "views": 0,
        "like_count": 0,
        "has_summary": true,
        "last_poster_username": "string",
        "category_id": 0,
        "op_like_count": 0,
        "pinned_globally": true,
        "featured_link": "string",
        "posters": [
          {
            "extras": "string",
            "description": "string",
            "user_id": 0,
            "primary_group_id": 0
          }
        ]
      }
    ]
  }
}

Parameters

periodstringquery

Enum: all, yearly, quarterly, monthly, weekly, daily

per_pageintegerquery

Maximum number of topics returned, between 1-100

Response

200OKobject

response

Response fields application/json

usersArray<object>

Show child attributes

idinteger

usernamestring

namestring

avatar_templatestring

primary_groupsArray<any>

topic_listobject

Show child attributes

can_create_topicboolean

draftstring | null

draft_keystring

draft_sequenceinteger

for_periodstring

per_pageinteger

topicsArray<object>

Show child attributes

idinteger

titlestring

fancy_titlestring

slugstring

posts_countinteger

reply_countinteger

highest_post_numberinteger

image_urlstring | null

created_atstring

last_posted_atstring

bumpedboolean

bumped_atstring

archetypestring

unseenboolean

last_read_post_numberinteger

unread_postsinteger

pinnedboolean

unpinnedboolean

visibleboolean

closedboolean

archivedboolean

notification_levelinteger

bookmarkedboolean

likedboolean

viewsinteger

like_countinteger

has_summaryboolean

last_poster_usernamestring

category_idinteger

op_like_countinteger

pinned_globallyboolean

featured_linkstring | null

postersArray<object>

Show child attributes

extrasstring | null

descriptionstring

user_idinteger

primary_group_idinteger | null

Docs by Sourcey