LoudVoice API \ Discussions \ List discussion comments

Resource/URI - Discussions GET POST PUT DELETE
Discussions /loudvoice/discussions.json List all discussions Create a discussion – –
Discussion /loudvoice/discussions/<discussion_token>.json Read a discussion – Update a discussion Delete a discussion
Discussion messages /loudvoice/comments/<discussion_token>/comments.json Read discussion comments – – –
Resource/URI - Authors GET POST PUT DELETE
Authors /loudvoice/authors.json List all authors Create an author – –
Author /loudvoice/authors/<author_token>.json Read an author – Update an author Delete an author
Resource/URI - Author Sessions GET POST PUT DELETE
Author Sessions /loudvoice/authors/sessions.json List all sessions – Create or update a session –
Author Session /loudvoice/authors/sessions/<session_token>.json – – – Delete a session
Resource/URI - Comments GET POST PUT DELETE
Comments /loudvoice/comments.json List all comments Create a comment – –
Comment /loudvoice/comments/<comment_token>.json Read a comment – Update a comment Delete a comment
Resource/URI - Votes GET POST PUT DELETE
Votes /loudvoice/votes.json List all
votes 		– – –
Vote /loudvoice/votes/comments/<comment_token>/authors/<author_token>.json Read a vote – Cast a vote Delete a vote

Workflow

Request: the code to send to the API

Send an API request to one of these endpoints in order to retrieve the comments of a discussion:

GET /loudvoice/discussion/<discussion_token>/comments>.json
GET /loudvoice/discussions/discussion/comments.json?discussion_reference=<discussion_reference>

The <discussion_token> represents the unique identifier of the discussion. The <discussion_reference> is the unique reference that you optionally specified when you created the discussion.

The following fields may optionally be used to the filter the resultset.

Field Supported Operators
parent_comment_token eq, neq
is_spam eq, neq
is_trashed eq, neq
has_been_approved eq, neq

Result: the code returned by the API

The API will either return a HTTP status code 200 on success or an appropriate message body with further details on the error that occured. Requests that return multiple entries will be paginated to 250 items by default.

Example Resultset

{
  "response": {
    "request": {
      "date": "Mon, 19 Mar 2018 15:20:02 +0100",
      "resource": "/loudvoice/discussions/74306343-9b4c-42cd-978c-f0181b6e9589/comments.json",
      "status": {
        "flag": "success",
        "code": 200,
        "info": "Your request has been processed successfully"
      }
    },
    "result": {
      "data": {
        "discussion": {
          "discussion_token": "74306343-9b4c-42cd-978c-f0181b6e9589",
          "discussion_reference": "PAGE-3242",
          "date_creation": "Wed, 14 Mar 2018 14:18:30 +0100",
          "title": "Loudvoice Documentation",
          "url": "http://docs.oneall.com/api/resources/loudvoice/",
          "is_closed": false,
          "is_trashed": false,
          "num_comments": 2,
          "date_last_comment": "Wed, 14 Mar 2018 14:19:31 +0100",
          "date_last_update": null
        },
        "comments": {
          "pagination": {
            "current_page": 1,
            "total_pages": 1,
            "entries_per_page": 250,
            "total_entries": 2,
            "order": {
              "field": "date_creation",
              "direction": "asc"
            }
          },
          "count": 2,
          "entries": [
            {
              "comment_token": "47c30277-6537-48be-81a8-04eaae6f0234",
              "has_been_approved": true,
              "is_spam": false,
              "is_trashed": false,
              "post_order": "1",
              "date_creation": "Wed, 14 Mar 2018 14:18:30 +0100",
              "ip_address": "172.20.0.1",
              "text": "My comment !",
              "author": {
                "author_token": "e570f17a-f018-49f2-be95-35dd31105c93",
                "author_reference": "my-custom-reference",
                "date_creation": "Wed, 14 Mar 2018 14:18:55 +0100",
                "name": "John Doe",
                "email": "john@oneall.com",
                "description": "An unknown author",
                "website_url": "http://example.com",
                "num_comments": "2",
                "date_last_comment": "Wed, 14 Mar 2018 14:19:49 +0100"
              }
            },
            {
              "comment_token": "fbb332e6-e8f7-43c9-a953-129ada39e134",
              "has_been_approved": true,
              "is_spam": true,
              "is_trashed": false,
              "post_order": "2",
              "date_creation": "Wed, 14 Mar 2018 14:19:30 +0100",
              "ip_address": "172.20.0.1",
              "text": "Hi !",
              "author": {
                "author_token": "94518346-8531-4655-8c86-6cc421dd39ae",
                "date_creation": "Wed, 14 Mar 2018 16:52:15 +0100",
                "name": "Jane Doe",
                "num_comments": "0",
                "date_last_comment": "Thu, 01 Jan 1970 01:00:00 +0100"
              }
            }
          ]
        }
      }
    }
  }
}

User Contributed Notes