Loyalty Analytics

Introduction

With the Loyalty Analytics service, you can do all the necessary operations to perform analytics related tasks. To perform the basic operations supported by the Analytics service, you need to be authorized. This is achieved through the header that carries the correct access token. The examples in this tutorial will lead you through those operations, showing what you need to provide to the methods, and what you get in return.

clientId = 'ICqjWvu41eUQQorT8SWAFwsnGWtIw5XC';
clientSecret = 'pMf1q4yjL7X4v28Z';
tenant = 'saploytest';
client = 'saploytest.apinotebooktutorialtest';
scopesRequired = 'hybris.tenant='+tenant+' sap.loycore_view sap.loycore_manage sap.loyanalytics_view';
token = '523-44f9feb2-e18c-4fc5-a0fa-c8e3e60126df';

Get access token

To perform any operations with a specific service, you always need an access token. For this purpose, create an API Client for the oAuth2 service:

API.createClient('oAuth2Service',
'/services/oauth2/v1/api.raml');

Now get the token:

AccessToken = oAuth2Service.token.post({
  'client_id' : clientId,
  'client_secret': clientSecret,
  'grant_type' : 'client_credentials',
  'token_type': 'Bearer',
  'scope': scopesRequired
});

access_token = AccessToken.body.access_token;

Create API client for Loyalty Analytics service

API.createClient('AnalyticsService',
'https://devportal.stage.yaas.io/services/loyaltyanalytics/v1/api.raml');

Create a Analytics object

Mentioned below are the default values from a test project. Replace the payload with proper values from your project.

members_count = AnalyticsService.queryMembers.post({
        "query":{
            "size":0,
            "query":{
                "filtered":{
                    "filter":{
                        "bool":{
                            "should":[

                            ],
                            "must":[

                            ],
                            "must_not":[

                            ]
                        }
                    }
                }
            },
            "aggs":{
                "total_members":{
                    "value_count":{
                        "field":"memberId"
                    }
                }
            }
        },
        "filters":{
            "dataMeta":{
                "for":"AGGS",
                "type":"SIMPLE"
            },
            "tiers":{
                "project":{
                    "field":"tierId",
                    "nested":false
                },
                "values":[

                ]
            },
            "date":{
                "project":{
                    "single":{
                        "field":"metadata.createdAt"
                    }
                },
                "year":[

                ],
                "month":[

                ]
            }
        }
    }, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

"Total No. of Members: " + members_count.body.value;

member_activities_count = AnalyticsService.queryMemberActivities.post({
        "query":{
            "size":0,
            "query":{
                "filtered":{
                    "filter":{
                        "bool":{
                            "should":[

                            ],
                            "must":[

                            ],
                            "must_not":[

                            ]
                        }
                    }
                }
            },
            "aggs":{
                "total_member_activities":{
                    "value_count":{
                        "field":"memberActivityId"
                    }
                }
            }
        },
        "filters":{
            "dataMeta":{
                "for":"AGGS",
                "type":"SIMPLE"
            },
            "tiers":{
                "project":{
                    "field":"tierId",
                    "nested":false
                },
                "values":[

                ]
            },
            "date":{
                "project":{
                    "single":{
                        "field":"metadata.createdAt"
                    }
                },
                "year":[

                ],
                "month":[

                ]
            }
        }
    }, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

"Total No. of Member Activities: " + member_activities_count.body.value;

offers_count = AnalyticsService.queryOffers.post({
        "query":{
            "size":0,
            "query":{
                "filtered":{
                    "filter":{
                        "bool":{
                            "should":[

                            ],
                            "must":[
                                {
                                    "term":{
                                        "offerStatus":"active"
                                    }
                                }
                            ],
                            "must_not":[

                            ]
                        }
                    }
                }
            },
            "aggs":{
                "total_active_offers":{
                    "value_count":{
                        "field":"offerId"
                    }
                }
            }
        },
        "filters":{
            "dataMeta":{
                "for":"AGGS",
                "type":"SIMPLE"
            },
            "tiers":{
                "project":{
                    "field":"tierId",
                    "nested":false
                },
                "values":[

                ]
            },
            "date":{
                "project":{
                    "multi":{
                        "from":"validFrom",
                        "to":"validTo"
                    }
                },
                "year":[

                ],
                "month":[

                ]
            }
        }
    }, {
  headers: {
    'Authorization': 'Bearer ' + access_token,
    'Content-type' : 'application/json'
           }
    }
  )

"Total No. of Offers: " + offers_count.body.value;