Master

APIDescription
GET api/v1/Datatypes

Get data types for parameters.

GET api/v2/Datatypes

Get data types for parameters.

Report

APIDescription
GET api/v1/configsets/{ConfigSet}/transactions/{TransactionID}

Get the Activity Summary Report for a transaction identified by ConfigSet and TransactionID. In addition to the points earned, badges awarded and points redeemed we also get the Rule Evaluation Summary for the specified transactions.

GET api/v2/configsets/{ConfigSet}/transactions/{TransactionID}

Get the Activity Summary Report for a transaction identified by ConfigSet and TransactionID. In addition to the points earned, badges awarded and points redeemed we also get the Rule Evaluation Summary for the specified transactions.

GET api/v2/configsets/{ConfigSet}/activitylog?queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

Get the Activity Log for a ConfigSet

GET api/v2/configsets/{ConfigSet}/clienttransactions/{TransactionID}

Get the Activity Summary Report for a client transaction id identified by ConfigSet and ClientTransactionID. In addition to the points earned, badges awarded and points redeemed we also get the Rule Evaluation Summary for all transactions related to the specified client transaction id.

GET api/v1/configsets/{ConfigSet}/clienttransactions/{TransactionID}

Get the Activity Summary Report for a client transaction id identified by ConfigSet and ClientTransactionID. In addition to the points earned, badges awarded and points redeemed we also get the Rule Evaluation Summary for all transactions related to the specified client transaction id.

GET api/v1/configsets/{configId}/popularactivities

Get the Popular Activities Report for a given Config Set identified by configId.

GET api/v2/configsets/{configId}/popularactivities

Get the Popular Activities Report for a given Config Set identified by configId.

GET api/v1/configsets/{configid}/userreport?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&queryParams.uniqueUserID={queryParams.uniqueUserID}&queryParams.firstName={queryParams.firstName}&queryParams.lastName={queryParams.lastName}&queryParams.emailID={queryParams.emailID}

Get the activities summary for a single user with user information, total points, available points and level. User is identified by uniqueUserID, firstName, lastName and emailID. Config Set is identified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/userreport?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&queryParams.uniqueUserID={queryParams.uniqueUserID}&queryParams.firstName={queryParams.firstName}&queryParams.lastName={queryParams.lastName}&queryParams.emailID={queryParams.emailID}

Get the activities summary for a single user with user information, total points, available points and level. User is identified by uniqueUserID, firstName, lastName and emailID. Config Set is identified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/usercompliancereport?PageNumber={PageNumber}&PageSize={PageSize}&min_act_count={min_act_count}&sortorder={sortorder}

Get the list of users with uniqueuserid , name, total points, available points ,compliance % and activities performed by user.Config Set is identified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/usercompliancereport?PageNumber={PageNumber}&PageSize={PageSize}&min_act_count={min_act_count}&sortorder={sortorder}

Get the list of users with uniqueuserid , name, total points, available points ,compliance % and activities performed by user.Config Set is identified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/bulkloggerreport?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&queryParams.bulkLoggerID={queryParams.bulkLoggerID}&queryParams.sourceType={queryParams.sourceType}&queryParams.loggedFromDate={queryParams.loggedFromDate}&queryParams.loggedToDate={queryParams.loggedToDate}

Get the list of bulk logging done. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/bulkloggerreport?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&queryParams.bulkLoggerID={queryParams.bulkLoggerID}&queryParams.sourceType={queryParams.sourceType}&queryParams.loggedFromDate={queryParams.loggedFromDate}&queryParams.loggedToDate={queryParams.loggedToDate}

Get the list of bulk logging done. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/bulkloggererrorreport?PageNumber={PageNumber}&PageSize={PageSize}&bulkLoggerID={bulkLoggerID}

Get the list of bulk logging errors by BulkLoggerID. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/bulkloggererrorreport?PageNumber={PageNumber}&PageSize={PageSize}&bulkLoggerID={bulkLoggerID}

Get the list of bulk logging errors by BulkLoggerID. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/eastatistics

Get values for X-axis and Y-axis for User Engagement Analytics graph for a particular period specified using startdate and enddate. These values are for a specific Config Set identified by configid.

GET api/v2/configsets/{configid}/eastatistics

Get values for X-axis and Y-axis for User Engagement Analytics graph for a particular period specified using startdate and enddate. These values are for a specific Config Set identified by configid.

GET api/v2/configsets/{configid}/eaversusbenchmarkscores

Get the benchmark scores for Average vs Benchmark EA Scores graph for a particular period specified using startdate and enddate. These scores are for a specific Config Set identified by configid.

GET api/v1/configsets/{configid}/eaversusbenchmarkscores

Get the benchmark scores for Average vs Benchmark EA Scores graph for a particular period specified using startdate and enddate. These scores are for a specific Config Set identified by configid.

GET api/v2/configsets/{configid}/usereascores

Get the EA scores for all the users under a given Config Set identified by configid for a particular period specified by startdate and enddate. Number of records to be fetched are specified with recordcount. Sorting is specified by sortby field and the order of sorting by sortorder field.

GET api/v1/configsets/{configid}/usereascores

Get the EA scores for all the users under a given Config Set identified by configid for a particular period specified by startdate and enddate. Number of records to be fetched are specified with recordcount. Sorting is specified by sortby field and the order of sorting by sortorder field.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/userpointsreport?queryParams.PointTypes={queryParams.PointTypes}&queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

Get the User Points Report having Points summary and Points Log details.

GET api/v1/configsets/{configid}/users/{uniqueuserid}/userpointsreport?queryParams.PointTypes={queryParams.PointTypes}&queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

Get the User Points Report having Points summary and Points Log details.

GET api/v2/configsets/{configid}/scoremaster

Get all the score types applicable to selected config set

GET api/v2/configsets/{configid}/users/{uniqueuserid}/userscorereport?queryParams.ScoreTypeID={queryParams.ScoreTypeID}&queryParams.ScoreAction={queryParams.ScoreAction}&queryParams.Source={queryParams.Source}&queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

User score detailed report which will return the user information along with score values associated with user

GET api/v2/configsets/{configid}/usersapreport?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&queryParams.UniqueUserID={queryParams.UniqueUserID}&queryParams.Activity={queryParams.Activity}&queryParams.Reward={queryParams.Reward}

To get User SAPS reward details

GET api/v1/configsets/{configid}/usersapreport?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&queryParams.UniqueUserID={queryParams.UniqueUserID}&queryParams.Activity={queryParams.Activity}&queryParams.Reward={queryParams.Reward}

To get User SAPS reward details

