Welcome to the Discussion API

                                  ___......__             _
                              _.-'           ~-_       _.=a~~-_
      --=====-.-.-_----------~   .--.       _   -.__.-~ ( ___==>
                    '''--...__  (    \ \\\ { )       _.-~
                              =_ ~_  \\-~~~//~~~~-=-~
                               |-=-~_ \\   \\
                               |_/   =. )   ~}
                               |}      ||
                              //       ||
                            _//        {{
                         '='~'          \\_
                                         ~~'

Examples

The following links demonstrate some of the more common uses of the Discussion API: All requests support a callback parameter for JSONP support. Note that it is currently not possible to get a list of discussions.

Routes

Method Path Slug Description Examples
GET /abuse/categoryGetAllAbuseCategoriesReturn all abuse categories/abuse/category
GET /comment/:idGetCommentGet a comment/comment/12500137, /comment/12500137?displayResponses=true, /comment/12500137?displayResponses=true&displayThreaded=true
GET /comment/:id/contextGetCommentContextReturns the discussion url, key, and page number on which the comment appears in the discussion. Useful for permalinks./comment/12500137/context
POST /comment/:id/highlightPostHighlightToCommentPost a highlight to an existing unhighlighted comment
GET /comment/:id/permalinkGetCommentPermalinkRedirect to a comment permalink/comment/1250013/permalink
POST /comment/:id/recommendRecommendCommentPost a user recommendation to an existing comment
POST /comment/:id/reportAbuseReportAbuseOnCommentReportAbuse on an existing comment
POST /comment/:id/unhighlightPostUnhighlightToCommentPost an unhighlight to an existing highlighted comment
POST /comment/highlightHighlightCommentHighlights the comment with Anti-spam bad words
POST /comment/previewPreviewCommentFormats the comment into the allowed html
GET /discussion/:keyGetDiscussionGet a discussion/discussion//p/2y7gc, /discussion/isbn:9780387988979
POST /discussion/:key/commentPostNewCommentPost a new comment to a discussion
POST /discussion/:key/comment/:id/replyPostReplyToCommentPost a reply to an existing comment
GET /discussion/:key/comments/countGetCommentCountGet the number of visible comments recorded for a discussion/discussion//p/2y7gc/comments/count
GET /discussion/:key/featuredcommentsGetFeaturedCommentsGet the featured comments for a discussion as a flat list/discussion/p/3vkt9/featuredcomments
GET /discussion/:key/highlightsGetDiscussionHighlightsGet the highlighted comments for a discussion as a flat list/discussion//p/2y7gc/highlights
GET /discussion/:key/recommendedGetRecommendedCommentsForDiscussionGet the comments for a discussion as a flat list ordered according to user recommendation/discussion//p/2y7gc/recommended
GET /discussion/:key/staff-commentsGetStaffCommentsGet all staff comments to a discussion
GET /discussion/:key/topcommentsGetDiscussionTopCommentsGet the top comments for a discussion as a flat list/discussion/p/2y7gc/topcomments
GET /discussion/most/staffGetMostStaffCommentsSinceGet most staff comments since(timestamp)/discussion/most/staff
POST /discussionsUpdateDiscussionsCreates or updates an array of discussions
GET /getCommentCountsGetCommentCountsGet the number of visible comments recorded for discussions provided in the short-urls param/getCommentCounts?short-urls=/p/37v3a,/p/36qah&callback=getCommentCounts
GET /healthcheckGetCDNHealthcheckBasic healthcheck for CDN and ELB.
GET /modtoolsearch/commentsSearchCommentsSearch for profiles in elasticsearch
GET /modtoolsearch/discussionsSearchDiscussionsSearch for profiles in elasticsearch
GET /modtoolsearch/profilesSearchProfilesSearch for profiles in elasticsearch
GET /most/commentsGetMostCommentsSinceGet most comments since(timestamp)/most/comments
GET /oembedOembedOembed endpoint for a single comment./oembed?id=8436585, /oembed?url=https://discussion.theguardian.com/comment-permalink/8436585
GET /popularGetMostPopularGet most popular/popular
GET /profile/:userIdGetProfileGet a user profile/profile/3853811, /profile/me
PATCH /profile/:userIdUpdateProfileUpdate a users profile/profile/3853811
GET /profile/:userId/commentsGetAllCommentsForUserGet all comments posted by user/profile/3853811/comments
GET /profile/:userId/discussionsGetAllDiscussionsForUserGet all discussions the user has commented on/profile/3853811/discussions
GET /profile/:userId/repliesGetAllRepliesToAUserGet all comments that have been posted in response by user/profile/3853811/replies
POST /profile/:userId/reportAbuseReportAbuseOnProfileReport abuse on an existing profile
GET /profile/:userId/statsGetProfileStatsReturns a count of comments posted, comments picked, and total recommends received./profile/3853811/stats
GET /profile/displayName/:displayNameGetProfileByDisplayNameGet user profiles for a given display name/profile/displayName/nicl
GET /profile/stats/lastSyncGetLastIdentitySyncGet the last identity sync time/profile/stats/lastSync
GET /recent/highlightedGetRecentHighlightedCommentsGet recent comments that have been highlighted/recent/highlighted
GET /recent/highlighted/for/:key"GetRecentHighlightedCommentsForDiscussionGet recent comments that have been highlighted for an article/recent/highlighted/for//p/2y7gc
GET /recent/recommendedGetRecentRecommendedCommentsGet recent comments that have been recommended/recent/recommended
POST /scoreGetCommentScoreGet a comment toxicity score/score
GET /search/profile/:userIdSearchTextInUserCommentsSearch for occurrences of text within a given user's comments
GET /switchboardGetSwitchBoardStateGet current dynamo state
POST /switchboardUpdateDynamoSwitchboardUpdate a dynamoDb switch