List Comment Summary REST Endpoint

GET api/v2/comments/summaries.{json|xml}

Scopes

Comments › Read Comment Summaries comments.summaries.readonly

Request Parameters

Name	Type	Location	Description	Required	Default
AuthorId	int	Query String	Author Id of the content with comments.	Optional
ContentTypeIds	Guid	Query String	Comma separated list of Content type Ids to filter content by.	Optional
MaximumCommentCount	int	Query String	Maximum number of comments content must can to be returned.	Optional
MinimumCommentCount	int	Query String	Minimum number of comments content must have to be returned.	Optional
PageIndex	int	Query String	Page index to retrieve	Optional	0
PageSize	int	Query String	Page size to retrieve	Optional	20
SortBy	string	Query String	Accepted values are: CreatedDate, CommentCount (default)	Optional	CommentCount
SortOrder	string	Query String	Accepted values are: Ascending, Descending	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api/v2/comments/summaries.json'
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "CommentSummary": [{"CommentCount":6,"Content":{"CreatedByUser":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":null,"Id":null},"Body":"body","CreatedDate":"2012-01-04T00:00:00","ReplyCount":25,"Group":{"AvatarUrl":"avatarurl","DateCreated":null,"Description":"description","Key":"key","Name":"name","ParentGroupId":null,"Url":"url","TotalMembers":null,"HasGroups":true,"GroupCount":null,"GroupType":"grouptype","EnableGroupMessages":true,"EnableContact":true,"SearchUniqueId":"searchuniqueid","IsEnabled":true,"ExtendedAttributes":[],"ContainerId":"49fec544-6df7-4a82-872b-f8be586d5e9e","ContainerTypeId":"23b05a61-c3e5-4451-90d9-bfa00453bce4","Container":null,"Id":null},"AttachedUrl":"attachedurl","HasReplies":true,"Replies":[],"ContentId":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":{"CreatedByUser":null,"ContentId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","ContentTypeId":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","CreatedDate":"2012-05-02T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":null},"Id":"9ba1ec43-dc34-4e27-a579-4a0855144e2f"},"Id":8},"ContentId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","ContentTypeId":"6cdcf200-3bad-476d-af45-97b52545c337","CreatedDate":"2012-06-04T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":{"ApplicationId":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","ApplicationTypeId":"44df201a-07e6-42eb-96c7-8ce7ce35aab6","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Container":{"ContainerId":"49fec544-6df7-4a82-872b-f8be586d5e9e","ContainerTypeId":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"}}}},{"CommentCount":4,"Content":{"CreatedByUser":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":{"Author":{"AvatarUrl":"avatarurl","DisplayName":"displayname","ProfileUrl":"profileurl","Username":"username","CurrentStatus":null,"Id":null},"Body":"body","CreatedDate":"2011-05-28T00:00:00","ReplyCount":7,"Group":{"AvatarUrl":"avatarurl","DateCreated":null,"Description":"description","Key":"key","Name":"name","ParentGroupId":null,"Url":"url","TotalMembers":null,"HasGroups":true,"GroupCount":null,"GroupType":"grouptype","EnableGroupMessages":true,"EnableContact":true,"SearchUniqueId":"searchuniqueid","IsEnabled":true,"ExtendedAttributes":[],"ContainerId":"fe65240b-044c-4292-9946-f10e0361ecff","ContainerTypeId":"23b05a61-c3e5-4451-90d9-bfa00453bce4","Container":null,"Id":null},"AttachedUrl":"attachedurl","HasReplies":true,"Replies":[],"ContentId":"6cdcf200-3bad-476d-af45-97b52545c337","ContentType":"56f1a3ec-14bb-45c6-949f-ee7776d68c78","Url":"url","IsPublished":true,"Content":{"CreatedByUser":null,"ContentId":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","ContentTypeId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","CreatedDate":"2011-12-09T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":null},"Id":"6cdcf200-3bad-476d-af45-97b52545c337"},"Id":27},"ContentId":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","ContentTypeId":"44df201a-07e6-42eb-96c7-8ce7ce35aab6","CreatedDate":"2012-03-29T00:00:00","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Application":{"ApplicationId":"49fec544-6df7-4a82-872b-f8be586d5e9e","ApplicationTypeId":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Container":{"ContainerId":"fe65240b-044c-4292-9946-f10e0361ecff","ContainerTypeId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"}}}}],
  "Errors": ["string","string"]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <CommentSummary PageSize="2" PageIndex="0" TotalCount="2">
    <RestCommentSummary>
      <CommentCount>6</CommentCount>
      <Content>
        <CreatedByUser>
          <Id>8</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DisplayName>displayname</DisplayName>
          <ProfileUrl>profileurl</ProfileUrl>
          <Username>username</Username>
          <CurrentStatus>
            <Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id>
            <Author>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </Author>
            <Body>body</Body>
            <CreatedDate>2012-01-04T00:00:00</CreatedDate>
            <ReplyCount>25</ReplyCount>
            <Group>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DateCreated />
              <Description>description</Description>
              <Key>key</Key>
              <Name>name</Name>
              <Url>url</Url>
              <TotalMembers />
              <HasGroups>true</HasGroups>
              <GroupCount />
              <GroupType>grouptype</GroupType>
              <EnableGroupMessages>true</EnableGroupMessages>
              <EnableContact>true</EnableContact>
              <SearchUniqueId>searchuniqueid</SearchUniqueId>
              <ExtendedAttributes />
              <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
            </Group>
            <AttachedUrl>attachedurl</AttachedUrl>
            <HasReplies>true</HasReplies>
            <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId>
            <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
            <Url>url</Url>
            <IsPublished>true</IsPublished>
            <Content>
              <ContentId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContentId>
              <ContentTypeId>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</ContentTypeId>
              <CreatedDate>2012-05-02T00:00:00</CreatedDate>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Content>
          </CurrentStatus>
        </CreatedByUser>
        <ContentId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentId>
        <ContentTypeId>6cdcf200-3bad-476d-af45-97b52545c337</ContentTypeId>
        <CreatedDate>2012-06-04T00:00:00</CreatedDate>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Application>
          <ApplicationId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ApplicationId>
          <ApplicationTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ApplicationTypeId>
          <HtmlName>htmlname</HtmlName>
          <HtmlDescription>htmldescription</HtmlDescription>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
          <Container>
            <ContainerId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContainerId>
            <ContainerTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContainerTypeId>
            <HtmlName>htmlname</HtmlName>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
          </Container>
        </Application>
      </Content>
    </RestCommentSummary>
    <RestCommentSummary>
      <CommentCount>4</CommentCount>
      <Content>
        <CreatedByUser>
          <Id>27</Id>
          <AvatarUrl>avatarurl</AvatarUrl>
          <DisplayName>displayname</DisplayName>
          <ProfileUrl>profileurl</ProfileUrl>
          <Username>username</Username>
          <CurrentStatus>
            <Id>6cdcf200-3bad-476d-af45-97b52545c337</Id>
            <Author>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DisplayName>displayname</DisplayName>
              <ProfileUrl>profileurl</ProfileUrl>
              <Username>username</Username>
            </Author>
            <Body>body</Body>
            <CreatedDate>2011-05-28T00:00:00</CreatedDate>
            <ReplyCount>7</ReplyCount>
            <Group>
              <Id />
              <AvatarUrl>avatarurl</AvatarUrl>
              <DateCreated />
              <Description>description</Description>
              <Key>key</Key>
              <Name>name</Name>
              <Url>url</Url>
              <TotalMembers />
              <HasGroups>true</HasGroups>
              <GroupCount />
              <GroupType>grouptype</GroupType>
              <EnableGroupMessages>true</EnableGroupMessages>
              <EnableContact>true</EnableContact>
              <SearchUniqueId>searchuniqueid</SearchUniqueId>
              <ExtendedAttributes />
              <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
            </Group>
            <AttachedUrl>attachedurl</AttachedUrl>
            <HasReplies>true</HasReplies>
            <ContentId>6cdcf200-3bad-476d-af45-97b52545c337</ContentId>
            <ContentType>56f1a3ec-14bb-45c6-949f-ee7776d68c78</ContentType>
            <Url>url</Url>
            <IsPublished>true</IsPublished>
            <Content>
              <ContentId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ContentId>
              <ContentTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ContentTypeId>
              <CreatedDate>2011-12-09T00:00:00</CreatedDate>
              <HtmlName>htmlname</HtmlName>
              <HtmlDescription>htmldescription</HtmlDescription>
              <Url>url</Url>
              <AvatarUrl>avatarurl</AvatarUrl>
            </Content>
          </CurrentStatus>
        </CreatedByUser>
        <ContentId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContentId>
        <ContentTypeId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</ContentTypeId>
        <CreatedDate>2012-03-29T00:00:00</CreatedDate>
        <HtmlName>htmlname</HtmlName>
        <HtmlDescription>htmldescription</HtmlDescription>
        <Url>url</Url>
        <AvatarUrl>avatarurl</AvatarUrl>
        <Application>
          <ApplicationId>49fec544-6df7-4a82-872b-f8be586d5e9e</ApplicationId>
          <ApplicationTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ApplicationTypeId>
          <HtmlName>htmlname</HtmlName>
          <HtmlDescription>htmldescription</HtmlDescription>
          <Url>url</Url>
          <AvatarUrl>avatarurl</AvatarUrl>
          <Container>
            <ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
            <ContainerTypeId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</ContainerTypeId>
            <HtmlName>htmlname</HtmlName>
            <Url>url</Url>
            <AvatarUrl>avatarurl</AvatarUrl>
          </Container>
        </Application>
      </Content>
    </RestCommentSummary>
  </CommentSummary>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

Recommended