The OpenWeb Developer Hub

Welcome to the OpenWeb developer hub. You'll find comprehensive guides and documentation to help you start working with OpenWeb as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Popular in the Community

Popular in the Community helps to promote and monetize your most popular content:

  • Promoting your content by showcasing user-generated content
  • Featuring a monetization component that generates shared revenue

Requirements

Popular in the Community requires the following:

  • Popular in the Community must be enabled by your OpenWeb PSMPSM - Partner Support Manager
  • Minimum of 10 articles with a Conversation embedded
  • Defined og:title for each article
  • Defined og:image with a fully-qualified URL for each article


Implementation

You can add Popular in the Community on the following types of pages:

📘

NOTE

You can also add Popular in the Community and a Conversation to an AMP page.


Embed with a Conversation

After your OpenWeb PSM has enabled Popular in the Community for your account, Popular in the Community appears above each Conversation. No additional coding is necessary.

To define a custom location for Popular in the Community to appear, add the Popular in the Community <div> to the page. Popular in the Community will appear in the location in which you place the <div>.

The following table lists the different approaches to aligning Popular in the Community with the layout of your page.

ApproachCode | Explanation
Horizontal<div data-spotim-module="pitc"></div>
Vertical<div data-spotim-module="pitc" data-vertical-view="true"></div>
Double-deckerA horizontal instance of Popular in the Community appears both above and below the Conversation

Contact your OpenWeb PSM for more information.


Embed without a Conversation

You can embed Popular in the Community on article pages that do not contain a Conversation.

  1. Add the launcher codelauncher code - JavaScript code that loads the library and configurations for an OpenWeb product or feature.
<script 
    async
    src="https://launcher.spot.im/spot/SPOT_ID"
    data-spotim-module="spotim-launcher">
</script>

  1. Replace SPOT_ID with your Spot ID.

    Use the following steps to locate your Spot ID:
       a. Log into your Admin Dashboard.
       b. Copy your Spot ID from the URL: https://admin.spot.im/spot/{SPOT_ID}/...

  2. In the location where Popular in the Community should appear, add the Popular in the Community <div>.

    The following table lists the different approaches to aligning Popular in the Community with the layout of your page.

ApproachCode | Explanation
Horizontal<div data-spotim-module="pitc"></div>
Vertical<div data-spotim-module="pitc" data-vertical-view="true"></div>

Updated 2 months ago


Popular in the Community


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.