GET api/v1/configsets/{configid}/users/{uniqueuserid}/userbadgesreport?queryParams.BadgesTypes={queryParams.BadgesTypes}&queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

Get User Badges Report

GET api/v2/configsets/{configid}/users/{uniqueuserid}/userbadgesreport?queryParams.BadgesTypes={queryParams.BadgesTypes}&queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

Get User Badges Report

GET api/v1/configsets/{configid}/campaignreport?PageNumber={PageNumber}&PageSize={PageSize}

To get Campaign instance summary data

GET api/v2/configsets/{configid}/campaignreport?PageNumber={PageNumber}&PageSize={PageSize}

To get Campaign instance summary data

GET api/v2/configsets/{configid}/instanceid/{instanceid}/campaigndetailedreport?PageNumber={PageNumber}&PageSize={PageSize}

To get Campaign instance detailed data

GET api/v1/configsets/{configid}/instanceid/{instanceid}/campaigndetailedreport?PageNumber={PageNumber}&PageSize={PageSize}

To get Campaign instance detailed data

GET api/v2/configsets/{configid}/leaderboards?count={count}&SortOn={SortOn}&PeriodType={PeriodType}&SortOrder={SortOrder}&Timeframe={Timeframe}

To get top x users based on parameters/criteria passed

GET api/v1/configsets/{configid}/leaderboards?count={count}&SortOn={SortOn}&PeriodType={PeriodType}&SortOrder={SortOrder}&Timeframe={Timeframe}

To get top x users based on parameters/criteria passed

GET api/v2/configsets/{configid}/leaderboards/{timeFrame}?count={count}&sortOn={sortOn}&sortOrder={sortOrder}&periodType={periodType}

To specific Leaderboards values like weekly/monthly/lifetime

GET api/v1/configsets/{configid}/leaderboards/{timeFrame}?count={count}&sortOn={sortOn}&sortOrder={sortOrder}&periodType={periodType}

To specific Leaderboards values like weekly/monthly/lifetime

GET api/v2/configsets/{configid}/leaderboards/all?count={count}&sortOn={sortOn}&sortOrder={sortOrder}&periodType={periodType}

To get all Leaderboards values of timeframe i.e Lifetime/Monthly/Weekly

GET api/v1/configsets/{configid}/leaderboards/all?count={count}&sortOn={sortOn}&sortOrder={sortOrder}&periodType={periodType}

To get all Leaderboards values of timeframe i.e Lifetime/Monthly/Weekly

GET api/v2/configsets/{configId}/users/{uniqueuserid}/recommendedoffers?PageNumber={PageNumber}&PageSize={PageSize}

Get Recommended Offers Report for a user , along with the Notification Visit status.

GET api/v2/configsets/{configid}/kpimaster

Get all the KPIs applicable to selected config set

GET api/v2/configsets/{configid}/users/{uniqueuserid}/userkpireport?queryParams.KPIKey={queryParams.KPIKey}&queryParams.KPIAction={queryParams.KPIAction}&queryParams.Source={queryParams.Source}&queryParams.StartDate={queryParams.StartDate}&queryParams.EndDate={queryParams.EndDate}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}

User KPI detailed report which will return the user information along with KPI values associated with user

Activity

APIDescription
GET api/v1/configsets/{configid}/activities/{activityid}

Get details of a single activity specified by configid and activityid.

GET api/v2/configsets/{configid}/activities/{activityid}

Get details of a single activity specified by configid and activityid.

GET api/v1/configsets/{configid}/activities?PageNumber={PageNumber}&PageSize={PageSize}&type={type}

Get a list of all activities in a given config set identified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/activities?PageNumber={PageNumber}&PageSize={PageSize}&type={type}

Get a list of all activities in a given config set identified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

DELETE api/v1/configsets/{configid}/activities/{activityid}

Delete an activity specified by configid and activityid.

DELETE api/v2/configsets/{configid}/activities/{activityid}

Delete an activity specified by configid and activityid.

PUT api/v1/configsets/{configid}/activities/{activityid}

Modify details of an existing activity. Activity is specified by configid and activityid. Activity Id is sent in response.

PUT api/v2/configsets/{configid}/activities/{activityid}

Modify details of an existing activity. Activity is specified by configid and activityid. Activity Id is sent in response.

POST api/v1/configsets/{configid}/activities

Create a new activity in a Config Set specified by configid. Activity Id is sent in response.

POST api/v2/configsets/{configid}/activities

Create a new activity in a Config Set specified by configid. Activity Id is sent in response.

GET api/v1/configsets/{configid}/activityfeed?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&dates.Fromdate={dates.Fromdate}&dates.Todate={dates.Todate}&uniqueuserid={uniqueuserid}

Get all the activities performed by all the users in a config set

GET api/v2/configsets/{configid}/activityfeed?paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&dates.Fromdate={dates.Fromdate}&dates.Todate={dates.Todate}&uniqueuserid={uniqueuserid}

Get all the activities performed by all the users in a config set

GET api/v2/configsets/{configid}/activities/{activityid}/parameters

Get a list of parameters associated with an activity. Activity is specified by configid and activityid.

GET api/v1/configsets/{configid}/activities/{activityid}/parameters

Get a list of parameters associated with an activity. Activity is specified by configid and activityid.

DELETE api/v2/configsets/{configid}/activities/{activityid}/parameters/{parameterkey}

Delete a parameter association identified by configid, activityid and parameterkey.

DELETE api/v1/configsets/{configid}/activities/{activityid}/parameters/{parameterkey}

Delete a parameter association identified by configid, activityid and parameterkey.

PUT api/v1/configsets/{configid}/activities/{activityid}/parameters

Associate a list of parameters with an activity. Activity is specified by configid and activityid. A list of Ids of parameters to be associated is specified in the request body.

PUT api/v2/configsets/{configid}/activities/{activityid}/parameters

Associate a list of parameters with an activity. Activity is specified by configid and activityid. A list of Ids of parameters to be associated is specified in the request body.

POST api/v2/configsets/{configid}/activities/{activityid}/parameters/overwrite

Associate a list of parameters with an activity and remove all existing parameters associated with the activity. Activity is specified by configid and activityid. A list of Ids of parameters to be associated is specified in the request body.

POST api/v1/configsets/{configid}/activities/{activityid}/parameters/overwrite

Associate a list of parameters with an activity and remove all existing parameters associated with the activity. Activity is specified by configid and activityid. A list of Ids of parameters to be associated is specified in the request body.

Settings

APIDescription
GET api/v2/configsets/{configid}/settings

Returns the settings object that mentions whether loggin is on or off for various activities for a given configset

GET api/v1/configsets/{configid}/settings

Returns the settings object that mentions whether loggin is on or off for various activities for a given configset

