List Blog Post Summary REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:44:31 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:44:31

GET api.ashx/v2/blogs/{blogid}/postsummaries.{json|xml}

LIST post summaries by blog.

Scopes

Blogs › Read Post Summaries blogs.postsummaries.readonly

Request Parameters

Name	Type	Description	Required
BlogId	int?	Blog Id	Required
Month	DateTime?	A DateTime value. When provided, returns counts per day of month. Otherwise, returns counts per month.	Optional
PageIndex	int?	Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.	Optional
PageSize	int?	Specify the number of results to return per page. If not set the default is 20. The max is 100.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/blogs/{blogid}/postsummaries.json',
	data: { 
		'blogid': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "PageSize": 2,
  "PageIndex": 0,
  "TotalCount": 2,
  "PostSummaries": [
    {
      "Date": "2012-01-04T00:00:00",
      "Count": 6
    },
    {
      "Date": "2012-05-02T00:00:00",
      "Count": 25
    }
  ],
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <PostSummaries PageSize="2" PageIndex="0" TotalCount="2">
    <PostSummary>
      <Date>2012-01-04T00:00:00</Date>
      <Count>6</Count>
    </PostSummary>
    <PostSummary>
      <Date>2012-05-02T00:00:00</Date>
      <Count>25</Count>
    </PostSummary>
  </PostSummaries>
</Response>