The Aimtell connector lets your AI agent act in each user's Aimtell account. Each user connects their own Aimtell API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 33 · 20 · 733 read20 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Aimtell connection
In AgentKit > Connections, create an Aimtell connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'aimtell'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Aimtell:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'aimtell_sites_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "aimtell"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Aimtell:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="aimtell_sites_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Aimtell credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolaimtell_account_analytics_getGet a metric over time across all websites in the account.Read-onlyGet Account Analytics
Get a metric over time across all websites in the account. Returns daily values for the chosen type. Dates are yyyy-mm-dd; use site_analytics_get for one site.
Inputs
end_datestringrequired- Format: yyyy-mm-dd (e.g. 2020-06-17). Example: 2026-01-31.
start_datestringrequired- Format: yyyy-mm-dd (e.g. 2020-06-01). Example: 2026-01-01.
typestringrequired- Type of analytics data to retrieve. Example: newsubscribers.one of
newsubscribersunsubscribesnotificationsnotificationclicksoptininactiverevenue breakdownboolean- Enable per site breakdown. Defaults to false. Example: false.
aimtell_api_campaign_results_getGet daily results for all API-sent pushes of a site over a date range.Read-onlyGet API Campaign Results
Get daily results for all API-sent pushes of a site over a date range. Returns daily sends, clicks and conversions. Dates are yyyy-mm-dd.
Inputs
end_datestringrequired- Date. Example: 2026-01-31.
site_idintegerrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
start_datestringrequired- Date. Example: 2026-01-01.
aimtell_api_campaigns_listList the push notifications sent through push_send for a site, newest first.Read-onlyList API Push Campaigns
List the push notifications sent through push_send for a site, newest first. Returns each campaign's id, title, body, link and send time. Use api_campaign_results_get for daily totals.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitinteger- Maximum number of results to return per page. Example: 50.
skipinteger- Number of results to skip for pagination (offset). Example: 0.
aimtell_campaign_clicks_listList the clicks on a manual campaign, per subscriber.Read-onlyList Manual Campaign Clicks
List the clicks on a manual campaign, per subscriber. Returns each click's subscriber id and timestamp. Use campaign_results_get for daily totals.
Inputs
campaign_idstringrequired- ID of the campaign. Get it from campaigns_list. Example: 98765.
aimtell_campaign_getGet one manual push campaign.Read-onlyGet Manual Campaign
Get one manual push campaign. Returns its name, title, body, link, status, schedule, segments, automation and A/B version. Use campaigns_list to find campaign IDs.
Inputs
campaign_idstringrequired- ID of the campaign. Get it from campaigns_list. Example: 98765.
loadstring- Load Additional Information (i.e. Segments). Example: segments.
aimtell_campaign_results_getGet a manual campaign's results per day over a date range.Read-onlyGet Manual Campaign Results
Get a manual campaign's results per day over a date range. Returns daily sends, deliveries, clicks, conversions and revenue. Dates are yyyy-mm-dd.
Inputs
campaign_idstringrequired- ID of the campaign. Get it from campaigns_list. Example: 98765.
end_datestringrequired- Date. Example: 2026-01-31.
start_datestringrequired- Date. Example: 2026-01-01.
include_sharedinteger- Set to 1 to roll the results of every shared copy of this campaign into a single set of totals. Omit to return results for this campaign's site only. Defaults to 0. Example: 0.
aimtell_campaigns_listList a site's manual (one-time or scheduled) push campaigns.Read-onlyList Manual Campaigns
List a site's manual (one-time or scheduled) push campaigns. Returns each campaign's id, name, title, body, link, status, schedule and segments. Use campaign_get for one campaign.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitinteger- Maximum number of results to return per page. Example: 50.
skipinteger- Number of results to skip for pagination (offset). Example: 0.
aimtell_event_campaign_getGet one event-triggered campaign.Read-onlyGet Event Triggered Campaign
Get one event-triggered campaign. Returns its name, trigger event (category, action, label), content, drip delays and status. Use event_campaigns_list to find campaign IDs.
Inputs
event_campaign_idstringrequired- ID of the event campaign. Get it from event_campaigns_list. Example: 98765.
aimtell_event_campaign_results_getGet an event-triggered campaign's results per day over a date range.Read-onlyGet Event Campaign Results
Get an event-triggered campaign's results per day over a date range. Returns daily sends, clicks, conversions and revenue. Dates are yyyy-mm-dd.
Inputs
end_datestringrequired- Date. Example: 2026-01-31.
event_campaign_idstringrequired- ID of the event campaign. Get it from event_campaigns_list. Example: 98765.
start_datestringrequired- Date. Example: 2026-01-01.
include_sharedinteger- Set to 1 to roll the results of every shared copy of this campaign into a single set of totals. Omit to return results for this campaign's site only. Defaults to 0. Example: 0.
aimtell_event_campaigns_listList a site's event-triggered push campaigns.Read-onlyList Event Triggered Campaigns
List a site's event-triggered push campaigns. Returns each campaign's id, name, trigger event, content and status. Use event_campaign_get for one campaign.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitstring- Maximum number of results to return per page. Example: 50.
skipstring- Number of results to skip for pagination (offset). Example: 0.
aimtell_event_logs_listList recent custom events tracked for a website's subscribers.Read-onlyList Event Logs
List recent custom events tracked for a website's subscribers. Returns each event's subscriber, category, action, label, value and time. Events trigger event campaigns.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitinteger- Maximum number of results to return per page. Example: 50.
skipinteger- Number of results to skip for pagination (offset). Example: 0.
aimtell_notification_logs_listList recent notification delivery logs for a website, optionally for one subscriber.Read-onlyList Notification Logs
List recent notification delivery logs for a website, optionally for one subscriber. Returns each log's subscriber, campaign, status and time. This is a recent sample, not a full history.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitinteger- Maximum number of results to return per page. Example: 50.
skipinteger- Number of results to skip for pagination (offset). Paging past the retained notifications returns an empty result. Example: 0.
subscriber_uidstring- Optionally filter by a specific subscriber. This returns a short recent history for that subscriber, and some fields are not available on these results. Example: a1b2c3d4e5.
aimtell_pageview_logs_listList recent pageviews tracked for a website's subscribers.Read-onlyList Pageview Logs
List recent pageviews tracked for a website's subscribers. Returns each pageview's subscriber, URL and time. Use it to see subscriber browsing activity.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitinteger- Maximum number of results to return per page. Example: 50.
skipinteger- Number of results to skip for pagination (offset). Example: 0.
aimtell_pixels_listList a website's cross-domain tracking pixels.Read-onlyList Tracking Pixels
List a website's cross-domain tracking pixels. Returns each pixel's id, name, event and pixel URL. Use pixel_create to add one.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_prompt_getGet one opt-in prompt.Read-onlyGet Opt-in Prompt
Get one opt-in prompt. Returns its name, type, texts and colors. Use prompts_list to find prompt IDs.
Inputs
prompt_idstringrequired- ID of the prompt. Get it from prompts_list. Example: 98765.
aimtell_prompts_listList a website's opt-in prompts.Read-onlyList Opt-in Prompts
List a website's opt-in prompts. Returns each prompt's id, name, type, texts and colors. Use prompt_get for one prompt.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_rss_campaign_getGet one RSS campaign.Read-onlyGet RSS Campaign
Get one RSS campaign. Returns its name, feed, content template, segments, frequency and status. Use rss_campaigns_list to find campaign IDs.
Inputs
rss_campaign_idstringrequired- ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.
aimtell_rss_campaign_results_getGet an RSS campaign's results per day over a date range.Read-onlyGet RSS Campaign Results
Get an RSS campaign's results per day over a date range. Returns daily sends, clicks and conversions. Dates are yyyy-mm-dd.
Inputs
end_datestringrequired- Date. Example: 2026-01-31.
rss_campaign_idstringrequired- ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.
start_datestringrequired- Date. Example: 2026-01-01.
aimtell_rss_campaigns_listList a site's RSS-driven push campaigns.Read-onlyList RSS Campaigns
List a site's RSS-driven push campaigns. Returns each campaign's id, name, feed, content template and status. Use rss_campaign_get for one campaign.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
limitstring- Maximum number of results to return per page. Example: 50.
skipstring- Number of results to skip for pagination (offset). Example: 0.
aimtell_segment_counts_getGet how many subscribers matched a segment over a date range.Read-onlyGet Segment Counts Over Time
Get how many subscribers matched a segment over a date range. Returns daily subscriber counts. Dates are yyyy-mm-dd.
Inputs
end_datestringrequired- Date as yyyy-mm-dd (i.e. 2019-12-14). Example: 2026-01-31.
segment_idstringrequired- ID of the segment. Get it from segments_list. Example: 98765.
start_datestringrequired- Date as yyyy-mm-dd (i.e. 2019-12-07). Example: 2026-01-01.
aimtell_segment_getGet one segment.Read-onlyGet Segment
Get one segment. Returns its id, name, definition and site. Use segments_list to find segment IDs.
Inputs
segment_idstringrequired- ID of the segment. Get it from segments_list. Example: 98765.
aimtell_segments_listList a website's subscriber segments.Read-onlyList Segments
List a website's subscriber segments. Returns each segment's id, name and definition. Use segment IDs to target campaigns and push_send.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_site_analytics_getGet a metric over time for one website, such as new subscribers or notification clicks.Read-onlyGet Website Analytics
Get a metric over time for one website, such as new subscribers or notification clicks. Returns daily values for the chosen type. Dates are yyyy-mm-dd; use account_analytics_get for all sites.
Inputs
end_datestringrequired- Format: yyyy-mm-dd (e.g. 2020-06-16). Example: 2026-01-31.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
start_datestringrequired- Format: yyyy-mm-dd (e.g. 2020-06-01). Example: 2026-01-01.
typestringrequired- Type of analytics data to retrieve. Example: newsubscribers.one of
newsubscribersunsubscribesnotificationsnotificationclicksoptininactiverevenue
aimtell_site_code_getGet the Aimtell push and tracking code to install on a website.Read-onlyGet Website Tracking Code
Get the Aimtell push and tracking code to install on a website. Returns the JavaScript snippet. Use it after site_create.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_site_getGet one website.Read-onlyGet Website
Get one website. Returns its id, name, URL, icon and settings summary. Use sites_list to find site IDs.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_site_permissions_listList the users who have access to a website.Read-onlyList Website Users
List the users who have access to a website. Returns each user's uid, name and email. Use site_permission_grant to add a user.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_site_settings_getGet a website's tracking settings.Read-onlyGet Website Settings
Get a website's tracking settings. Returns IP collection, attribute and event tracking flags, data retention days and daily frequency cap. Use site_settings_update to change them.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_site_variables_listList a website's custom variables, used as placeholders in notification content.Read-onlyList Website Custom Variables
List a website's custom variables, used as placeholders in notification content. Returns each variable's name and value. Use site_variable_upsert to add or change one.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_sites_listList the active websites (sites) in the Aimtell account.Read-onlyList Websites
List the active websites (sites) in the Aimtell account. Returns each site's id, name, URL, icon and creation date. Use the site id with every site-scoped tool.
Inputs
limitstring- Maximum number of results to return per page. Example: 50.
loadstring- Load Additional Information (i.e. subscriber_count). Example: segments.
skipstring- Number of results to skip for pagination (offset). Example: 0.
aimtell_subscribers_listList a website's subscribers, optionally filtered by segment or one subscriber ID, with paging.Read-onlyList Subscribers
List a website's subscribers, optionally filtered by segment or one subscriber ID, with paging. Returns each subscriber's uid, browser, device, location, subscription date and (with include) attributes and notifications. Use subscriber_attributes_track to set attributes.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
includestring- Accepts attributes, notifications, or both as a comma-separated list (e.g. attributes,notifications). Note: the read field on notifications does not indicate impressions or delivery. It is used within the Notification Center (coming soon). Example: attributes,notifications.
limitinteger- Maximum number of results to return per page. Example: 50.
segment_idinteger- The ID of the segment you wish to filter by. Example: 12346.
skipinteger- Number of results to skip for pagination (offset). Example: 0.
subscriber_idstring- The specific subscriber ID to pull data for. Example: a1b2c3d4e5.
aimtell_user_getGet the Aimtell user that owns the API key.Read-onlyGet Account User
Get the Aimtell user that owns the API key. Returns the user's id, name, email, timezone and account details. Use it to confirm which account the connection uses.
Inputs
This tool takes no inputs.
aimtell_welcome_campaign_getGet a site's welcome notification, sent to each new subscriber.Read-onlyGet Welcome Campaign
Get a site's welcome notification, sent to each new subscriber. Returns its title, body, link, icon, image and status. Use welcome_campaign_upsert to change it.
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_welcome_campaign_results_getGet a site's welcome notification results per day over a date range.Read-onlyGet Welcome Campaign Results
Get a site's welcome notification results per day over a date range. Returns daily sends, clicks and conversions. Dates are yyyy-mm-dd.
Inputs
end_datestringrequired- Date. Example: 2026-01-31.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
start_datestringrequired- Date. Example: 2026-01-01.
aimtell_campaign_createCreate a manual push campaign for a site, as a draft (status 1) or scheduled (status 2) with schedule_date.WriteCreate Manual Campaign
Create a manual push campaign for a site, as a draft (status 1) or scheduled (status 2) with schedule_date. Returns the result and the new campaign id. Target segments by ID; get them from segments_list.
Inputs
namestringrequired- Campaign Name. Example: Spring sale.
site_idstringrequired- Site ID. Example: 12345.
actionsobject- action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
auto_hideinteger- Auto Hide (in seconds). Example: 1.
automationstring- Automation (d = daily, w = weekly, m = monthly, n = none). Example: n.one of
dwmn bodystring- Push Body. Example: Take 20% off everything until midnight.
collapse_keystring- replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
conversion_triggerobject- Conversion Trigger. Example: {"event_category": "purchase", "event_action": "checkout"}
custom_iconstring- url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
custom_imagestring- url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
linkstring- Link. Example: https://shop.example.com/sale.
push_ttlinteger- expiration time (in seconds). Example: 86400.
schedule_datestring- DateTime (e.g. 2017-08-25 21:16:50). Example: 2026-03-01 09:00:00.
segmentsstring- Segments. Example: 12345,12346.
statusstring- 1 = draft, 2 = scheduled. Defaults to 1. Example: 1.one of
12 titlestring- Push Title. Example: Flash sale ends tonight.
tz_deliveryinteger- deliver based on user's timezone (set 0 for false, 1 for true). Example: 1.
aimtell_campaign_updateUpdate a manual push campaign's content, schedule, segments or status.WriteUpdate Manual Campaign
Update a manual push campaign's content, schedule, segments or status. Returns the result. For A/B campaigns also pass version_b with its status.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign. Get it from campaigns_list. Example: 98765.
actionsobject- action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
auto_hideinteger- Auto Hide (in seconds). Example: 1.
automationstring- Automation (d = daily, w = weekly, m = monthly, n = none). Example: n.one of
dwmn automation_endstring- Automation End Date (e.g. 2017-08-25 17:00:00). Example: 2026-06-01 00:00:00.
bodystring- Push Body. Example: Take 20% off everything until midnight.
collapse_keystring- replace visible notifications on a subscribers device replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
conversion_triggerobject- Conversion Trigger. Example: {"event_category": "purchase", "event_action": "checkout"}
custom_iconstring- url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
custom_imagestring- url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
linkstring- Push Link. Example: https://shop.example.com/sale.
namestring- Name of Campaign. Example: Spring sale.
push_ttlinteger- Expiration Time (in seconds). Example: 86400.
schedule_datestring- DateTime (i.e. 2017-08-25 21:16:50). Example: 2026-03-01 09:00:00.
segmentsstring- Segments. Example: 12345,12346.
statusinteger- set 1 for draft, 2 for scheduled. Defaults to 1. Example: 1.one of
12 titlestring- Push Title. Example: Flash sale ends tonight.
tz_deliveryinteger- deliver based on user's timezone (set 0 for false, 1 for true). Example: 1.
version_bobject- (optional) Version B for A/B test campaign. Example: {"title": "Last chance: 20% off", "body": "Sale ends at midnight.", "status": 1}
aimtell_event_campaign_createCreate an event-triggered campaign shell with a name.WriteCreate Event Triggered Campaign
Create an event-triggered campaign shell with a name. Returns the result and the new campaign id. Then set its trigger event, content and drip delays with event_campaign_update.
Inputs
namestringrequired- Campaign Name. Example: Spring sale.
site_idstringrequired- Site ID. Example: 12345.
aimtell_event_campaign_updateUpdate an event-triggered campaign's trigger event, content, drip delays or target device.WriteUpdate Event Triggered Campaign
Update an event-triggered campaign's trigger event, content, drip delays or target device. Returns the result. The campaign fires when a subscriber records the matching event.
- Idempotent
Inputs
event_campaign_idstringrequired- ID of the event campaign. Get it from event_campaigns_list. Example: 98765.
actionsobject- action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
bodystring- Push Body Message. Example: Take 20% off everything until midnight.
collapse_keystring- replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
custom_iconstring- url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
custom_imagestring- url of custom image to use (recommended size: 300x500)). Example: https://cdn.example.com/banner-300x500.png.
delayinteger- Time in seconds after event when push should be sent. Example: 3600.
dripstring- Comma separated integer values representing delays as seconds from event. Example: 60, 300, 3600.
event_actionstring- Event Action. Example: checkout.
event_categorystring- Event Category. Example: purchase.
event_labelstring- Event Label. Example: cart-abandoned.
linkstring- Push Notification Link. Example: https://shop.example.com/sale.
namestring- Name of Campaign. Example: Spring sale.
statusinteger- set 1 for draft, 5 for active. Example: 1.
target_devicestring- device type to target (optional). can be either: "any", "mobile" or "desktop". Example: any.one of
anymobiledesktop titlestring- Push Title. Example: Flash sale ends tonight.
aimtell_pixel_createCreate a cross-domain tracking pixel that records an event when loaded, for example on a checkout page.WriteCreate Tracking Pixel
Create a cross-domain tracking pixel that records an event when loaded, for example on a checkout page. Returns the result and the pixel id. Place the pixel on the other domain's page.
Inputs
namestringrequired- Name of the pixel. Example: Spring sale.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_pixel_updateUpdate a tracking pixel's name and the event it records.WriteUpdate Tracking Pixel
Update a tracking pixel's name and the event it records. Returns the result. Pass both name and value.
Inputs
namestringrequired- Name of the pixel. Example: Spring sale.
pixel_idstringrequired- ID of the pixel. Get it from pixels_list. Example: 98765.
valueobjectrequired- Value. Example: {"event_category": "purchase", "event_action": "checkout", "event_label": "pro-plan", "event_value": 49}
aimtell_prompt_createCreate an opt-in prompt for a website (type 1 is a top-left drop-down, 3 a centered box).WriteCreate Opt-in Prompt
Create an opt-in prompt for a website (type 1 is a top-left drop-down, 3 a centered box). Returns the result and the prompt id. Customize its texts and colors with prompt_update.
Inputs
site_idstringrequired- Website ID. Example: 12345.
namestring- Prompt Name. Example: Spring sale.
typeinteger- top left drop down prompt = 1 , middle rectangle prompt = 3. Example: 1.one of
13
aimtell_prompt_updateUpdate an opt-in prompt's header, body and button texts and colors.WriteUpdate Opt-in Prompt
Update an opt-in prompt's header, body and button texts and colors. Returns the result. Colors are hex values like #4e99cf.
- Idempotent
Inputs
prompt_idstringrequired- ID of the prompt. Get it from prompts_list. Example: 98765.
approve_button_colorstring- Prompt Approve Button Color (hexadecimal color e.g. #4e99cf). Example: #4e99cf.
approve_button_textstring- Prompt Approve Button Text. Example: Allow.
approve_button_text_colorstring- Prompt Approve Button Text Color (hexadecimal color e.g. #ffffff). Example: #ffffff.
body_textstring- Prompt Body Text. Example: We'll only send the good stuff.
body_text_colorstring- Prompt Body Text Color (hexadecimal color e.g. #000000). Example: #333333.
cancel_button_colorstring- Prompt Cancel Button Color (hexadecimal color e.g. #4e99cf). Example: #999999.
cancel_button_textstring- Prompt Cancel Button Text. Example: No thanks.
cancel_button_text_colorstring- Prompt Cancel Button Text Color (hexadecimal color e.g. #ffffff). Example: #ffffff.
header_textstring- Prompt Header Text. Example: Get deal alerts.
header_text_colorstring- Prompt Header Text Color (hexadecimal color e.g. #000000). Example: #000000.
icon_urlstring- Prompt Icon URL. Example: https://www.example.com/logo.png.
namestring- Prompt Name. Example: Spring sale.
aimtell_push_sendSend a one-off push notification right away to specific subscribers, a segment, or an alias (user==...WriteSend Push Notification
Send a one-off push notification right away to specific subscribers, a segment, or an alias (user==... or email==...). Returns the result and the push campaign id. Target with exactly one of subscriber_uids, segment_id or alias. Use campaign_create for scheduled or recurring sends.
Inputs
bodystringrequired- Notification Body. Example: Take 20% off everything until midnight.
linkstringrequired- Notification Link. Example: https://shop.example.com/sale.
site_idintegerrequired- Site ID. Example: 12345.
titlestringrequired- Notification Title. Example: Flash sale ends tonight.
actionsobject- Action Buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
aliasstring- A subscriber alias in the form type==value, where type is user or email (e.g. user==jack17 or email==jack@example.com). An email value can also be its MD5 hash. A value without == is not valid. Example: email==jane@example.com.
auto_hideinteger- Number of seconds (255 max) until the notification will hide automatically. Default is 0, which is persistent (requires interaction). Example: 1.
collapse_keystring- replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
custom_iconstring- url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
custom_imagestring- url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
push_ttlinteger- Time till a push should expire in seconds. Default is 1 week. Example: 86400.
segment_idinteger- Segment ID. Example: 12346.
subscriber_uidsarray- Subscriber UIDS. Example: ["a1b2c3d4e5"]
aimtell_rss_campaign_createCreate an RSS campaign shell with a name.WriteCreate RSS Campaign
Create an RSS campaign shell with a name. Returns the result and the new campaign id. Then set its content, segments and frequency with rss_campaign_update.
Inputs
namestringrequired- Campaign Name. Example: Spring sale.
site_idstringrequired- Site ID. Example: 12345.
aimtell_rss_campaign_updateUpdate an RSS campaign's content, segments or sending frequency.WriteUpdate RSS Campaign
Update an RSS campaign's content, segments or sending frequency. Returns the result. Use max_type hourly or daily to cap sends.
- Idempotent
Inputs
rss_campaign_idstringrequired- ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.
statusintegerrequired- set 1 for draft, 2 for active. Example: 1.
actionsobject- Actions. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
bodystring- Push Body Message. Example: Take 20% off everything until midnight.
collapse_keystring- replace visible notifications on a subscribers device (e.g. breaking_news). Example: breaking_news.
custom_iconstring- url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
custom_imagestring- url of custom image to use (recommended size: 300x500)). Example: https://cdn.example.com/banner-300x500.png.
feed_urlstring- URL of RSS feed. Example: https://www.example.com/blog/feed.xml.
linkstring- Push Notification Link. Example: https://shop.example.com/sale.
max_enabledinteger- enable maximum number of sends — set 0 for false, 1 for true. Example: 10.
max_typestring- hourly or daily. Example: daily.one of
hourlydaily max_valueinteger- maximum number of sends e.g. 5 or 20. Example: 10.
namestring- Name of Campaign. Example: Spring sale.
segmentsstring- Segments — comma separated list with no spaces e.g. 12345,12346,12347. Example: 12345,12346.
titlestring- Push Title. Example: Flash sale ends tonight.
aimtell_segment_createCreate a subscriber segment from a condition definition.WriteCreate Segment
Create a subscriber segment from a condition definition. Returns the result and the new segment id. Use segment_counts_get to see how many subscribers match.
Inputs
definitionstringrequired- Segment rule as Aimtell's condition string, for example region==California. Read an existing segment with segment_get to see the format. Example: region==California.
namestringrequired- Name of Segment. Example: Spring sale.
site_idstringrequired- Site ID. Example: 12345.
aimtell_segment_updateUpdate a segment's name or definition.WriteUpdate Segment
Update a segment's name or definition. Returns the result. Campaigns targeting it use the new definition from then on.
- Idempotent
Inputs
segment_idstringrequired- ID of the segment. Get it from segments_list. Example: 98765.
definitionstring- Segment rule as Aimtell's condition string, for example region==California. Read an existing segment with segment_get to see the format. Example: region==California.
namestring- Name of Segment. Example: Spring sale.
aimtell_site_createAdd a website to the Aimtell account.WriteAdd Website
Add a website to the Aimtell account. Returns the result and the new site id. Install the tracking code from site_code_get on the website afterwards.
Inputs
namestringrequired- Name of Website. Example: Spring sale.
urlstringrequired- Website URL. Example: https://www.example.com.
aimtell_site_permission_grantGive a registered Aimtell user access to a website by email.WriteGrant Website Access
Give a registered Aimtell user access to a website by email. Returns the result. The person must already have an Aimtell account.
Inputs
emailstringrequired- email address of registered user. Example: jane@example.com.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
aimtell_site_settings_updateUpdate a website's tracking settings.WriteUpdate Website Settings
Update a website's tracking settings. Aimtell requires every setting on each call. Returns the result. Read the current values with site_settings_get first.
Inputs
collect_ipintegerrequired- Allow collection of IP Address (0 = false, 1 = true). Defaults to 1. Example: 1.
collect_ip_as_attributeintegerrequired- Automatically track IP address as a custom attribute (0 = false, 1 = true). Defaults to 0. Example: 0.
collect_suburlintegerrequired- Automatically track subscription URL as custom attribute (0 = false, 1 = true). Defaults to 0. Example: 0.
collect_ua_as_attributeintegerrequired- Automatically track User Agent as custom attribute (0 = false, 1 = true). Defaults to 1. Example: 1.
frequency_capintegerrequired- Max number of notifications a subscriber can receive per day. Defaults to 15. Example: 15.
retention_lengthintegerrequired- Number of days to keep data for deleted subscribers. Defaults to 30. Example: 30.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
track_clicks_as_eventsintegerrequired- Automatically track notification clicks as custom events. (0 = false, 1 = true). Defaults to 0. Example: 0.
track_subscribe_as_eventintegerrequired- Automatically track subscriptions as custom events. (0 = false, 1 = true). Defaults to 0. Example: 0.
aimtell_site_updateUpdate a website's name or icon.WriteUpdate Website
Update a website's name or icon. Returns the result. The website URL cannot be changed.
- Idempotent
Inputs
namestringrequired- Website Name. Example: Spring sale.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
iconstring- URL of Website Icon. Example: https://www.example.com/favicon.png.
aimtell_site_variable_upsertCreate or update a website custom variable by name.WriteUpsert Website Custom Variable
Create or update a website custom variable by name. Returns the result. Variables can be used in notification content.
Inputs
namestringrequired- Name of Custom Variable. Example: coupon_code.
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
valuestringrequired- Value of Custom Variable. Example: SPRING20.
aimtell_subscriber_attributes_trackSet custom attributes on a subscriber, identified by subscriber_uid, user alias or email alias.WriteTrack Subscriber Attributes
Set custom attributes on a subscriber, identified by subscriber_uid, user alias or email alias. Returns the result. Attributes can then be used in segment definitions.
Inputs
attributesstringrequired- JSON. Example: {"plan": "pro", "city": "Austin"}
site_idstringrequired- Website ID. Example: 12345.
emailstring- Subscriber "Email" Alias. Example: jane@example.com.
subscriber_uidstring- Aimtell Subscriber ID. Example: a1b2c3d4e5.
userstring- Subscriber "User" Alias. Example: jack17.
aimtell_welcome_campaign_upsertCreate or update a site's welcome notification.WriteUpdate Welcome Campaign
Create or update a site's welcome notification. Returns the result. Set status 1 to activate it, 0 to keep it as a draft.
Inputs
bodystringrequired- Push Body. Example: Take 20% off everything until midnight.
linkstringrequired- Link. Example: https://shop.example.com/sale.
site_idstringrequired- Site ID. Example: 12345.
statusstringrequired- 0 = draft, 1 = active. Defaults to 0. Example: 1.one of
01 titlestringrequired- Push Title. Example: Flash sale ends tonight.
actionsobject- action buttons. Example: {"action1": {"title": "Shop now", "link": "https://shop.example.com/sale"}}
conversion_triggerobject- Conversion Trigger. Example: {"event_category": "purchase", "event_action": "checkout"}
custom_iconstring- url of custom icon to use (recommended size: 250x250). Example: https://cdn.example.com/icon-250.png.
custom_imagestring- url of custom image to use (recommended size: 300x500). Example: https://cdn.example.com/banner-300x500.png.
aimtell_campaign_deleteDelete a manual push campaign.DestructiveDelete Manual Campaign
Delete a manual push campaign. Returns the result. Scheduled sends for it are cancelled.
- Idempotent
Inputs
campaign_idstringrequired- ID of the campaign. Get it from campaigns_list. Example: 98765.
aimtell_event_campaign_deleteDelete an event-triggered campaign.DestructiveDelete Event Triggered Campaign
Delete an event-triggered campaign. Returns the result. It stops firing immediately.
- Idempotent
Inputs
event_campaign_idstringrequired- ID of the event campaign. Get it from event_campaigns_list. Example: 98765.
aimtell_pixel_deleteDelete a tracking pixel.DestructiveDelete Tracking Pixel
Delete a tracking pixel. Returns the result. Pages that load it stop recording the event.
- Idempotent
Inputs
pixel_idstringrequired- ID of the pixel. Get it from pixels_list. Example: 98765.
aimtell_prompt_deleteDelete an opt-in prompt.DestructiveDelete Opt-in Prompt
Delete an opt-in prompt. Returns the result. The prompt stops showing on the website.
- Idempotent
Inputs
prompt_idstringrequired- ID of the prompt. Get it from prompts_list. Example: 98765.
aimtell_rss_campaign_deleteDelete an RSS campaign.DestructiveDelete RSS Campaign
Delete an RSS campaign. Returns the result. It stops sending immediately.
- Idempotent
Inputs
rss_campaign_idstringrequired- ID of the rss campaign. Get it from rss_campaigns_list. Example: 98765.
aimtell_segment_deleteDelete a segment.DestructiveDelete Segment
Delete a segment. Returns the result. Campaigns that target it lose that audience.
- Idempotent
Inputs
segment_idstringrequired- ID of the segment. Get it from segments_list. Example: 98765.
aimtell_site_deleteDelete a website from the account, with its subscribers and campaigns.DestructiveDelete Website
Delete a website from the account, with its subscribers and campaigns. Returns the result. This cannot be undone.
- Idempotent
Inputs
site_idstringrequired- Aimtell site (website) ID. Get it from sites_list. Example: 12345.
No tools match.