POST api/v1/configsets/{configid}/settings

Updates setting for a given configset by turning the logging of various activities on or off

POST api/v2/configsets/{configid}/settings

Updates setting for a given configset by turning the logging of various activities on or off

GET api/v2/configsets/{configid}/smccconfiguration

Get SMCC related configurations for given config set

POST api/v2/configsets/{configid}/smccconfiguration

Save SMCC configuration

DELETE api/v2/configsets/{configid}/smccconfiguration

Delete SMCC configuration for the selected configset

Score

APIDescription
GET api/v2/configsets/{configid}/scoretype

Get All Score Types

GET api/v2/configsets/{configid}/scoretype/{scoretype}

Get details of a single score type specified by configid.

POST api/v2/configsets/{configid}/scoretype

Create a new score type in a Config Set specified by configid

PUT api/v2/configsets/{configid}/scoretype/{scoretype}

Modify details of an existing score type. Score type is specified by configid.

Lookup

APIDescription
GET api/v2/configsets/{configid}/activities/{activityid}/lookups?PageNumber={PageNumber}&PageSize={PageSize}

Get all lookups for a given activity specified by configid and activityid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/activities/{activityid}/lookups?PageNumber={PageNumber}&PageSize={PageSize}

Get all lookups for a given activity specified by configid and activityid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/activities/{activityid}/lookups/{lookupid}

Get details for a single lookup of an activity identified by configid, activityid and lookupid.

GET api/v1/configsets/{configid}/activities/{activityid}/lookups/{lookupid}

Get details for a single lookup of an activity identified by configid, activityid and lookupid.

DELETE api/v1/configsets/{configid}/lookups/{lookupid}

Delete a lookup for an activity specified by configid and lookupid.

DELETE api/v2/configsets/{configid}/lookups/{lookupid}

Delete a lookup for an activity specified by configid and lookupid.

PUT api/v2/configsets/{configid}/activities/{activityid}/lookups/{lookupid}

Modify details for a lookup identified by configid, activityid and lookupid. LookupId is returned in response.

PUT api/v1/configsets/{configid}/activities/{activityid}/lookups/{lookupid}

Modify details for a lookup identified by configid, activityid and lookupid. LookupId is returned in response.

POST api/v2/configsets/{configid}/activities/{activityid}/Lookups

Add a lookup for an activity identified by configid and activityid. LookupId is returned in response.

POST api/v1/configsets/{configid}/activities/{activityid}/Lookups

Add a lookup for an activity identified by configid and activityid. LookupId is returned in response.

ConfigSet

APIDescription
GET api/v2/configsets/{configid}

Get details of a single configset.

GET api/v1/configsets/{configid}

Get details of a single configset.

GET api/v2/configsets?PageNumber={PageNumber}&PageSize={PageSize}

Get details of all configsets.

GET api/v1/configsets?PageNumber={PageNumber}&PageSize={PageSize}

Get details of all configsets.

DELETE api/v2/configsets/{configid}

Delete the given configset.

DELETE api/v1/configsets/{configid}

Delete the given configset.

PUT api/v2/configsets/{configid}

Modify a Config Set specified by configid.

PUT api/v1/configsets/{configid}

Modify a Config Set specified by configid.

POST api/v2/configsets

Create a new ConfigSet.

POST api/v1/configsets

Create a new ConfigSet.

DataViz

APIDescription
GET api/v1/configsets/{configid}/vendataforea

gets a list of VennDataItem for a given config id

GET api/v2/configsets/{configid}/vendataforea

gets a list of VennDataItem for a given config id

POST api/v1/configsets/{configid}/benchmarkactivitieschart

returns list of BenchmarkActivityChart

POST api/v2/configsets/{configid}/benchmarkactivitieschart

returns list of BenchmarkActivityChart

POST api/v1/configsets/{configid}/usersinbenchmarkwindow

returns list of users that on the basis of parameters passed.

POST api/v2/configsets/{configid}/usersinbenchmarkwindow

returns list of users that on the basis of parameters passed.

Social

APIDescription
GET api/v2/configsets/{configid}/users/{uniqueuserid}/socialprofile

Get user social profile data

GET api/v2/configsets/{configid}/users/{uniqueuserid}/tweets?RecordCount={RecordCount}

Get top n tweets for the user

GET api/v2/configsets/{configid}/twitterfeed?Since={Since}&RecordCount={RecordCount}

Get twitter feed

GET api/v2/configsets/{configid}/datacounters

Get Data Counters

GET api/v2/configsets/{configid}/liveuserfeed?RecordCount={RecordCount}

Get top n active users on SMCC

DELETE api/v2/configsets/{configid}/social/users/{uniqueuserid}/remove

Remove the selected user from loyalty social DB

DELETE api/v2/configsets/{configid}/social/users/{uniqueuserid}/discard

Discard the user from being tracked from SMCC

POST api/v2/configsets/{configid}/social/profile?RecordCount={RecordCount}&uniqueuserid={uniqueuserid}

Create or update the social profile. This API creates new user in the system if client user id is not passed.

Rule

APIDescription
GET api/v2/configsets/{configSetId}/rules/{ruleId}

Get a single rule details identified by configSetId and ruleId.

GET api/v1/configsets/{configSetId}/rules/{ruleId}

Get a single rule details identified by configSetId and ruleId.

GET api/v1/configsets/{configSetId}/rules/{ruleId}/AddEditRuleData?activityId={activityId}

Get Rules Master data for Rule identified by configSetId, ruleId and activityId.

GET api/v2/configsets/{configSetId}/rules/{ruleId}/AddEditRuleData?activityId={activityId}

Get Rules Master data for Rule identified by configSetId, ruleId and activityId.

POST api/v2/configsets/{configSetId}/searchrules

Get Rules Master data for Rule identified by configSetId and search parameters.

POST api/v1/configsets/{configSetId}/searchrules

Get Rules Master data for Rule identified by configSetId and search parameters.

PUT api/v2/configsets/{configSetId}/rules/{ruleId}

Modify an existing Rule identified by configid and ruleid

PUT api/v1/configsets/{configSetId}/rules/{ruleId}

Modify an existing Rule identified by configid and ruleid

POST api/v2/configsets/{configSetId}/rules

Add rule for a given activity identified by configid and new Rule info.

POST api/v1/configsets/{configSetId}/rules

Add rule for a given activity identified by configid and new Rule info.

DELETE api/v1/configsets/{configSetId}/rules/{ruleId}

Delete a rule from an activity identified by ruleId and configSetId to which the activity belongs.

DELETE api/v2/configsets/{configSetId}/rules/{ruleId}

