---
canonical_url: "https://docs.composio.dev/toolkits/aimtell"
markdown_url: "https://docs.composio.dev/toolkits/aimtell.md"
product: "platform"
version: null
last_updated: null
---

# AimTell

AimTell is a web push notification platform for managing websites, subscribers, campaigns, segments, and delivery analytics.

- **Category:** notifications
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `AIMTELL`
- **Version:** 00000000_00

## Tools

### Create Manual Campaign

**Slug:** `AIMTELL_CREATE_MANUAL_CAMPAIGN`

Create a manual push campaign as a draft only; this tool never schedules or sends it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | Notification body text for the draft. |
| `link` | string | No | Destination URL opened when the notification is clicked. |
| `name` | string | Yes | Internal campaign name. |
| `title` | string | No | Notification title for the draft. |
| `site_id` | integer | Yes | AimTell website ID that will own the draft. |
| `icon_url` | string | No | HTTPS URL of a custom notification icon. |
| `push_ttl` | integer | No | Seconds before an undelivered notification expires. |
| `image_url` | string | No | HTTPS URL of a custom notification image. |
| `segment_ids` | array | No | Audience segment IDs to target. |

#### 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 |

### Create Segment

**Slug:** `AIMTELL_CREATE_SEGMENT`

Create a named audience segment for a website from an AimTell segment definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable segment name. |
| `site_id` | integer | Yes | AimTell website ID that will own the segment. |
| `definition` | string | Yes | AimTell segment definition expression; obtain the expected syntax from an existing segment or AimTell documentation. |

#### 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 Manual Campaign

**Slug:** `AIMTELL_DELETE_MANUAL_CAMPAIGN`

Permanently delete one manual campaign by ID. This destructive action cannot be undone and permanently removes the campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Manual campaign ID to permanently delete. |

#### 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 Segment

**Slug:** `AIMTELL_DELETE_SEGMENT`

