Skip to main content

Using Sitebuilder data feeds

There are a number of Sitebuilder data feeds that can be accessed. Some are specific to pages created from particular templates (e.g. News pages, Calendar pages etc) but some are available for any page. The easiest way to find out whether a feed type is available is simply to try it out.

To get authenticated versions of these feeds for API use, you must access the feeds over HTTPS, not HTTP. Specifying the forcebasic=true parameter will send a HTTP Basic authentication challenge if Basic auth is not specified. There is an example of doing this for the page information API in the Getting Started with the Sitebuilder API page.

Most feeds are available in RSS and Atom, for feed readers, and JSON for programming interfaces. JSON responses tend to include extra information for some APIs.

Some APIs provide options which can be added to the end of the URL - for example to include uploaded files in the table of contents API, add &includeBinary=true to the end of the URL for the API. API endpoints are listed with no options changed, i.e. their default options.

List of data feeds:

Feeds available for any page

Table of contents (list of sub-pages)

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/toc.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/toc.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/toc.json?page=/your/page/here

Options

  • includeHtml (default: true): whether to include normal Sitebuilder pages in the results
  • includeBinary (default: false): whether to include uploaded files in the results
  • sortByCreated (default: false): whether to sort the results by the page creation/file upload date, rather than the sort order

Table of contents for images (for a slideshow)

Note: sbrPage= here, not page=

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/render/tocImages.json?sbrPage=/your/page/here

Recent changes in site

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/siteChanges.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/siteChanges.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/siteChanges.json?page=/your/page/here

Options

  • showSubsites (default: false): whether changes in subsites are included

Recent changes under a page

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/changes.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/changes.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/changes.json?page=/your/page/here

Find pages with keywords

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/search/keywords.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/search/keywords.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/search/keywords.json?page=/your/page/here

Options

  • keyword: one parameter for each keyword to search for. To search for pages with keywords 'email' or 'staff', add &keyword=email&keyword=staff
  • searchType (default: OR): setting this to OR finds pages with any of the passed keywords. AND find pages with all of the passed keywords only
  • includeDeleted (default: false): set this to true to include deleted (but not purged) pages in the results

List keywords in site

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/ajax/keywords.json?basePage=/your/page/here

More popular keywords first

Podcast feed (audio and video beneath page)

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/podcast.rss?page=/your/page/here

Options

  • tag: one parameter for each tag to filter by. To show items tagged with 'chemistry' or 'video', add &tag=chemistry&tag=video

Page comments

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/comment/feed.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/comment/feed.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/comment/feed.json?page=/your/page/here

Page information

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/page.json?page=/your/page/here

Options

  • excludeDeletedChildren (default: false): whether to exclude deleted sub-pages and files (purged children are never included)

Does user have permission

  • Plain: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/permissions.htm?page=/your/page/here&user=usercode

Options

  • activity (default: edit): the permissions level to check for. One of view, contributor, edit, admin, comment, viewSubmissions

Site administration

Audit trail for site

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/edit/site/audit.json?page=/your/page/here

Options

  • startDate (default: two weeks ago): the date to look for audit events from (dd/MM/yy)
  • endDate (default: now): the date to look for audit events to (dd/MM/yy)
  • maxResults (default: 50): maximum number of events to return
  • user: a usercode to restrict events to
  • url (default: page url): a url to look under
  • includeSubPages (default: true): include sub-pages under url if specified
  • includeSubsites (default: true): include events in subsites
  • instigating (default: true): set to false to include all events from cascading changes (by default, will only show the top event)
  • pageNumber (default: 1): page of results (for pagination)

Statistics for site

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/edit/site/statistics.json?page=/your/page/here

Options

  • includeSubsites (default: true): include subsites in the counts

List of subsites

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/edit/site/subsites.json?page=/your/page/here

Options

  • deleted (default: false): by default shows non-deleted subsites only. Set to true to see only deleted subsites

News pages

News feed

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/news.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/news.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/news.json?page=/your/page/here

Options

  • num (default: 10): the number of news items to fetch
  • includeDeleted (default: false): whether to include deleted news items
  • tag: one parameter for each tag to filter by. To show items tagged with 'chemistry' or 'video', add &tag=chemistry&tag=video

Calendar pages

Calendar feed

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/news.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/news.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/news.json?page=/your/page/here

Options

  • start (default: today): the date to start the events from, in ddMMYY format (eg. for 30th Oct 2014, start=301014)
  • end: the date to look for events until, in ddMMYY format
  • num (default: 30): the number of calendar items to fetch (except when view=today)
  • skip (default: 0): the number of calendar items to skip (for pagination) (except when view=today)
  • days (default: 1): the number of days to show events for (only when view=today)
  • view (default: upcoming): the type of feed
    • upcoming: show the next num upcoming events
    • latest: show the next num recently added events, starting after today
    • today: show the next days days worth of events
  • includeDeleted (default: false): whether to include deleted calendar items
  • tag: one parameter for each tag to filter by. To show items tagged with 'chemistry' or 'video', add &tag=chemistry&tag=video

iCalendar feed

  • iCal: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/sitebuilder.ics?page=/your/page/here

Options

  • includeAllEvents (default: false): whether to include all events. By default, the iCalendar file will only show the next 2 weeks of events
  • includeDeleted (default: false): whether to include deleted calendar items
  • tag: one parameter for each tag to filter by. To show items tagged with 'chemistry' or 'video', add &tag=chemistry&tag=video

Forum pages

Posts

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/forums/feed.rss?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/rss/forums/feed.json?page=/your/page/here
  • If you add &c=1000 to the end of the URL, you'll get 256 posts rather than 20 (max is 256). you can also add &s=2, 3, 4 etc for page number.

Data reveal pages

Get revealer data for current user

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/revealer.json?page=/your/page/here

Data list pages

Get data list entries

  • RSS: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/dataentry/entries.rss?page=/your/page/here
  • Atom: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/dataentry/entries.atom?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/dataentry/entries.json?page=/your/page/here

Options

  • num (default: all): the number of data store items to fetch
  • start (default: 0): the number of data store items to skip (for pagination)
  • tag: one parameter for each tag to filter by. To show items tagged with 'chemistry' or 'video', add &tag=chemistry&tag=video
  • sort (default: title): what to sort the data items by. Other option: date

There are other data entry APIs not listed here at present

Go.Warwick APIs

In Go.Warwick APIs, the path parameter is the redirect name itself. For go.warwick.ac.uk/chemistry, the path is chemistry.

Redirect information

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/api/go/redirect.json?path=redirectpath

Dataset pages

Dataset feed

  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/dataset/data/tabular/info.json?page=/your/page/here
  • JSON: http://sitebuilder.warwick.ac.uk/sitebuilder2/dataset/data/summary/info.json?page=/your/page/here

Options

  • dataSetId : the data set reference no.
  • s (default: 1): page no. If data is paginated, you would need to pass page no. to extract data of a particular page. To view page 2 data for dataset xx,add &dataSetId=xx&p=2 /li>