v1
latestOpenAPI 3.0.02026-07-22207183.5 KBGet 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.
For information on how to correctly generate the Authentication Token, please see the documentation: https://docs.mention-me.com/api-reference/entry-point-api/authentication-token
Path parameters
Version
Query parameters
Email address of the referrer whose dashboard you require
This is a signature using a salted hash of the email address of the customer with a secret key, and validates the authenticity of the request.
For information on how to correctly generate this token, please see the documentation: https://docs.mention-me.com/api-reference/entry-point-api/authentication-token
Your partner code, used to link to your users and offers
Situation - a string representing where in the application you are making this request
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.
Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in
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.
Customer Id - your unique identifier for this customer
User Device Identifier should be a unique reference to this combination of app + user.
Device type - your description of the device the user is using. We use this for performance and conversion optimisation.
Your application name. Used for reporting.
Your application version reference. Used for reporting and troubleshooting.
Response
Returned when successful