Label Supplier

Overview

Provides information about Confluence content labels.

Details

Name:

Label Supplier

Prefix:

label(optional)

Supported Content:

Labels

Provided By:

Reporting for Confluence

Supported Keys

List of keys that this supplier returns a value for.

Key

Content Types

Return Type

Description

Key

Content Types

Return Type

Description

title

Label

Text

The title of the label.

owner

Label

User

The user who owns the label.

Generally this will either be the current user or nobody, since other user personal labels are not visible to most users.

url

Label

Text

The URL to the page which lists the content which has been labelled with this label.

content

Label

List of Content

The list of content which has been labelled with this label.

content count

Label

Number

The number of content items which have been labelled with this label.

More efficient than getting the content list size.

related

Label

Labels

The list of labels which are related to this label.

is team

Label

Boolean

Tests if the label is a team label.

Used to mark a space as being related to a specific team in the dashboard.

is personal

Label

Boolean

Tests if the label is a personal label. That is, it was prefixed with 'my:'. FROM v2.1.0

is global

Label

Boolean

Tests if the label is a global label. FROM v2.1.0

namespace

Label

Text

The namespace value for the label.

This is one of

  • global - a global label

  • team - a team label

  • my - a personal label FROM v2.1.0

creation date

Label

Date

The date the label was created on. FROM v3.4.0