> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Segment

> Twilio Segment is a customer data platform that helps businesses collect, clean, and control their customer data

Twilio Segment is a customer data platform that helps businesses collect, clean, and control their customer data.

`segment` · **17 tools** · no triggers

## Connect it

```bash theme={"theme":"github-dark"}
run auth segment
run auth segment --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run segment          # common commands
run segment --all    # every command
```

```ts theme={"theme":"github-dark"}
import { segment } from "@boxd/run";
```

## Common tools

| Tool                     | What it does                                                                                                                  |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
| `alias`                  | Tool to alias a previous user ID to a new user ID. Use when merging anonymous and known identities.                           |
| `batch`                  | Tool to send multiple analytics calls in a single batch request.                                                              |
| `delete-source`          | Tool to delete a Segment Source. Use when you need to permanently remove a Source by its ID after confirmation.               |
| `group`                  | Tool to associate an identified user with a group via Segment HTTP Tracking API.                                              |
| `identify`               | Tool to identify a user and set/update traits via Segment HTTP Tracking API.                                                  |
| `import-historical-data` | Tool to import historical data in bulk with support for historical timestamps.                                                |
| `page`                   | Tool to record a page view via Segment HTTP Tracking API. Use when sending page views with optional page name and properties. |
| `screen`                 | Tool to record a mobile app screen view. Use when tracking screen views in a mobile app via Segment HTTP Tracking API.        |
| `track`                  | Tool to record a custom user event via Segment HTTP Tracking API.                                                             |
| `update-source`          | Tool to update a Source's metadata and settings. Use when you need to modify an existing Source after confirming its ID.      |

<Accordion title="All 17 tools" icon="list">
  | Tool                                             | What it does                                                                                                                                        |
  | ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `add-labels-to-source`                           | Tool to add existing labels to a Source. Use when you have the source ID and want to tag it with metadata labels.                                   |
  | `alias`                                          | Tool to alias a previous user ID to a new user ID. Use when merging anonymous and known identities.                                                 |
  | `batch`                                          | Tool to send multiple analytics calls in a single batch request.                                                                                    |
  | `delete-source`                                  | Tool to delete a Segment Source. Use when you need to permanently remove a Source by its ID after confirmation.                                     |
  | `get-daily-per-source-api-calls-usage`           | Tool to fetch daily API call counts per source for a given period.                                                                                  |
  | `get-destination`                                | Tool to retrieve a Destination by ID. Use when you need to fetch the full configuration of a Segment Destination instance by its unique identifier. |
  | `group`                                          | Tool to associate an identified user with a group via Segment HTTP Tracking API.                                                                    |
  | `identify`                                       | Tool to identify a user and set/update traits via Segment HTTP Tracking API.                                                                        |
  | `import-historical-data`                         | Tool to import historical data in bulk with support for historical timestamps.                                                                      |
  | `list-connected-warehouses-from-source`          | Tool to list warehouses connected to a Source. Use when you need to retrieve warehouses for a given source ID.                                      |
  | `list-delivery-metrics-summary-from-destination` | Get an event delivery metrics summary from a Destination. Primary attempt uses Segment Public API; fallback to legacy app host if needed.           |
  | `list-schema-settings-in-source`                 | Retrieve schema configuration settings for a Source.                                                                                                |
  | `page`                                           | Tool to record a page view via Segment HTTP Tracking API. Use when sending page views with optional page name and properties.                       |
  | `remove-source-write-key`                        | Tool to remove a write key from a Source. Use when you need to revoke an existing write key for security or rotation.                               |
  | `screen`                                         | Tool to record a mobile app screen view. Use when tracking screen views in a mobile app via Segment HTTP Tracking API.                              |
  | `track`                                          | Tool to record a custom user event via Segment HTTP Tracking API.                                                                                   |
  | `update-source`                                  | Tool to update a Source's metadata and settings. Use when you need to modify an existing Source after confirming its ID.                            |
</Accordion>

[Open Segment in the console →](https://app.boxd.sh/integrations/detail/segment)