Delete a rule from an activity identified by ruleId and configSetId to which the activity belongs.

POST api/v1/configsets/{configid}/rules/simple

Save Unconditional rules based on configid and request JSON.

POST api/v2/configsets/{configid}/rules/simple

Save Unconditional rules based on configid and request JSON.

PUT api/v2/configsets/{configid}/rules/{ruleid}/simple

Modify simple rule based on configid, ruleid and request JSON.

PUT api/v1/configsets/{configid}/rules/{ruleid}/simple

Modify simple rule based on configid, ruleid and request JSON.

Campaign

APIDescription
GET api/v1/configsets/{configid}/campaigns?PageNumber={PageNumber}&PageSize={PageSize}&filterby={filterby}

Get all campaigns from a given Config Set identified by ConfigSetId. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/campaigns?PageNumber={PageNumber}&PageSize={PageSize}&filterby={filterby}

Get all campaigns from a given Config Set identified by ConfigSetId. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

DELETE api/v1/configsets/{configid}/campaigns/{campaignid}

Delete a campaign from a Config Set identified by ConfigSetId and campaignID.

DELETE api/v2/configsets/{configid}/campaigns/{campaignid}

Delete a campaign from a Config Set identified by ConfigSetId and campaignID.

POST api/v1/configsets/{configid}/users/{uniqueuserid}/cards

Get Queue Card Messages: Returns the queue card messages list for a configset

POST api/v2/configsets/{configid}/users/{uniqueuserid}/cards

Get Queue Card Messages: Returns the queue card messages list for a configset

GET api/v2/messagechannel

Get master list of channels

GET api/v1/messagechannel

Get master list of channels

POST api/v1/configsets/{configid}/campaign/source

Saves the data source and campaign information

POST api/v2/configsets/{configid}/campaign/source

Saves the data source and campaign information

POST api/v2/configsets/{configid}/campaign/{campaignId}/source

Update source information and campaign name

POST api/v1/configsets/{configid}/campaign/{campaignId}/source

Update source information and campaign name

POST api/v1/configsets/{configid}/campaign/{campaignid}/schedule

save(add) campaign scheduler for given campaign

POST api/v2/configsets/{configid}/campaign/{campaignid}/schedule

save(add) campaign scheduler for given campaign

PUT api/v1/configsets/{configid}/campaign/{campaignid}/schedule/{schedulerid}

Update schedule details for selected campaign

PUT api/v2/configsets/{configid}/campaign/{campaignid}/schedule/{schedulerid}

Update schedule details for selected campaign

GET api/v2/configsets/{configid}/campaign/{campaignID}/source

Get source details for the selected campaign id

GET api/v1/configsets/{configid}/campaign/{campaignID}/source

Get source details for the selected campaign id

GET api/v1/configsets/{configid}/campaign/{campaignid}/scheduledetails

Get Schedule details

GET api/v2/configsets/{configid}/campaign/{campaignid}/scheduledetails

Get Schedule details

PUT api/v2/configsets/{configid}/campaigns/{campaignID}/status?Status={Status}

Update the campaign status to Published or Draft

PUT api/v1/configsets/{configid}/campaigns/{campaignID}/status?Status={Status}

Update the campaign status to Published or Draft

POST api/v1/configsets/{configid}/campaigns/EADataSource

Save the userids from EA for campaign creation

POST api/v2/configsets/{configid}/campaigns/EADataSource

Save the userids from EA for campaign creation

GET api/v1/configsets/{configid}/campaign/datasets

Get previously saved datasets for campaign creation

GET api/v2/configsets/{configid}/campaign/datasets

Get previously saved datasets for campaign creation

POST api/v1/configsets/{configid}/campaign/{campaignid}/cardresponse

Save Campaign Response

POST api/v2/configsets/{configid}/campaign/{campaignid}/cardresponse

Save Campaign Response

DELETE api/v2/configsets/{configid}/messagequeue/{messagequeueid}

Delete a notification from message queue identified by ConfigSetId

DELETE api/v1/configsets/{configid}/messagequeue/{messagequeueid}

Delete a notification from message queue identified by ConfigSetId

POST api/v2/configsets/{configid}/campaign/runnow

Trigger campaign now, this will run the selected campaign right away. The campaign should be in published state.

Level

APIDescription
GET api/v1/configsets/{configid}/levels/{levelid}

Get details for a single level specified by configid and levelid.

GET api/v2/configsets/{configid}/levels/{levelid}

Get details for a single level specified by configid and levelid.

GET api/v1/configsets/{configid}/levels?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of all levels for a Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/levels?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of all levels for a Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

DELETE api/v1/configsets/{configid}/levels/{levelid}

Delete a level from a Config Set specified by configid and levelid.

DELETE api/v2/configsets/{configid}/levels/{levelid}

Delete a level from a Config Set specified by configid and levelid.

PUT api/v2/configsets/{configid}/levels/{levelid}

Modify a level for a Config Set identified by configid and levelid.

PUT api/v1/configsets/{configid}/levels/{levelid}

Modify a level for a Config Set identified by configid and levelid.

POST api/v2/configsets/{configid}/levels

Add a level to a Config Set identified by configid. LevelId is returned in response.

POST api/v1/configsets/{configid}/levels

Add a level to a Config Set identified by configid. LevelId is returned in response.

Geofence

APIDescription
GET api/v2/configsets/{configid}/geofences?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of geofences belonging to a Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/geofences/{geofenceid}

Get details for a specific geofence identified by geofenceid and configid.

POST api/v2/configsets/{configid}/geofences

Create a new geofence in a Config Set specified by configid

PUT api/v2/configsets/{configid}/geofences/{geofenceid}

Modify details of an existing geofence in a Config Set. Geofence is specified by configid and geofenceId

DELETE api/v2/configsets/{configid}/geofences/{geofenceid}

Delete a geofence specified by configid and geofenceid.

GET api/v2/configsets/{configid}/geofences/rewards

Get all the geofence rewards for a configset

User

APIDescription
GET api/v2/configsets/{configid}/users?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of users belonging to given configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/users/{clientUserId}/details

Get the user details. The user is identified by specifying configid and the client user ID.

POST api/v2/configsets/{configid}/searchusers?PageNumber={PageNumber}&PageSize={PageSize}

DeltaCalculator

APIDescription
GET api/v2/configsets/{configid}/deltaconfiguration

Get configuration parameters for Delta Calculator Filters to be used, Blocking parameters to be eliminated, Thresholds for Criticality and Minimum Condition

GET api/v2/configsets/{configid}/deltaexpressions/{activityKey}

Returns list of DeltaExpressions for a given config id

