# Lytics

[Lytics](https://www.lytics.com/) is a popular customer data platform built for marketers. It allows you to efficiently leverage your first-party customer data to deliver tailored customer journeys.

RudderStack supports Lytics as a destination to which you can seamlessly send your event data.

Find the open-source transformer code for this destination in the [GitHub repository](https://github.com/rudderlabs/rudder-transformer/tree/master/v0/destinations/lytics).

## Getting started

Before configuring Lytics as a destination in RudderStack, verify if the source platform is supported by Lytics, by referring to the table below:

| **Connection Mode** | **Web**       | **Mobile**    | **Server**    |
| ------------------- | ------------- | ------------- | ------------- |
| **Device mode**     | **Supported** | -             | **-**         |
| **Cloud mode**      | **Supported** | **Supported** | **Supported** |

To know more about the difference between cloud mode and device mode in RudderStack, refer to the [RudderStack Connection Modes](https://rudderstack.com/docs/rudderstack-cloud/rudderstack-connection-modes/) guide.

Once you have confirmed that the source platform supports sending events to Lytics, follow these steps:

1. From your [RudderStack dashboard](https://app.rudderstack.com/), add the source. Then, from the list of destinations, select **Lytics**.
2. Assign a name to your destination and click on **Next**.

### Connection settings

To successfully configure Lytics as a destination, you need to configure the following settings:

![Lytics connection settings](https://876606571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lq5Ea6fHVg3dSxMCgyQ%2Fuploads%2Fgit-blob-1c615472a77987fd8ab309c43e9e014b1654fa63%2Flytics-connection-settings.png?alt=media)

* **API Token**: Create an API token in your Lytics dashboard and enter the details here.

To get the API token, go to your Lytics dashboard and navigate to **Account** > **Account Settings** > **API Token**. You can create an API token here and use this information to configure Lytics as a destination.

* **Stream Name**: Enter the name of the Lytics stream where you want to send the events.
* **Client-side Event Filtering**: This setting is applicable **only if** you are sending events to Lytics via the device mode.

Refer to the [Client-side Event Filtering](https://www.rudderstack.com/docs/stream-sources/rudderstack-sdk-integration-guides/event-filtering/) guide for more information on this setting.

If you are using the JavaScript SDK to send the events to Lytics, enter the following settings:

![Lytics connection settings](https://876606571-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lq5Ea6fHVg3dSxMCgyQ%2Fuploads%2Fgit-blob-499803bb7d81ab5404a9668a9e3002b915724daf%2Flytics-connection-settings-2.png?alt=media)

* **Account ID**: Enter the the Lytics account ID obtained from your Lytics dashboard. For more information on obtaining the account ID, refer to the [Lytics support page](https://support.lytics.com/hc/en-us/articles/115001231351-How-do-I-find-my-Lytics-account-ID-). **This is a mandatory field**.
* **Allow UID Sharing Across Multiple Domains**: When enabled, this option lets you identify users across domains.
* **Ensure Entity**: When this option is enabled, RudderStack gets your most updated audience membership and profile data, before sending it to Lytics.
* **Use native SDK to send events**: Enable this setting if you are sending events via the device mode, that is, via the native web SDK.

## Identify

The `identify` call captures the relevant details about the visiting user.

For more information on the `identify` method, refer to the [RudderStack API Specification](https://rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/identify/) guide.

A sample `identify` payload is as shown in the snippet below:

```javascript
rudderanalytics.identify("1hKOm4GRlm", {
  name: "Alex Keener",
  email: "alex@example.com",
})
```

## Page

With the `page` method, RudderStack makes a call to Lytics to record a page view.

For more information on the `page` method, refer to the [RudderStack API Specification](https://rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/page/) guide.

A sample `page` call is as shown:

```javascript
rudderanalytics.page("Popular", "Bestseller", {
  url: "https://www.estore.com/search/best-seller/1",
  path: "/best-seller/1",
})
```

Similarly, you can also make [`screen`](https://rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/screen/) calls. However, this is supported only in the [cloud mode](https://rudderstack.com/docs/rudderstack-cloud/rudderstack-connection-modes/#cloud-mode).

A sample screen call is as shown:

```objectivec
[[RSClient sharedInstance] screen:@"Home"];
```

## Track

With the `track` API, RudderStack makes a call to Lytics to track user actions and their associated properties.

For more information on the `track` method, refer to the [RudderStack API Specification](https://rudderstack.com/docs/rudderstack-api/api-specification/rudderstack-spec/track/) guide.

A sample `track` call is as shown:

```javascript
rudderanalytics.track("Order Completed", {
  order_id: "1a2b3c4d",
  category: "category",
  revenue: 99.9,
  shipping: 13.99,
  tax: 20.99,
  promotion_id: "PROMO_1234",
})
```

## FAQs

### How do I obtain the Lytics API token?

Go to your Lytics dashboard, and navigate to **Account** > **Account Settings** > **API Token**. You can create an API token here, which can be used to configure the destination on the RudderStack dashboard.

For more information, refer to the [Lytics documentation](https://learn.lytics.com/documentation/product/features/account-management/managing-api-tokens#managing-api-tokens).

### How do I obtain the Lytics account ID?

To obtain your Lytics account ID, follow these steps:

1. Log into your Lytics dashboard.
2. Click on the account name on the top right and go to **Manage Accounts**.

Here, you will see the account ID associated with your Lytics account.

For more information, refer to this [Lytics support page](https://support.lytics.com/hc/en-us/articles/115001231351-How-do-I-find-my-Lytics-account-ID-).

## Contact us

For queries on any of the sections covered in this guide, you can [contact us](mailto:%20docs@rudderstack.com) or start a conversation in our [Slack](https://rudderstack.com/join-rudderstack-slack-community) community.
