# Segmetrics

SegMetrics is a marketing analytics platform that provides detailed insights into customer journeys, helping businesses optimize their marketing strategies.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 3
- **Triggers:** 0
- **Slug:** `SEGMETRICS`
- **Version:** 20260211_00

## Tools

### Create Product

**Slug:** `SEGMETRICS_CREATE_PRODUCT`

Tool to create a new product in SegMetrics. Use after confirming product details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier for the product. |
| `name` | string | Yes | Name of the product. |
| `type` | string ("digital" | "physical") | No | Type of product. Must be 'digital' or 'physical'. |
| `price` | number | No | Default price of the product, must be non-negative. |
| `account_id` | string | Yes | SegMetrics account ID (Site ID). Found in your SegMetrics Account settings. Format: 6+ characters starting with 'a'. |
| `description` | string | No | Description of the product. |
| `external_id` | string | No | External system reference ID for the product. |
| `integration_id` | string | Yes | Integration ID to which this product belongs. Found in SegMetrics integration settings or in the URL when configuring an integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `SEGMETRICS_DELETE_CONTACT`

Tool to permanently delete a specific contact by ID or email from SegMetrics. Use after confirming the contact exists. This action is irreversible. Note: Associated invoices and purchases remain in the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | SegMetrics account ID (Site ID). Found in your SegMetrics Account settings. Format: 6+ characters starting with 'a'. |
| `integration_id` | string | Yes | Integration ID to which this contact belongs. Found in SegMetrics integration settings or in the URL when configuring an integration. |
| `contact_id_or_email` | string | Yes | The unique identifier (contact_id) or email address of the contact to delete. Using an email will delete all contacts with that email in the integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add or Update Contact

**Slug:** `SEGMETRICS_V1_ADD_OR_UPDATE_CONTACT`

Tool to add or update a contact in SegMetrics. Use when you need to upsert the contact record during data import.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Contact's email address. |
| `status` | string ("active" | "inactive") | No | Contact status, either 'active' or 'inactive'. |
| `utm_term` | string | No | UTM term parameter. |
| `last_name` | string | No | Contact's last name. |
| `account_id` | string | Yes | SegMetrics account ID (Site ID). Found in your SegMetrics Account settings. Format: 6+ characters starting with 'a'. |
| `contact_id` | string | No | Unique identifier for the contact (string or numeric). Optional if email is provided. |
| `first_name` | string | No | Contact's first name. |
| `utm_medium` | string | No | UTM medium parameter. |
| `utm_source` | string | No | UTM source parameter. |
| `utm_content` | string | No | UTM content parameter. |
| `date_created` | string | No | Creation timestamp (YYYY-MM-DD HH:MM:SS). |
| `last_updated` | string | No | Last-update timestamp (YYYY-MM-DD HH:MM:SS). |
| `utm_campaign` | string | No | UTM campaign parameter. |
| `integration_id` | string | Yes | Integration ID to which this contact belongs. Found in SegMetrics integration settings or in the URL when configuring an integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |