---
title: "Get dashboard"
method: POST
path: "/api/entry-point/{version}/dashboard"
tags: ["Dashboard"]
---

# Get dashboard

`POST /api/entry-point/{version}/dashboard`

Provide a customers' details so we can tell you if we could show them a dashboard (or offer). We'll provide the URL to the web-view for their dashboard.

Provide their full details (name, email, customerId) if you want us to optionally register them if they're not yet a referrer.

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` 'v2' | 'v1', required

## Request body

- EntryPointForDashboardType
  - `customer` CustomerDetails, required
    - `emailAddress` string, required — Customer email address
    - `title` string — Customer title such as Mr, Miss, Dr or Sir
    - `firstname` string, required — Customer firstname
    - `surname` string, required — Customer surname
    - `uniqueIdentifier` string — Your unique identifier for this customer e.g. CustomerId
    - `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.
    - `customField` string — Custom field - a string containing custom data about this customer, e.g. SEGMENT001 or Package B
    - `visitorId` string — The visitor ID from the MentionMe Browser Fingerprint, used to link customer journeys. This should be a SHA256 hash (browserId + clientIP).
  - `request` RequestAuthentication, required
    - `partnerCode` string, required — Your partner code, used to link to your users and offers
    - `situation` string, required — Situation - a string representing where in the application you are making this request
    - `segment` string — Segment - the segment the customer belongs to
    - `localeCode` string, required — Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in
    - `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.
    - `userDeviceIdentifier` string — User Device Identifier should be a unique reference to this device. We use this for preventing gaming. Multiple users with the same Device Identifier will be treated as the same individual and may be flagged for gaming. On Android the UniqueID could be an InstanceID or GUID. On iPhone the UniqueID should be generated by identifierForVendor.
    - `deviceType` string — Device type - your description of the device the user is using. We use this for performance and conversion optimisation.
    - `appName` string — Your application name. Used for reporting.
    - `appVersion` string — Your application version reference. Used for reporting and troubleshooting.
    - `authenticationToken` string, required — 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

## Response `200`

Returned when successful

- EntryPointLink
  - `url` string
  - `defaultCallToAction` string

## Other responses

- `404` — Returned when this specific integration point has been disabled, or we are unable to serve a dashboard for this customer
- `422` — The data presented contains validation errors, please correct and try again
- `500` — Internal server error, unable to complete the request

---

[API](https://skmtc.net/mention-me/apis/auth-api.md) · [All operations](https://skmtc.net/mention-me/apis/auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mention-me/auth-api/versions/cdad84f071bd/schema)