Permanently delete one audience segment by ID. This destructive action cannot be undone; it removes the segment but does not delete its subscribers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment_id` | integer | Yes | Segment ID to permanently delete. |

#### 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 |

### Get Analytics Over Time

**Slug:** `AIMTELL_GET_ANALYTICS_OVER_TIME`

Return a daily AimTell metric over a date range for all websites or one website.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `metric` | string ("new_subscribers" | "unsubscribes" | "notifications" | "notification_clicks" | "opt_in" | "inactive" | "revenue") | Yes | Daily AimTell metric to retrieve. |
| `site_id` | integer | No | Website ID for a site-specific report; omit to aggregate all websites. |
| `end_date` | string | Yes | Last date to include, in YYYY-MM-DD format. |
| `start_date` | string | Yes | First date to include, in YYYY-MM-DD format. |
| `breakdown_by_site` | boolean | No | For an all-websites report, include per-site values when AimTell provides them. |

#### 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 |

### Get Campaign Results

**Slug:** `AIMTELL_GET_CAMPAIGN_RESULTS`

Return daily send, delivery, bounce, click, conversion, and available revenue results for a manual, event-triggered, RSS, or welcome campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | Last date to include in YYYY-MM-DD format. |
| `start_date` | string | Yes | First date to include in YYYY-MM-DD format. |
| `campaign_id` | integer | Yes | Campaign ID whose daily results to retrieve. |
| `campaign_type` | string ("manual" | "event_triggered" | "rss" | "welcome") | Yes | Campaign family: manual, event_triggered, rss, or welcome. |

#### 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 |

### List Campaigns

**Slug:** `AIMTELL_LIST_CAMPAIGNS`

Return one page of manual, event-triggered, RSS, or API push campaigns for an AimTell website.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum campaigns to request in this page; AimTell documents no upper bound. |
| `site_id` | integer | Yes | AimTell website ID whose campaigns to return. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `campaign_type` | string ("manual" | "event_triggered" | "rss" | "api_push") | Yes | Campaign family to list: manual, event_triggered, rss, or api_push. |

#### 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 |

### List Notification Logs

**Slug:** `AIMTELL_LIST_NOTIFICATION_LOGS`

Return one page from AimTell's sampled notification log for the last seven days, optionally filtered to one subscriber. This is not a complete delivery ledger and does not include every notification sent to every subscriber.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum log records to request in this page; AimTell documents no upper bound. |
| `site_id` | integer | Yes | AimTell website ID whose sampled notification logs to return. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `subscriber_id` | string | No | Optional subscriber UID used to filter the sampled notification logs. |

#### 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 |

### List Segments

**Slug:** `AIMTELL_LIST_SEGMENTS`

Return all audience segments for an AimTell website, including the IDs and definitions used for subscriber filtering and campaign targeting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | integer | Yes | AimTell website ID from AIMTELL_LIST_WEBSITES. |

#### 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 |

### List Subscribers

**Slug:** `AIMTELL_LIST_SUBSCRIBERS`

Return one page of subscribers for an AimTell website, optionally filtered by segment or subscriber ID and optionally including attributes or notification history. AimTell may return processing=true with no subscriber page while it prepares the data; retry the same request in that case.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum subscribers to request in this page. |
| `include` | array | No | Additional subscriber data to include: attributes, notifications, or both. |
| `site_id` | integer | Yes | AimTell website ID from AIMTELL_LIST_WEBSITES. |
| `segment_id` | integer | No | Return only subscribers belonging to this AimTell segment. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |
| `subscriber_id` | string | No | Return only the subscriber with this AimTell subscriber UID. |

#### 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 |

### List Websites

**Slug:** `AIMTELL_LIST_WEBSITES`

Return one page of websites available to the connected AimTell account, including site IDs needed by other tools. Use next_cursor to retrieve later pages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum websites to return in this page; AimTell documents no upper bound. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `include_subscriber_count` | boolean | No | Whether to request additional website data such as subscriber_count. |

#### 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 |

### Send Push Notification

**Slug:** `AIMTELL_SEND_PUSH_NOTIFICATION`

Immediately send a one-off push notification to exactly one explicitly selected audience: subscriber IDs, one segment, one alias, or the website's full reachable audience. Delivery begins immediately, cannot be undone, and has no dry-run mode.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Notification body shown to recipients. |
| `link` | string | Yes | Destination URL opened when a recipient clicks the notification. |
| `title` | string | Yes | Notification title shown to recipients. |
| `site_id` | integer | Yes | AimTell website ID that sends the notification. |
| `icon_url` | string | No | HTTPS URL of a custom notification icon. |
| `push_ttl` | integer | No | Seconds before an undelivered notification expires. |
| `image_url` | string | No | HTTPS URL of a custom notification image. |
| `segment_id` | integer | No | Audience segment to receive the push. Do not combine with another target mode. |
| `send_to_all` | boolean | No | Set true to explicitly confirm immediate delivery to the website's full reachable audience. This is not sent to AimTell and cannot be combined with another target mode. |
| `collapse_key` | string | No | Key used to replace an existing visible notification on a device. |
| `action_buttons` | array | No | Up to two notification action buttons. Each button requires non-empty title and link values. |
| `subscriber_ids` | array | No | Explicit AimTell subscriber UIDs to receive the push. Do not combine with another target mode. |
| `subscriber_alias` | string | No | One subscriber alias, such as a username, user ID, or email. Do not combine with another target mode. |
| `auto_hide_seconds` | integer | No | Seconds before the notification hides automatically, from 0 (persistent) through 255. |

#### 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 |

### Set Subscriber Attributes

**Slug:** `AIMTELL_SET_SUBSCRIBER_ATTRIBUTES`

Set custom attributes on one subscriber identified by subscriber UID, user alias, or email alias; supplied aliases may also be associated with the subscriber.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `site_id` | integer | Yes | AimTell website ID that owns the subscriber. |
| `attributes` | object | Yes | Custom attribute names and JSON-compatible values to set on the subscriber. |
| `user_alias` | string | No | User alias used to identify or associate the subscriber. |
| `email_alias` | string | No | Email alias used to identify or associate the subscriber. |
| `subscriber_id` | string | No | AimTell subscriber UID; provide at least one subscriber identifier. |

#### 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 |

### Update Manual Campaign

**Slug:** `AIMTELL_UPDATE_MANUAL_CAMPAIGN`

Update the content or targeting of an unscheduled, unsent, non-A/B manual campaign draft without scheduling or sending it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | New notification body text. |
| `link` | string | No | New destination URL. |
| `name` | string | No | New internal campaign name. |
| `title` | string | No | New notification title. |
| `icon_url` | string | No | New HTTPS custom icon URL. |
| `push_ttl` | integer | No | New expiration time in seconds. |
| `image_url` | string | No | New HTTPS custom image URL. |
| `campaign_id` | integer | Yes | Manual campaign ID from AIMTELL_LIST_CAMPAIGNS or AIMTELL_CREATE_MANUAL_CAMPAIGN. |
| `segment_ids` | array | No | Replacement audience segment IDs. Pass an empty list to clear targeting segments. |

#### 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 |

### Update Segment

**Slug:** `AIMTELL_UPDATE_SEGMENT`

Change the name or audience definition of an existing AimTell segment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New human-readable segment name. |
| `definition` | string | No | New AimTell segment definition expression. |
| `segment_id` | integer | Yes | Segment ID from AIMTELL_LIST_SEGMENTS or AIMTELL_CREATE_SEGMENT. |

#### 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 |