> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# AimTell

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

![AimTell logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/aimtell.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=7b254c042e269884534e3beecd8b6fdd)

* **Category:** notifications
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 15
* **Triggers:** 0
* **Slug:** `AIMTELL`
* **Version:** 20261101\_00

## Tools

> [accordion] 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
>
> **body** `string`
>
> Notification body text for the draft.
>
> **link** `string`
>
> Destination URL opened when the notification is clicked.
>
> **name** `string` *required*
>
> Internal campaign name.
>
> **title** `string`
>
> Notification title for the draft.
>
> **site\_id** `integer` *required*
>
> AimTell website ID that will own the draft.
>
> **icon\_url** `string`
>
> HTTPS URL of a custom notification icon.
>
> **push\_ttl** `integer`
>
> Seconds before an undelivered notification expires.
>
> **image\_url** `string`
>
> HTTPS URL of a custom notification image.
>
> **segment\_ids** `array`
>
> Audience segment IDs to target.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Segment
>
> **Slug:** `AIMTELL_CREATE_SEGMENT`
>
> Create a named audience segment for a website from an AimTell segment definition.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable segment name.
>
> **site\_id** `integer` *required*
>
> AimTell website ID that will own the segment.
>
> **definition** `string` *required*
>
> AimTell segment definition expression; obtain the expected syntax from an existing segment or AimTell documentation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **campaign\_id** `integer` *required*
>
> Manual campaign ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **segment\_id** `integer` *required*
>
> Segment ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **metric** `string ("new_subscribers" | "unsubscribes" | "notifications" | "notification_clicks" | "opt_in" | "inactive" | "revenue")` *required*
>
> Daily AimTell metric to retrieve.
>
> **site\_id** `integer`
>
> Website ID for a site-specific report; omit to aggregate all websites.
>
> **end\_date** `string` *required*
>
> Last date to include, in YYYY-MM-DD format.
>
> **start\_date** `string` *required*
>
> First date to include, in YYYY-MM-DD format.
>
> **breakdown\_by\_site** `boolean`
>
> For an all-websites report, include per-site values when AimTell provides them.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **end\_date** `string` *required*
>
> Last date to include in YYYY-MM-DD format.
>
> **start\_date** `string` *required*
>
> First date to include in YYYY-MM-DD format.
>
> **campaign\_id** `integer` *required*
>
> Campaign ID whose daily results to retrieve.
>
> **campaign\_type** `string ("manual" | "event_triggered" | "rss" | "welcome")` *required*
>
> Campaign family: manual, event\_triggered, rss, or welcome.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `AIMTELL_LIST_CAMPAIGNS`
>
> Return one page of manual, event-triggered, RSS, or API push campaigns for an AimTell website.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum campaigns to request in this page; AimTell documents no upper bound.
>
> **site\_id** `integer` *required*
>
> AimTell website ID whose campaigns to return.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **campaign\_type** `string ("manual" | "event_triggered" | "rss" | "api_push")` *required*
>
> Campaign family to list: manual, event\_triggered, rss, or api\_push.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum log records to request in this page; AimTell documents no upper bound.
>
> **site\_id** `integer` *required*
>
> AimTell website ID whose sampled notification logs to return.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **subscriber\_id** `string`
>
> Optional subscriber UID used to filter the sampled notification logs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **site\_id** `integer` *required*
>
> AimTell website ID from AIMTELL\_LIST\_WEBSITES.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum subscribers to request in this page.
>
> **include** `array`
>
> Additional subscriber data to include: attributes, notifications, or both.
>
> **site\_id** `integer` *required*
>
> AimTell website ID from AIMTELL\_LIST\_WEBSITES.
>
> **segment\_id** `integer`
>
> Return only subscribers belonging to this AimTell segment.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor from a previous call; omit for the first page.
>
> **subscriber\_id** `string`
>
> Return only the subscriber with this AimTell subscriber UID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum websites to return in this page; AimTell documents no upper bound.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a previous call; omit for the first page.
>
> **include\_subscriber\_count** `boolean`
>
> Whether to request additional website data such as subscriber\_count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Push Notification
>
> **Slug:** `AIMTELL_SEND_PUSH_NOTIFICATION`
>
> Submit a one-off push notification to exactly one explicitly selected audience: subscriber IDs, one segment, one alias, or the website's full reachable audience. A successful response means AimTell queued the request, not that it was delivered.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Notification body shown to recipients.
>
> **link** `string` *required*
>
> Destination URL opened when a recipient clicks the notification.
>
> **title** `string` *required*
>
> Notification title shown to recipients.
>
> **site\_id** `integer` *required*
>
> AimTell website ID that sends the notification.
>
> **icon\_url** `string`
>
> HTTPS URL of a custom notification icon.
>
> **push\_ttl** `integer`
>
> Seconds before an undelivered notification expires.
>
> **image\_url** `string`
>
> HTTPS URL of a custom notification image.
>
> **segment\_id** `integer`
>
> Audience segment to receive the push. Do not combine with another target mode.
>
> **send\_to\_all** `boolean`
>
> 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`
>
> Key used to replace an existing visible notification on a device.
>
> **action\_buttons** `array`
>
> Up to two notification action buttons. Each button requires non-empty title and link values.
>
> **subscriber\_ids** `array`
>
> Explicit AimTell subscriber UIDs to receive the push. Do not combine with another target mode.
>
> **subscriber\_alias** `string`
>
> One subscriber alias, such as a username, user ID, or email. Do not combine with another target mode.
>
> **auto\_hide\_seconds** `integer`
>
> Seconds before the notification hides automatically, from 0 (persistent) through 255.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **site\_id** `integer` *required*
>
> AimTell website ID that owns the subscriber.
>
> **attributes** `object` *required*
>
> Custom attribute names and JSON-compatible values to set on the subscriber.
>
> **user\_alias** `string`
>
> User alias used to identify or associate the subscriber.
>
> **email\_alias** `string`
>
> Email alias used to identify or associate the subscriber.
>
> **subscriber\_id** `string`
>
> AimTell subscriber UID; provide at least one subscriber identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **body** `string`
>
> New notification body text.
>
> **link** `string`
>
> New destination URL.
>
> **name** `string`
>
> New internal campaign name.
>
> **title** `string`
>
> New notification title.
>
> **icon\_url** `string`
>
> New HTTPS custom icon URL.
>
> **push\_ttl** `integer`
>
> New expiration time in seconds.
>
> **image\_url** `string`
>
> New HTTPS custom image URL.
>
> **campaign\_id** `integer` *required*
>
> Manual campaign ID from AIMTELL\_LIST\_CAMPAIGNS or AIMTELL\_CREATE\_MANUAL\_CAMPAIGN.
>
> **segment\_ids** `array`
>
> Replacement audience segment IDs. Pass an empty list to clear targeting segments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Segment
>
> **Slug:** `AIMTELL_UPDATE_SEGMENT`
>
> Change the name or audience definition of an existing AimTell segment.
>
> #### Input Parameters
>
> **name** `string`
>
> New human-readable segment name.
>
> **definition** `string`
>
> New AimTell segment definition expression.
>
> **segment\_id** `integer` *required*
>
> Segment ID from AIMTELL\_LIST\_SEGMENTS or AIMTELL\_CREATE\_SEGMENT.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
