getBlogsWithOffset

Previous page  First page  Next page

Description

Allows you to request blog information using pagination to control the number of blogs returned. Search parameters may also be used to find blogs with a specific status, component profile, or transfer-usage upgrade setting.

This command replaces the deprecated getBlogs command.

 

 

Syntax

reseller.getBlogsWithOffset(version, username, password, limit=100, offset=0)

 

 

Request Fields

 

version - Specifies the version number of the API. Set this to "1.3".  This value is currently ignored, but will be useful for API changes in future versions.

 

username - Your reseller account username.

 

password - Your reseller account password.

 

limit - Optional - The maximum number of blogs to return, to a maximum of 100.  By default, the limit is 100.

 

offset - Optional - The starting number from which to return blogs.  For example, if limit = 5 and offset = 10, five blogs will be returned, starting with blog # 10 and ending with blog # 14.  By default, the offset is '0'.

 

constraints - Optional - constraints is a hash of search parameters.  Returns a list of getBlogInfo structs that meet the supplied search parameters.  A maximum of 100 blogs are returned at a time.  Supported search parameters are

status - Optional - string

componet_profile - Optional - string

auto_transfer_uagrade_allowed - Optional - Boolean

 

 

Response Fields

Returns list of reseller.getBlogInfo structs based on a given offset and a maximum of 100 entries.

 

This command also returns:

 

monthly_num_xml_views - returns the cumulative XML requests for a particular blog for the current month (i.e. from the 1st of the month to the current day).

 

monthly_num_html_views - returns the cumulative HTML requests for a particular blog for the current month (i.e. from the 1st of the month to the current day).