GET api/v2/configsets/{configid}/deltaexpressions?activityKey={activityKey}

Returns list of DeltaExpressions for a given config id

POST api/v2/configsets/{configid}/blockingparameters

Sets the blocking parameters for the Delta Calculator

POST api/v2/configsets/{configid}/criticality

Updates the criticality for each delta expression

POST api/v2/configsets/{configid}/deltacalculatorthreshold

Sets the Threshold for calculating delta for user

POST api/v2/configsets/{configid}/filters

Sets the filters to be used for calculating delta for user

POST api/v2/configsets/{configid}/users/{uniqueuserid}/recommend

Gets Recommendation for a user

POST api/v1/configsets/{configid}/users/{uniqueuserid}/recommend

Gets Recommendation for a user

POST api/v2/configsets/{configid}/users/{uniqueuserid}/recommendations/{Limit}

Gets top n recommendations for given user

POST api/v2/configsets/{configid}/users/{uniqueuserid}/delta

Get Recommendations for the Data Visualisation UI

POST api/v2/configsets/{configId}/users/{uniqueuserid}/recommendation/notify

Send notification to user

RuleGroup

APIDescription
GET api/v2/configsets/{configid}/rulegroups/{groupid}?activityid={activityid}

Get details of a single group identified by configid, groupid and activityid.

GET api/v1/configsets/{configid}/rulegroups/{groupid}?activityid={activityid}

Get details of a single group identified by configid, groupid and activityid.

DELETE api/v2/configsets/{configid}/rulegroups/{groupid}?activityid={activityid}

Delete the given Rule Group identified by configid, activityid and groupid.

DELETE api/v1/configsets/{configid}/rulegroups/{groupid}?activityid={activityid}

Delete the given Rule Group identified by configid, activityid and groupid.

PUT api/v1/configsets/{configid}/rulegroups/{groupid}

Modify an existing Rule Group identified by configid, groupid and request JSON.

PUT api/v2/configsets/{configid}/rulegroups/{groupid}

Modify an existing Rule Group identified by configid, groupid and request JSON.

POST api/v2/configsets/{configid}/rulegroups

Add a new Rule Group in the specified Config Set based on configid and request JSON.

POST api/v1/configsets/{configid}/rulegroups

Add a new Rule Group in the specified Config Set based on configid and request JSON.

Badges

APIDescription
GET api/v2/configsets/{configid}/badges?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of all the badges in a given Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/badges?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of all the badges in a given Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/badges/{badgeid}

Get details for a single badge specified by configid and badgeid.

GET api/v2/configsets/{configid}/badges/{badgeid}

Get details for a single badge specified by configid and badgeid.

DELETE api/v1/configsets/{configid}/badges/{badgeid}

Delete a badge specified by configid and badgeid.

DELETE api/v2/configsets/{configid}/badges/{badgeid}

Delete a badge specified by configid and badgeid.

PUT api/v1/configsets/{configid}/badges/{badgeid}

Modify details for a badge specified by configid and badgeid. BadgeId is returned in response.

PUT api/v2/configsets/{configid}/badges/{badgeid}

Modify details for a badge specified by configid and badgeid. BadgeId is returned in response.

POST api/v2/configsets/{configid}/badges

Add a new badge to a Config Set specified by configid. BadgeId is returned in response.

POST api/v1/configsets/{configid}/badges

Add a new badge to a Config Set specified by configid. BadgeId is returned in response.

EAConfiguration

APIDescription
GET api/v2/configsets/{configid}/eabenchmark

Get the EA Benchmark values for all four Engagement levels for a Config Set specified by configid.

GET api/v1/configsets/{configid}/eabenchmark

Get the EA Benchmark values for all four Engagement levels for a Config Set specified by configid.

GET api/v1/configsets/{configid}/eaconfigurations

Get the EA Configuration details for all activities under a given Config Set. Config Set is specified by configid.

GET api/v2/configsets/{configid}/eaconfigurations

Get the EA Configuration details for all activities under a given Config Set. Config Set is specified by configid.

POST api/v2/configsets/{configid}/eabenchmark/calculateeascore/{calculateeascores}

Set the EA Benchmark values for all four Engagement levels for a Config Set specified by configid.

POST api/v1/configsets/{configid}/eabenchmark/calculateeascore/{calculateeascores}

Set the EA Benchmark values for all four Engagement levels for a Config Set specified by configid.

POST api/v1/configsets/{configid}/eaconfigurations/calculateeascore/{calculateeascores}

Set EA Configuration for all the activities belonging to a Config Set specified by configid.

POST api/v2/configsets/{configid}/eaconfigurations/calculateeascore/{calculateeascores}

Set EA Configuration for all the activities belonging to a Config Set specified by configid.

Notification

APIDescription
GET api/v2/configsets/{configid}/notifications?PageNumber={PageNumber}&PageSize={PageSize}

Get all notifacations from a given Config Set identified by ConfigSetId. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/notifications?PageNumber={PageNumber}&PageSize={PageSize}

Get all notifacations from a given Config Set identified by ConfigSetId. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/notification/{notificationid}

Get details for notification for a specific Config Set.Notificaiton messages are identified by notificationid.

GET api/v2/configsets/{configid}/notification/{notificationid}

Get details for notification for a specific Config Set.Notificaiton messages are identified by notificationid.

POST api/v2/configsets/{configid}/notification

Add a notification to a Config Set identified by ConfigSetId. notificationID is returned in response.

POST api/v1/configsets/{configid}/notification

Add a notification to a Config Set identified by ConfigSetId. notificationID is returned in response.

PUT api/v1/configsets/{configid}/notification/{notificationid}

Modify an existing notification identified by configid and notificationID.

PUT api/v2/configsets/{configid}/notification/{notificationid}

Modify an existing notification identified by configid and notificationID.

DELETE api/v2/configsets/{configid}/notification/{notificationid}

Delete a notification from a Config Set identified by ConfigSetId and notificationid.

DELETE api/v1/configsets/{configid}/notification/{notificationid}

Delete a notification from a Config Set identified by ConfigSetId and notificationid.

Permission

APIDescription
GET api/v1/configsets/{configid}/permissions

Get access permissions for given configid

GET api/v2/configsets/{configid}/permissions

Get access permissions for given configid

Tenant

APIDescription
GET api/v2/configsets/{configid}/tenant

Get TenantId and external Gift System API Configuration details,for a single configset

GET api/v1/configsets/{configid}/tenant

Get TenantId and external Gift System API Configuration details,for a single configset

POST api/v2/configsets/{configid}/tenant

Save TenantId and external Reward System API Configuration details,for a configset

POST api/v1/configsets/{configid}/tenant

