Get dashboard

get https://mention-me.com/api/consumer/{version}/referrer/dashboard

Get a referrer's dashboard (given a referrer identity, get their dashboard data).

If we respond with a 404 they are not a referrer. Instead, you should Enrol them as a referrer first, then call this endpoint again.

Path Params

version

string

required

Version

Query Params

emailAddress

string

required

Email address of the referrer whose dashboard you require

request[authenticationToken]

string

required

This is a generated token using a salted hash of the email address of the customer with a secret key. Please ask us for your secret key.

request[partnerCode]

string

required

Your partner code, used to link to your users and offers

request[situation]

string

required

Situation - a string representing where in the application you are making this request

request[ipAddress]

string

IP address of the customer connection. If you're making a request on behalf of a customer, pass their IP address here. If the customer will connect directly, leave this empty and we will retrieve this from their request.

request[localeCode]

string

Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in

segment

string

Customer segment - a string containing segment data about this customer, e.g. vip or employee. You can concatenate multiple segments together if you wish using hyphens.

uniqueCustomerIdentifier

string

Customer Id - your unique identifier for this customer

request[userDeviceIdentifier]

string

User Device Identifier should be a unique reference to this combination of app + user.

request[deviceType]

string

Device type - your description of the device the user is using. We use this for performance and conversion optimisation.

request[appName]

string

Your application name. Used for reporting.

request[appVersion]

string

Your application version reference. Used for reporting and troubleshooting.

Responses

Response body

object

offer

shareLinks

array of objects

List of share links for different share mechanisms.

object

type

string

protocol

string

url

string

defaultShareMessage

string

exampleImplementation

string

You are free to implement this your own way if you wish

termsLinks

referralStats

referralRewards

array of objects

Referral rewards - list of potential rewards they are due for introducing customers.

object

description

string

The description we give may vary depending on the point in the flow that we choose to give it. Note that in some cases this might be "promising the reward" and in other cases "giving it".

e.g. "You'll get £20 for each friend you refer" e.g. "Your friends get a free camera when they order for the first time" e.g. "A 20% discount code"

summary

string

amount

string

status

string

forReferring

object

Has additional fields

204

No content, when the customer does not have a dashboard to show. Try enrolling them as a referrer first.

400

The request contains errors

403

Returned when the integration for this merchant is not enabled

404

Returned when it is not possible to serve a dashboard for this request

500

Internal server error, unable to complete the request

200Returned when successful