Show Achievements Summary

Returns a summary for achievements made by member, grouped by type and month.

Query Parameters

Parameter	Type	Required?	Default	Description
months_no	integer	no	12	Number of last months to fetch. Must be in (0..999) range
with_rules	boolean	no	false	Show achievements_by_rule

Achievement by type JSON object

Key	Type	Description
type	string	See: Achievement types
times_achieved	integer	Number of times member made the achievements of this type
total_amount_earned	integer	Sum of points member get with this achievement type

Achievement by month JSON object

Key	Type	Description
year	integer	four-digit year, e.x. 2019
month	integer	1-12
achievements_made	integer	Number of achievements made by member in that month
total_amount_earned	integer	Sum of points member achieved in that month

Achievement by rule JSON object (optional)

Key	Type	Description
type	string	See: Achievement types
times_achieved	integer	Number of times member made the achievements of this rule
total_amount_earned	integer	Sum of points member get with this achievement rule
rule_id	integer	Achievement/Rule id

Example

When successful, returns JSON structured like this:

{
    "achievements_by_type": [
        {
            "type": "app_opened",
            "times_achieved": 3,
            "total_amount_earned": 30
        },
        {
            "type": "beacon_approached",
            "times_achieved": 3,
            "total_amount_earned": 150
        },
        {
            "type": "link_clicked",
            "times_achieved": 4,
            "total_amount_earned": 80
        }
    ],
    "achievements_by_month": [
        {
            "year": 2019,
            "month": 2,
            "achievements_made": 20,
            "total_amount_earned": 800
        },
        {
            "year": 2019,
            "month": 1,
            "achievements_made": 35,
            "total_amount_earned": 950
        },
        {
            "year": 2018,
            "month": 12,
            "achievements_made": 12,
            "total_amount_earned": 580
        }
        // (...) another 9 months
    ],
    "achievements_by_rule": [
        {
            "type": "app_opened",
            "times_achieved": 3,
            "total_amount_earned": 30,
            "rule_id": 1
        },
        {
            "type": "beacon_approached",
            "times_achieved": 3,
            "total_amount_earned": 150,
            "rule_id": 2
        },
        {
            "type": "link_clicked",
            "times_achieved": 4,
            "total_amount_earned": 80,
            "rule_id": 3
        }
    ],
}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Show Achievements Summary

Query Parameters#

Achievement by type JSON object#

Achievement by month JSON object#

Achievement by rule JSON object (optional)#

Example#

Request

Request samples

Responses

Query Parameters

Achievement by type JSON object

Achievement by month JSON object

Achievement by rule JSON object (optional)

Example