Save TenantId and external Reward System API Configuration details,for a configset

DELETE api/v1/configsets/{configid}/tenant

Delete the Tenant Id mapping for a given configset.

DELETE api/v2/configsets/{configid}/tenant

Delete the Tenant Id mapping for a given configset.

Account

APIDescription
GET api/v2/Account/UserInfo

Get information about System Administrator.

GET api/v1/Account/UserInfo

Get information about System Administrator.

GET api/v2/Account/UserDetails

Get details of System Administrator user.

GET api/v1/Account/UserDetails

Get details of System Administrator user.

POST api/v1/Account/Logout

Logout from current session of logged in user.

POST api/v2/Account/Logout

Logout from current session of logged in user.

POST api/v2/Account/ExternalLogin

Allow user to login using external service providers

POST api/v2/Account/ChangePassword

Change password for the logged in user. Accepts old password and new password.

POST api/v1/Account/ChangePassword

Change password for the logged in user. Accepts old password and new password.

POST api/v2/Account/ResetPassword

Reset password for a user specified by Username. Code is the reset password token sent to the user through email triggered by Forgot Password.

POST api/v1/Account/ResetPassword

Reset password for a user specified by Username. Code is the reset password token sent to the user through email triggered by Forgot Password.

POST api/v1/Account/ForgotPassword

Generates a reset password link sent in an email to the user specified by UserName.

POST api/v2/Account/ForgotPassword

Generates a reset password link sent in an email to the user specified by UserName.

POST api/v1/Account/RegisterEngagementProgram

Create an Engagement Program in Loyalty Platform which creates a Config Set, Customer Administrator and an Application User.

POST api/v2/Account/RegisterEngagementProgram

Create an Engagement Program in Loyalty Platform which creates a Config Set, Customer Administrator and an Application User.

POST api/v1/Account/GetRegistrationDetails

Gets details of Config Set specified by ConfigId in the request body. Details such as Name, Description, Customer Administrators and Application Users.

POST api/v2/Account/GetRegistrationDetails

Gets details of Config Set specified by ConfigId in the request body. Details such as Name, Description, Customer Administrators and Application Users.

GET api/v1/Account/configsets/{configid}/adminusers/{username}

Get details for a single Admin User for a Config Set identified by configid and adminUserid.

GET api/v2/Account/configsets/{configid}/adminusers/{username}

Get details for a single Admin User for a Config Set identified by configid and adminUserid.

PUT api/v1/Account/configsets/{configid}/adminusers/{username}

Modify an existing Admin User from a Config Set identified by configid and adminUserid.

PUT api/v2/Account/configsets/{configid}/adminusers/{username}

Modify an existing Admin User from a Config Set identified by configid and adminUserid.

POST api/v2/Account/configsets/{configid}/adminusers

Add a new Admin User to a Config Set identified by configid.

POST api/v1/Account/configsets/{configid}/adminusers

Add a new Admin User to a Config Set identified by configid.

GET api/v2/Account/adminusers/{username}

Search an Admin User by username

GET api/v1/Account/adminusers/{username}

Search an Admin User by username

POST api/v1/Account/configsets/{configid}/adminusers/{username}

Adds association of an Admin User to a Config Set.

POST api/v2/Account/configsets/{configid}/adminusers/{username}

Adds association of an Admin User to a Config Set.

DELETE api/v1/Account/configsets/{configid}/adminusers/{username}

Deletes association of an Admin User from a Config Set.

DELETE api/v2/Account/configsets/{configid}/adminusers/{username}

Deletes association of an Admin User from a Config Set.

GET api/v1/Account/configsets/{configid}/applicationusers/{username}

Get details for a single Application User for a Config Set identified by configid and appuserid.

GET api/v2/Account/configsets/{configid}/applicationusers/{username}

Get details for a single Application User for a Config Set identified by configid and appuserid.

DELETE api/v2/Account/configsets/{configid}/applicationusers/{username}

Delete an existing Application User from a Config Set identified by configid and appuserid.

DELETE api/v1/Account/configsets/{configid}/applicationusers/{username}

Delete an existing Application User from a Config Set identified by configid and appuserid.

PUT api/v2/Account/configsets/{configid}/applicationusers/{username}

Modify an existing Application User from a Config Set identified by configid and applicationUserid.

PUT api/v1/Account/configsets/{configid}/applicationusers/{username}

Modify an existing Application User from a Config Set identified by configid and applicationUserid.

POST api/v1/Account/configsets/{configid}/applicationusers

Add a new Application User to a Config Set identified by configid.

POST api/v2/Account/configsets/{configid}/applicationusers

Add a new Application User to a Config Set identified by configid.

POST api/v2/Account/LDAPAuthenticate

LDAP Authentication for provided domain, username and password

POST api/v1/Account/LDAPAuthenticate

LDAP Authentication for provided domain, username and password

POST api/v2/Account/configsets/{configid}/user/register

Register new user for selected config set

PUT api/v2/Account/configsets/{configid}/user/register

Register user for login if the client user id is already created in the POD system

POST api/v2/Account/configsets/{configid}/users/details

Create a user for given configid. Returns User ID in response.

PUT api/v2/Account/configsets/{configid}/users/{clientUserId}/details

Update a user for given configid.

DELETE api/v2/Account/configsets/{configid}/users/{clientUserId}/details

Delete the user for the given configid. The user is identified by specifying configid and the client user ID.

POST api/v2/configsets/{configId}/users/{LocalClientUserId}/linkaccount/{ExternalProviderId}

LinkAccounts : Links the current/local account with external/social account

POST api/v2/Account/configsets/{configId}/user/RegisterExternal

Register External User with custom Authentication provider

Gamification

APIDescription
GET api/v1/configsets/{configid}/users/{uniqueuserid}/profile

Get the details about a particular user, available and lifetime points, the badges earned and the count of each earned badge by the given user. User is identified by uniqueuserid and the configid specifies the Config Set.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/profile

Get the details about a particular user, available and lifetime points, the badges earned and the count of each earned badge by the given user. User is identified by uniqueuserid and the configid specifies the Config Set.

GET api/v1/configsets/{configid}/users/{uniqueuserid}

Get the details about a particular user, available and lifetime points, the badges earned and the count of each earned badge by the given user. User is identified by uniqueuserid and the configid specifies the Config Set.

GET api/v2/configsets/{configid}/users/{uniqueuserid}

Get the details about a particular user, available and lifetime points, the badges earned and the count of each earned badge by the given user. User is identified by uniqueuserid and the configid specifies the Config Set.

GET api/v1/configsets/{configid}/users/{uniqueuserid}/badges

