How to find the usage of an Confluence add-on


we use Confluence with many add-ons and now we want to know if a specific addon is used anymore and where. (for edit / macro providing addons...)

Is there a way to do this? (by database...) 

We use Confluence 5.8



1 answer

1 accepted

2 votes
Answer accepted

There's two parts to this.

First, you simply can't do it for addons.  Addons provide functionality and you can't search for that.  Think of it this way - if I wrote an addon that adds a button that just says "hello world" on the menu and pops up a picture of a random kitten when pressed - how do you know how that is used?  There's nothing in the database for you to search for.

Secondly, you can do it for macros, but...

Reading the database is by far the hardest way to do this.  You can use multiple different macros in the body of a page, and those are stored as xml, so SQL isn't going to help you much - you'll be able to find pages where each macro is used quite easily, but you're going to have to query for every macro individually, and parse the xml for it.

Confluence search does allow you to do it more easily, although you still need to do it for every macro - the term macroName:note will find every where you've used the note macro for example.

Your best option is therefore to do it in Confluence where you can use the API.  See @Davin Studer 's answer on for what I'd do.

Suggest an answer

Log in or Sign up to answer
Community showcase
Published Tuesday in Confluence

Confluence Admin Certification now $150 for Community Members

More and more people are building their careers with Atlassian, and we want you to be at the front of this wave! Important Dates Start the Certification Prep Course by 2 April 2019 Take your e...

189 views 2 10
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you