Get Loyalty Overview

GET

/apis/v1/community-analytics/loyalty-overview

Returns one record per active/engaged client with full loyalty metrics for a community.

API Key -> customerSuccess

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Body Params application/json

Example

{}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://integration.returning.ai/apis/v1/community-analytics/loyalty-overview?page=1&limit=50&from=2025-01-01T00:00:00Z&to=2026-03-31T23:59:59Z' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200Success

application/json

Body

Examples

Example 1Success

{
    "status": "success",
    "message": "Loyalty overview fetched successfully",
    "data": {
        "data": {},
        "pagination": {}
    }
}

🟠401Invalid token

🟠401Insufficient permission

🟠404Record Not Found

Modified at 2026-04-01 03:04:12

Get user's current Mini Games and Streak stats

Channels