Cloutly Reviews API & SDK
  • Introduction
    • Background & Motivations
    • System Overview
    • Setup & Authentication
    • Ping
  • Swagger Docs
    • Swagger Specs
  • Vendor API
    • Create Vendor
    • Get Vendor
    • Update Vendor
  • Review Collection API
    • Send Review Invite
  • Review Submission API
    • Submit Review
  • Review Insights API
    • Get Reviews
    • Get Review Insights
  • Review Widgets SDK
    • Enriched Review Widgets UI
    • Custom HTML Review Widgets
Powered by GitBook
On this page
  • GET /ping
  • Request
  • Response
  • Notes:
  1. Introduction

Ping

Health check endpoint to ensure everything is ready to go.

GET /ping

Send a GET request to verify you have the correct authentication setup. This endpoint will return status code 200 and the scopes for the API key.

Request

GET https://marketplace.cloutly.com/api/v2/ping

Response

{
  "scopes": ["v2", "v2-campaigns", "v2-insights"]
}

Notes:

  • Please contact support if you do not receive a 200 while performing this call.

  • v2 is the default scope

  • v2-campaigns scope gives you access to Review Collection API

  • v2-insights scope gives you access to Review Insights API

PreviousSetup & AuthenticationNextSwagger Specs

Last updated 8 months ago