Developers » API methods » Widgets » widgets.getPages
Widgetswidgets.getPages
Gets a list of application/site pages where the Comments widget or Like widget is installed.
This method can be called by a service token. Only public data is returned.
This method can be called with a user token.
Parameters
widget_api_id
int (number)
order
string, default friend_likes
period
string, default week
offset
positive number, default 0
count
positive number, default 10, minimum value 10, maximum value 200
Result
Returns an object with the following fields:
  • count Total number of pages (without taking into account the count parameter);
  • pages List of page objects, each containing the following fields:
    • id Page ID in the system.
    • title Page title (from the page's meta tags or as set by the pageTitle parameter during initialization).
    • description Short description of the page (from the page's meta tags or as set by the pageDescription parameter during initialization).
    • photo Object containing a page thumbnail (from the page's meta tags or as set by the pageImage parameter during initialization).
    • url Absolute URL address of the page.
    • likes Object containing a count field showing the number of page Likes. Use likes.getList method with the type parameter set to site_page to get a list of users who like the page.
    • comments Object containing a count field showing the number of page comments within the widget. Use widgets.getComments method to get a list of comments.
    • date Date when the widgets were invoked on the page for the first time.
    • page_id Internal ID of an application/site page (if the page_id parameter was used during widget initialization).

Errors
Global errors can occur while running. See their descriptions on this page.