Profile

Profile
Ninetailed manages a visitor profile for automatically, which gets updated via page(), track(), identify() events. The profile is used internally to calculate your personalizations and render merge tags in your rich text components.
1
type Profile = {
2
  /**
3
   * An id which can get set by you - e.x. CRM id.
4
   */
5
  id?: string;
6
  /**
7
   * This is an internal identifier to find the visitor in our system.
8
   */
9
  anonymousId: string;
10
  /**
11
   * The calculated audiences the visitor is in.
12
   */
13
  audiences: string[];
14
  /**
15
   * Tratits you have set via identify(id: string, traits: Traits) calls.
16
   */
17
  traits: Traits;
18
  /**
19
   * The current location of the user.
20
   */
21
  location: Location;
22
};
Copied!
Traits is a json dataset which can be set by you through identify calls. Whenever you send new traits to our system we deeply merge the traits of the user. Traits are commonly used in merge tags to build inline personalization like  const headline = `Hey ${profile.traits.firstname}👋`.
1
type Traits = {
2
  [key: string]: string | number | boolean | Traits;
3
};
4
​
5
// example
6
const traits: Traits = {
7
  "firstname": "Max",
8
  "address": {
9
    "street": "Allee 33"
10
  },
11
  "company": "Big fat Company"
12
}
Copied!
Location is the last seen location of the user. You would normally use this to merge it into Richtext.
1
type Location = {
2
  coordinates?: {
3
    latitude: number;
4
    longitude: number;
5
  };
6
  city?: string;
7
  postalCode?: string;
8
  region?: string;
9
  regionCode?: string;
10
  country?: string;
11
  continent?: string;
12
  timezone?: string;
13
};
Copied!
Default location merge tags are available on selected accounts. Contact us to enable location merge tags..
useProfile
The useProfile hook makes it really easy for you to access the profile of the visitor. 
1
import { useProfile } from '@ninetailed/experience-sdk-react';
Copied!
The hook delivers the profile and the loading and error state.
1
const Greeting = () => {
2
    const [loading, profile, error] = useProfile();
3
    
4
    return <p>Hey {profile.traits.firstname}, nice weather in {profile.location.city}!</p>
5
}
Copied!
ProfileProvider
The ProfileProvider manages the internal state about the visitor and transmits this state to your personalized components. All components using useProfile need to be children of the ProfileProvider, that's why we recommend wrapping your app component with it.
1
import React from 'react';
2
import { ProfileProvider, AnalyticsProvider } from '@ninetailed/experience-sdk-react';
3
​
4
const App = () => {
5
    return (
6
        <ProfileProvider>
7
            <AnalyticsProvider apiKey="Your_API_Key">
8
                <YourAppCode />
9
            </AnalyticsProvider>
10
        </ProfileProvider>
11
    );
12
}
Copied!

Getting started

Analytics & Events

Last modified 2mo ago

Copy link

Contents

Profile

useProfile

ProfileProvider