Dimensions BadgesBuild your own badge now

Dimensions is a research insights platform that brings together information about funding, publications, policy, patents, and grants. The Dimensions Badge provides a free and easy way for researchers and academic institutions to showcase the number of citations that their publications have received.

Embed a Dimensions Badge into your own website, so people can easily see how many citations your publications have received. From the badges, users can explore the citation data further using the free Dimensions platform. The Dimensions Badges are built on the Dimensions Metrics API, which is also available for free for internal, non-commercial purposes.

If you are not a researcher or academic institution and would like to use these products, please get in touch. If you are a publisher or would like to display these badges on a journal website, please contact publishing@digital-science.com for more information.

Getting set up with a Dimensions Badge is a straightforward process – once you've registered with us, just add the following code to the HTML of your website, wherever you want the Dimensions Badge to appear:

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797"></span><script async src="https://integration-badge.dimensions.ai/static/ai/badge.js" charset="utf-8"></script>

Replace the contents of data-doi with the DOI of the publication that you want the badge to represent. You can also use the data-pmid or data-id attributes to reference a publication by PubMed ID or Dimensions ID respectively.

That's all you need to do! You'll see a Dimensions Badge that looks like this:

You can customize the appearance of the badge using the tools below.

If you are an individual, you can use the badges and the metrics API for free for your personal, research purposes relating to work you've authored.

If you represent an academic institution, you can also use the badges and metrics API for free. The first thing you need to do is register some simple details with us here. You're then permitted to use the badges on your websites in respect of work related to your institution, provided the websites are open to everyone and otherwise non-commercial (but we don't mind if they include adverts).

If you are not a researcher or academic institution and would like to use these products, please get in touch. If you are a publisher or would like to display these badges on a journal website, please contact publishing@digital-science.com for more information.

Please do keep in mind that this is just a simple summary of (and not a substitute for) the legal terms that apply to the Dimensions Badges and Metrics API, which you agree to comply with by using them.

Preview of this badge

Your embed code

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797"></span><script async src="https://integration-badge.dimensions.ai/static/ai/badge.js" charset="utf-8"></script>

Copy this code into your page to embed the Dimensions Badge shown in the preview.

When you click on a Dimensions Badge, a corresponding Dimensions details page on dimensions.ai will be shown. The Dimensions details page provides more in-depth information about the publication, including a summary of available metrics, a list of citing works, a visualization of citing research categories. You can share the details page using social media, or continue into the free Dimensions platform to explore the publication in more depth.

You can include multiple Dimensions Badges on a single page. If you want to do this, you can follow a two-step process to reduce the amount of code you have to embed.

Step 1: Include the setup code anywhere on your page:

<script async src="https://integration-badge.dimensions.ai/static/ai/badge.js" charset="utf-8"></script>

Step 2: Include the badge code at the position in the page you want the badge to appear:

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797"></span>

You can include as many badges as you want on a page. You only need to include the setup code once.

You can customize the appearance and content of the badge using the HTML attributes described below.

Use the badge builder above to help you create the embed code you need for your website or application.

The badge legend allows users to see some additional information about your publications, in addition to the Dimensions citation count. To control the appearance of the legend, set the data-legend attribute.

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-legend="hover-bottom"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-legend="always"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-legend="never"></span>

A selection of different badge styles are available. You can choose the style that best matches your website and content.

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-style="small_circle"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-style="large_circle"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-style="small_rectangle"></span>

<span class="__dimensions_badge_embed__" data-doi="10.1001/jama.2016.9797" data-style="large_rectangle"></span>

The Dimensions Badges and details pages are fully compatible with all modern web browsers. Older browsers may receive a degraded experience.

The Dimensions Badges are served from Fastly, a global CDN (Content Delivery Network), and loaded into your page asynchronously. Latency is very low and will have no impact on the loading times of your pages.

The Dimensions Badge code will automatically detect and install badges for any element on which you include the __dimensions_badge_embed__ class. However, if you add additional elements to the page after it has loaded – using AJAX requests, for example – then you will need to tell the badge code about them before the badge will be visible.

To do this, you can call the addBadges() function on window.__dimensions_embed. This will detect any new badge code on your page and install Dimensions Badges. After new HTML has been added to the page, use this function as follows:

window.__dimensions_embed.addBadges()

For example, if you were using a jQuery AJAX call, your code might look like the following:

$.get("/my_new_html").done(function(data) {
  insertMyNewHTML(data);
  window.__dimensions_embed.addBadges();
});

There are two custom Javascript events that can be triggered by the badge:

dimensions_embed:show is triggered when a badge is shown
dimensions_embed:hide is triggered when a badge is hidden (e.g. the article has no citations and data-hide-zero-citations has been set)

These events will be triggered on the __dimensions_badge_embed__ container, so it is possible to attach event listeners and act on them.

For example, jQuery could be used to show an alert whenever a badge is hidden with the following code:

$(function () {
  $('.__dimensions_badge_embed__').on('dimensions_embed:hide', function () {
      alert('A Dimensions badge was hidden');
  });
});

If you have any problems integrating Dimensions Badges with your website or platform, contact the Dimensions team at support@dimensions.ai and we'll help you get set up.