Get the badges and the count for each badge earned by a particular user identified by uniqueuserid under the given configid.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/badges

Get the badges and the count for each badge earned by a particular user identified by uniqueuserid under the given configid.

GET api/v1/configsets/{configid}/users/{uniqueuserid}/activities

Get the list of all the activities under a particular Config Set performed by a particular user and the reward earned for each activity. User is identified by uniqueuserid and Config Set is identified by configid.

GET api/v1/configsets/{configid}/users/{uniqueuserid}/rewards

Get the list of all the rewards under a particular Config Set for activities performed by a particular user and the reward earned for each activity. User is identified by uniqueuserid and Config Set is identified by configid.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/rewards

Get the list of all the rewards under a particular Config Set for activities performed by a particular user and the reward earned for each activity. User is identified by uniqueuserid and Config Set is identified by configid.

POST api/v2/configsets/{configid}/users/{uniqueuserid}/activity/process

Process the activity for a Config Set identified by the configid and the rules within the activity for a single user specified using uniqueuserid. The activity to be processed is specified using ActivityKey and the parameters for the rules are mentioned in the ParameterJSON.

POST api/v1/configsets/{configid}/users/{uniqueuserid}/activity/process

Process the activity for a Config Set identified by the configid and the rules within the activity for a single user specified using uniqueuserid. The activity to be processed is specified using ActivityKey and the parameters for the rules are mentioned in the ParameterJSON.

POST api/v2/configsets/{configid}/users/{uniqueuserid}/activity/save

Save an activity for a Config Set identified by the configid for a single user specified using uniqueuserid. The activity to be saved is specified using ActivityKey and the parameters for the rules are mentioned in the ParameterJSON.

POST api/v1/configsets/{configid}/users/{uniqueuserid}/activity/save

Save an activity for a Config Set identified by the configid for a single user specified using uniqueuserid. The activity to be saved is specified using ActivityKey and the parameters for the rules are mentioned in the ParameterJSON.

POST api/v2/configsets/{configid}/users/{uniqueuserid}/activity/evaluate

Evaluate the activity for a Config Set identified by the configid and the rules within the activity for a single user specified using uniqueuserid. The activity to be evaluated is specified using ActivityKey and the parameters for the rules are mentioned in the ParameterJSON.

POST api/v1/configsets/{configid}/users/{uniqueuserid}/activity/evaluate

Evaluate the activity for a Config Set identified by the configid and the rules within the activity for a single user specified using uniqueuserid. The activity to be evaluated is specified using ActivityKey and the parameters for the rules are mentioned in the ParameterJSON.

POST api/v1/configsets/{configid}/users/{uniqueuserid}/points/redeem

Redeem points for a single user specified using uniqueuserid

POST api/v2/configsets/{configid}/users/{uniqueuserid}/points/redeem

Redeem points for a single user specified using uniqueuserid

POST api/v2/configsets/{configid}/users/{uniqueuserid}/points

Insert points for a single user specified using uniqueuserid

POST api/v1/configsets/{configid}/users/{uniqueuserid}/points

Insert points for a single user specified using uniqueuserid

POST api/v2/configsets/{configid}/users/{uniqueuserid}/badge/{badgeid}

Give Badge for a single user specified using uniqueuserid

POST api/v1/configsets/{configid}/users/{uniqueuserid}/badge/{badgeid}

Give Badge for a single user specified using uniqueuserid

GET api/v1/configsets/{configid}/users/{uniqueuserid}/fraudscore

Get the fraud score of a single user specified using uniqueuserid

GET api/v2/configsets/{configid}/users/{uniqueuserid}/fraudscore

Get the fraud score of a single user specified using uniqueuserid

GET api/v2/configsets/{configSet}/transactions/{TransactionID}/cancel

To cancel the transaction using transaction id

GET api/v2/configsets/{configSet}/clienttransactions/{TransactionID}/cancel

To cancel the transaction by client transaction id

GET api/v2/configsets/{configid}/users/{uniqueuserid}/activities

Get the list of all the activities under a particular Config Set performed by a particular user and the reward earned for each activity with status flag. User is identified by uniqueuserid and Config Set is identified by configid.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/percentagescore?Fromdate={Fromdate}&Todate={Todate}

Gets the Percentage Score for a user

GET api/v2/help/errors?Code={Code}

Get All Errors or Errors filtered by error code

POST api/v2/configsets/{configid}/resetrequest

No documentation available.

GET api/v2/configsets/{configid}/resetrequest?PageNumber={PageNumber}&PageSize={PageSize}

No documentation available.

Collection

APIDescription
GET api/v1/configsets/{configid}/collections

Get the list of collections from the given Config Set identified by configid.

GET api/v2/configsets/{configid}/collections

Get the list of collections from the given Config Set identified by configid.

DELETE api/v1/configsets/{configid}/collections/{collectionid}

Delete an existing collection from the given Config Set identified by configid and collectionid.

DELETE api/v2/configsets/{configid}/collections/{collectionid}

Delete an existing collection from the given Config Set identified by configid and collectionid.

POST api/v1/configsets/{configid}/Collections

Create a collection in the given Config Set identified by configid. Returns CollectionID in response.

POST api/v2/configsets/{configid}/Collections

Create a collection in the given Config Set identified by configid. Returns CollectionID in response.

GET api/v1/configsets/{configid}/collections/{collectionId}

Get the details of a single collection from a Config Set identified by configid and collectionid.

GET api/v2/configsets/{configid}/collections/{collectionId}

Get the details of a single collection from a Config Set identified by configid and collectionid.

DELETE api/v2/configsets/{configid}/collections/{collectionId}/values/{valueid}

Delete an existing value from a collection identified by collectionid, valueid and the configid of the Config Set to which the collection belongs.

DELETE api/v1/configsets/{configid}/collections/{collectionId}/values/{valueid}

Delete an existing value from a collection identified by collectionid, valueid and the configid of the Config Set to which the collection belongs.

POST api/v1/configsets/{configid}/Collections/{collectionId}/values

Add one or more values to a given collection under a given Config Set. Collection is identified by collectionid and configid.

POST api/v2/configsets/{configid}/Collections/{collectionId}/values

Add one or more values to a given collection under a given Config Set. Collection is identified by collectionid and configid.

PUT api/v1/configsets/{configid}/collections/{collectionId}/values/{valueid}

Modify an existing value in a given collection under a Config Set. Value is identified by valueid, collectionId and configid.

PUT api/v2/configsets/{configid}/collections/{collectionId}/values/{valueid}

Modify an existing value in a given collection under a Config Set. Value is identified by valueid, collectionId and configid.

Parameter

APIDescription
GET api/v1/configsets/{configid}/parameters/{parameterid}

