# Segment

* [Setup](/redux-beacon/index/segment.md#setup)
* [Usage](/redux-beacon/index/segment.md#usage)
* [Event Definitions](/redux-beacon/index/segment.md#event-definitions)

## Setup

1. [Sign up](https://segment.com/signup) for Segment.io and create a Segment.io project for your web application.
2. Add the [JavaScript Tracking Snippet](https://segment.com/docs/sources/website/analytics.js/quickstart/) to your site.

   During development and testing it is often helpful to use the debug version of analytics.js. Follow the instructions [here](https://segment.com/docs/sources/website/analytics.js/#debug) to enable it.
3. Install the target:

   ```bash
    npm install --save @redux-beacon/segment
   ```

## Usage

```javascript
import Segment from '@redux-beacon/segment';

// Create or import an events map.
// See "getting started" pages for instructions.

const segment = Segment();

const segmentMiddleware = createMiddleware(eventsMap, segment);
const segmentMetaReducer = createMetaReducer(eventsMap, segment);
```

## Event Definitions

* [`pageView`](/redux-beacon/index/segment.md#pageview)
* [`event`](/redux-beacon/index/segment.md#event)
* [`alias`](/redux-beacon/index/segment.md#alias)
* [`group`](/redux-beacon/index/segment.md#group)
* [`identify`](/redux-beacon/index/segment.md#identify)

Don't see your event listed? Please submit a pull request to the [Redux Beacon repository](https://github.com/rangle/redux-beacon) with the missing event. Use the source of the existing `event-helpers` to guide your work. If you need any support feel free to make the pull request with all you're able to do. We can fill in the gaps from there.

### pageView

#### Docs:

<https://segment.com/docs/sources/website/analytics.js/#page>

```javascript
import { trackPageView } from '@redux-beacon/segment';

const pageView = trackPageView((action, prevState, nextState) => {
  return {
    category: /* (optional) */
    name: /* (optional) */
    properties: /* (optional) */
    options: /* (optional) */
  };
});
```

{% hint style="danger" %}
The last line of the tracking snippet `analytics.page();` hits Segment.io with a page view that matches the first loaded route. If you're tracking page views using Redux Beacon, be sure to remove this line so the initial page load isn't recorded twice.
{% endhint %}

### event

#### Docs:

<https://segment.com/docs/sources/website/analytics.js/#track>

```javascript
import { trackEvent } from '@redux-beacon/segment';

const event = trackEvent((action, prevState, nextState) => {
  return {
    name: /* fill me in */,
    properties: /* (optional) */,
    options: /* (optional) */,
  };
});
```

### alias

#### Docs:

<https://segment.com/docs/sources/website/analytics.js/#alias>

```javascript
import { setAlias } from '@redux-beacon/segment';

const alias = setAlias((action, prevState, nextState) => {
  return {
    userId: /* fill me in */,
    previousId: /* (optional) */,
    options: /* (optional) */,
  };
});
```

### group

#### Docs:

<https://segment.com/docs/sources/website/analytics.js/#group>

```javascript
import { setGroup } from '@redux-beacon/segment';

const group = setGroup((action, prevState, nextState) => {
  return {
    groupId: /* fill me in */,
    traits: /* (optional) */,
    options: /* (optional) */,
  };
});
```

### identify

#### Docs:

<https://segment.com/docs/sources/website/analytics.js/#identify>

```javascript
import { identifyUser } from '@redux-beacon/segment';

const user = identifyUser((action, prevState, nextState) => {
  return {
    userId: /* (optional) */,
    traits: /* (optional) */,
    options: /* (optional) */,
  };
});
```

### reset

#### Docs:

<https://segment.com/docs/sources/website/analytics.js/#reset-logout>

```javascript
import { reset } from '@redux-beacon/segment';

const resetRequest = reset();
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rangle.gitbook.io/redux-beacon/index/segment.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.