The Confluence Cloud REST API

Experimental

Get Space Labels

Experimental

GET /wiki/rest/api/space/{spaceKey}/label

Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.

Connect app scope required: READ

OAuth scopes required:

read:confluence-space.summary

Request

Path parameters

spaceKey Required

string

The key of the space to get labels for.

Query parameters

prefix

string

Filters the results to labels with the specified prefix. If this parameter is not specified, then labels with any prefix will be returned.

global prefix is used by labels that are on content within the provided space.
my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'.
team prefix is used for labels applied to the space.

Valid values: global, my, team

start

integer

The starting index of the returned labels.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/label`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

404

Returned if the list of labels is returned.

Content type	Value
application/json	LabelArray

Add labels to a space

Experimental

POST /wiki/rest/api/space/{spaceKey}/label

Adds labels to a piece of content. Does not modify the existing labels.

Notes:

Labels can also be added when creating content (Create content).
Labels can be updated when updating content (Update content). This will delete the existing labels and replace them with the labels in the request.

Permissions required: Permission to update the content.

Connect app scope required: WRITE

OAuth scopes required:

write:confluence-space

Request

Path parameters

spaceKey Required

string

The key of the space to add labels to.

Body parameters

Content type	Value
application/json	Array<LabelCreate>

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `[
  {
    "prefix": "<string>",
    "name": "<string>"
  }
]`;

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/label`, {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

400

403

404

Returned if the labels are added to the content.

Content type	Value
application/json	LabelArray

Remove label from a space

Experimental

DELETE /wiki/rest/api/space/{spaceKey}/label

Connect app scope required: DELETE

OAuth scopes required:

write:confluence-space

Request

Path parameters

spaceKey Required

string

The key of the space to remove a labels from.

Query parameters

name Required

string

The name of the label to remove

prefix

string

The prefix of the label to remove. If not provided defaults to global.

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/space/{spaceKey}/label?name={name}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

204

400

404

Returned if the label was successfully deleted.

A schema has not been defined for this response code.

Get views

Experimental

GET /wiki/rest/api/analytics/content/{contentId}/views

Get the total number of views a piece of content has.

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

contentId Required

string

The ID of the content to get the views for.

Query parameters

fromDate

string

The number of views for the content since the date.

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/analytics/content/{contentId}/views`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

400

401

403

404

Returns the total number of views for the content.

Content type	Value
application/json	object

Get viewers

Experimental

GET /wiki/rest/api/analytics/content/{contentId}/viewers

Get the total number of distinct viewers a piece of content has.

Connect app scope required: READ

OAuth scopes required:

read:confluence-content.summary

Request

Path parameters

contentId Required

string

The ID of the content to get the viewers for.

Query parameters

fromDate

string

The number of views for the content since the date.

Example

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/analytics/content/{contentId}/viewers`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

400

401

403

404

Returns the total number of distinct viewers for the content.

Content type	Value
application/json	object