In this page

Overview

Better Content Archiving for Confluence provides a REST API for developers for reporting and integration purposes. Although the primary aim of the API is to provide back-end for the app's own user-interface, you are also welcome to use it for your own needs.

The Better Content Archiving app's REST API is a natural extension to Confluence's core REST API. It uses the same semantics: you can authenticate to Confluence and call REST methods the same exact way with both of those. Learn more about using the Confluence REST API in the Confluence Development documentation.

Please note that the set of the API methods is fairly limited at the moment, but we are open to requests to extend it.

REST API reference

/content-status/{page-id}

Description
 Returns the page status for one specific page. To get the status for a page family, the other methods are more efficient.
Since
 3.5.0
URL
http://confluence.mycompany.com/rest/archiving/1.0/content-status/12320776
Method
 GET
Returns
 Sample JSON response: 
{
	"id": 12320776,
	"lastUpdated": {
		"longInfoAsHtml": "yesterday at 14:26 <small>(john.doe on 2015-04-27 14:26)</small>",
		"shortInfoAsHtml": "<span title=\"2015-04-27 14:26\">yesterday at 14:26</span> <small>(john.doe)</small>",
		"dateFormatted": "2015-04-27 14:26"
	},
	"lastViewed": {
		"longInfoAsHtml": "a minute ago <small>(john.doe on 2015-04-28 15:58)</small>",
		"shortInfoAsHtml": "<span title=\"2015-04-28 15:58\">a minute ago</span> <small>(john.doe)</small>",
		"dateFormatted": "2015-04-28 15:58"
	},
	"status": {
		"code": "up-to-date",
		"summary": "Up-to-date",
		"description": "This page is up-to-date",
		"subDescription": ""
	}
}

/content-status/space/{space-key}/children

Description
 Return the page status for all top-level pages in the space.
Since
 3.5.0
URL
http://confluence.mycompany.com/rest/archiving/1.0/content-status/space/DEVSPACE/children
Method
 GET
Returns
 Sample JSON response: 
[
	{
		"id": 12320776,
		"title": "Welcome to Midori!",
		"url": "/pages/viewpage.action?pageId=12320776",
		"hasChildren": true,
		"isHomePage": true,
		"lastUpdated": {
			"longInfoAsHtml": "yesterday at 14:26 <small>(john.doe on 2015-04-27 14:26)</small>",
			"shortInfoAsHtml": "<span title=\"2015-04-27 14:26\">yesterday at 14:26</span> <small>(john.doe)</small>",
			"dateFormatted": "2015-04-27 14:26"
		},
		"lastViewed": {
			"longInfoAsHtml": "9 minutes ago <small>(john.doe on 2015-04-28 15:59)</small>",
			"shortInfoAsHtml": "<span title=\"2015-04-28 15:59\"><b>9</b> minutes ago</span> <small>(john.doe)</small>",
			"dateFormatted": "2015-04-28 15:59"
		},
		"status": {
			"code": "up-to-date",
			"summary": "Up-to-date",
			"description": "This page is up-to-date",
			"subDescription": ""
		}
	}
]

/content-status/{page-id}/children

Description
 Returns the page status for all children of the page.
Since
 3.5.0
URL
http://confluence.mycompany.com/rest/archiving/1.0/content-status/14745608/children
Method
 GET
Returns
 It returns a JSON document in the same structure as the previous method.

Questions?

Ask us any time.