Get details for a specific parameter identified by parameterid and configid.

GET api/v2/configsets/{configid}/parameters/{parameterid}

Get details for a specific parameter identified by parameterid and configid.

GET api/v2/configsets/{configid}/parameters?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of parameters belonging to a Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/parameters?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of parameters belonging to a Config Set specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

DELETE api/v2/configsets/{configid}/parameters/{parameterid}

Delete a parameter specified by configid and parameterid.

DELETE api/v1/configsets/{configid}/parameters/{parameterid}

Delete a parameter specified by configid and parameterid.

PUT api/v2/configsets/{configid}/parameters/{parameterid}

Modify parameter details identified by configid and parameterid. Parameter Id is returned in response.

PUT api/v1/configsets/{configid}/parameters/{parameterid}

Modify parameter details identified by configid and parameterid. Parameter Id is returned in response.

POST api/v1/configsets/{configid}/parameters

Add a parameter to a Config Set identified by configid. Parameter Id is returned in response.

POST api/v2/configsets/{configid}/parameters

Add a parameter to a Config Set identified by configid. Parameter Id is returned in response.

POST api/v1/configsets/{configid}/parameters/bulk

Adds multiple parameters to a Config Set identified by configid.

POST api/v2/configsets/{configid}/parameters/bulk

Adds multiple parameters to a Config Set identified by configid.

GET api/v2/configsets/{configid}/systemparameters

Get all system parameters for eMee POD

Dashboard

APIDescription
GET api/v2/configsets/{configid}/users/{uniqueuserid}/activitystats?Top={Top}&FromDays={FromDays}

Get activity stat data for dashboard activity widgets.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/compliancestats

Get compliance stat data for dashboard compliance widgets.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/socialprofilecloud/{Sentiment}?RecordCount={RecordCount}

Get social profile cloud for given user

GET api/v2/configsets/{configid}/usagestats

Get configset usage stats.

GET api/v2/configsets/{configid}/usagestats/{statstype}?StartDate={StartDate}&EndDate={EndDate}

Get configsets usage stats details.

GET api/v2/configsets/{configid}/users/{uniqueuserid}/leaderboards/frienemy?Count={Count}&ScoreTypes={ScoreTypes}

Get user's frienemy leaderboards. Accepts config set id, unique user id, comma seperated score types names,and total users count. Returns – current user id rank and value for score types, x users on top and x users on bottom with their rank and value, and the leader in that Score Types, along with his rank and value. x = Count/2

GET api/v2/configsets/{configid}/users/{uniqueuserid}/leaderboards/kpis/frienemy?Count={Count}&KPIKey={KPIKey}

Get user's frienemy leaderboards for KPI Accepts config set id, unique user id, comma seperated KPI names,and total users count. Returns – current user id rank and value for KPI, x users on top and x users on bottom with their rank and value, and the leader in that KPI, along with his rank and value. x = Count/2

GET api/v2/configsets/{configid}/leaderboards/scoretype/{scoretype}?PageNumber={PageNumber}&PageSize={PageSize}

Get list of users with their rank and value for that score type.

GET api/v2/configsets/{configid}/leaderboards/kpis/{kpiKey}?PageNumber={PageNumber}&PageSize={PageSize}

Get list of users with their rank and value for that KPI

SAPSReward

APIDescription
GET api/v2/configsets/{configid}/sapsrewards?PageNumber={PageNumber}&PageSize={PageSize}

Get all SAPS reward from a given Config Set identified by ConfigSetId. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/sapsrewards?PageNumber={PageNumber}&PageSize={PageSize}

Get all SAPS reward from a given Config Set identified by ConfigSetId. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v1/configsets/{configid}/sapsrewards/{sapsrewardsid}

Get details for SAPS reward for a specific Config Set.SAPS reward are identified by sapsrewardsid.

GET api/v2/configsets/{configid}/sapsrewards/{sapsrewardsid}

Get details for SAPS reward for a specific Config Set.SAPS reward are identified by sapsrewardsid.

POST api/v1/configsets/{configid}/sapsrewards

Add a SAPS reward to a Config Set identified by ConfigSetId. SAPSRewardId is returned in response.

POST api/v2/configsets/{configid}/sapsrewards

Add a SAPS reward to a Config Set identified by ConfigSetId. SAPSRewardId is returned in response.

PUT api/v2/configsets/{configid}/sapsrewards/{sapsrewardid}

Modify an existing SAPS reward identified by configid and SAPSRewardID.

PUT api/v1/configsets/{configid}/sapsrewards/{sapsrewardid}

Modify an existing SAPS reward identified by configid and SAPSRewardID.

DELETE api/v2/configsets/{configid}/sapsrewards/{sapsrewardid}

Delete a SAPS reward from a Config Set identified by ConfigSetId and sapsrewardsid.

DELETE api/v1/configsets/{configid}/sapsrewards/{sapsrewardid}

Delete a SAPS reward from a Config Set identified by ConfigSetId and sapsrewardsid.

KPI

APIDescription
GET api/v2/configsets/{configid}/kpis

Get the list of all KPIs defined for the config set

GET api/v2/configsets/{configid}/kpis/{kpiKey}

Get details of a single KPI specified by configid.

POST api/v2/configsets/{configid}/kpis

Create a new KPI in a Config Set specified by configid

PUT api/v2/configsets/{configid}/kpis/{kpiKey}

Modify details of an existing KPI. KPI is specified by configid.

CategoryManagement

APIDescription
POST api/v1/configsets/{configid}/categories

Add a Rule Category in a Config Set specified by configid. Category Id is returned in response.

POST api/v2/configsets/{configid}/categories

Add a Rule Category in a Config Set specified by configid. Category Id is returned in response.

GET api/v1/configsets/{configid}/categories?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of all categories for a given Config Set. Config Set is specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

GET api/v2/configsets/{configid}/categories?PageNumber={PageNumber}&PageSize={PageSize}

Get a list of all categories for a given Config Set. Config Set is specified by configid. Number of records per page can be specified in PageSize and PageNumber allows to specify desired page number.

PUT api/v1/configsets/{configid}/categories

Modify existing Rule Category details by specifying CategoryId. Category Id is returned in response.

PUT api/v2/configsets/{configid}/categories

Modify existing Rule Category details by specifying CategoryId. Category Id is returned in response.

DELETE api/v2/configsets/{configid}/categories/{categoryid}

Delete an existing Rule Category specified by configid and categoryid. Category Id is returned in response.

DELETE api/v1/configsets/{configid}/categories/{categoryid}

Delete an existing Rule Category specified by configid and categoryid. Category Id is returned in response.