Question 1

Getting Started with REST API

Accepted Answer

👋 Welcome to Cloutly's REST API

Q: Which Review Sites do we Integrate with?

<h1 id="reviewsiteintegrations">Review Site Integrations</h1> <p>${frame}<a href="https://airtable.com/embed/shr22qumb1Wu9QLE3">Collect, monitor and respond to reviews from the sites that matter most</a></p>

REST API allows you to access your Cloutly data. Request methods are used in accordance with HTTP:

GET is used to read one or more entities;
POST is used to create or update entities;
DELETE is used to delete entities;
Responses use standard HTTP codes.

Before you start using the API, read through the following five basics 👇

1️⃣ Base API Domain

Cloutly's API is provided on the following HTTPS-only domain:

https://app.cloutly.com/api/v1

2️⃣ Authentication

You should authenticate all your HTTP requests to Cloutly's API with the help of your API key.

To get your API key, go to Developers → Public API and copy your API Key from there.

[Screenshot coming soon]

In order to authenticate your HTTP requests, you should add an x-api-key header to your requests and specify your API key there.

x-api-key: YOUR_JWT_HERE

You don't need to do any extra manipulations with your API key. It is permanent and never expires until rotated from the console.

Make sure you pass the entire key without any spaces or extra symbols.

3️⃣ Rate limiting

In order to protect Cloutly from API traffic spikes that could put our database at risk we utilise rate-limiting. When you get rate-limited, you will start receiving 429 Too Many Requests HTTP errors in response to your requests.

The default overall requests limit is 200 per minute

4️⃣ Errors

Depending on the exact method, you can

Question 2

Guidelines for Connecting Direct Review Site URLs

Accepted Answer

Review Site Guidelines

When connecting new review sites other than Google or Facebook, you'll want to use the following URL guidelines to ensure we can fetch your reviews.

${frame}How to format your review site links

Question 3

How to set up and install Review Widgets on your website

Accepted Answer

How to install review widgets on your site

This quick guide will show you how to install your Proof and/or Carousel Slider widget code on your website.

Key Contents

Installing widgets on Wordpress
Installing widgets on Shopify
Installing widgets with Google Tag Manager

Creating a New Widget

1. Click on the "Widgets" link (underneath Power Ups) on the dashboard menu

2. Select your Business, the widget style (Proof or Slider) and the review sites you'd like your widget to display.

3. Then, click "Create and Get Code" to reveal the code you'll need to copy and paste into your website HTML.

Inserting Widget Code on your Website

Installing your widget code is easy, but might be slightly different from this guide depending on your website's CMS.

When you've created a new slider style widget, you'll just need to insert one snippet of code onto your website (in the location you want the slider to appear - usually between the tags).

When you've created a new badge or 'proof' widget, you'll see two small snippets which you need to copy and place into your website's HTML.

The first snippet needs to be placed in between your and tags:

<meta name="widgetCloutly" content="XXXXXXXXXXXXXXXXXXXX"/>

(use your code, not this example)

and the second snippet (b

Question 4

Cancelling Your Cloutly Account

Accepted Answer

How to cancel your subscription

I'd love to see if we could help you before you cancel your account, but if you're sure about it, we've made it possible for you to cancel your account directly from the Billing section of your dashboard (found under My Account).

Freezing Your Plan

Sometimes you just need a break!

By cancelling your plan, you'll lose access to any landing pages, widgets or campaigns that are currently active (and that sucks).

If you need to take a break, consider freezing your account for 14, 30 or 60 days. You'll still be able to access your dashboard and data; you just won't be able to send new campaigns.

To do this, go through the same process to cancel your account, but choose 'Freeze Your Plan' instead.

If there's something you'd like help with, something you're stuck on or something you're not sure about, please reach out to us via live chat or email. We'd love to help.

support@cloutly.com

Question 5

Understanding the Dashboard

Accepted Answer

Overview of your Dashboard

Cloutly's dashboard was designed to be as intuitive as possible, keeping the most important and relevant information front-and-centre for you to see. Let's break it down, from the top.

The Key Indicators

You'll notice four, key blocks at the top of your dashboard:

Average Rating
Positive Reviews
Negative Reviews Stopped
Negative Feedback Collected

Let's break down what these each mean.

Average Rating

This is your average 'review score' between all your review sources. If you'd prefer to only see your rating from one particular source (or exclude Cloutly's internal feedback - more on this below), you can use the Review Sources filter to achieve this.

All Sources: this includes ratings from all your review sites, plus all ratings 'clicked' on by recipients of your review invites.

Positive Reviews

This identifies how many people rated you 4-5 stars within the selected time period.

Negative Feedback Collected

Shows you how many people left you written feedback to accompany their poor rating. If you're

Question 6

Which Review Sites do we Integrate with?

Accepted Answer

Review Site Integrations

${frame}Collect, monitor and respond to reviews from the sites that matter most

Frequently Read Articles

Browse All Categories