Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Aimtell

Scalekit connector
Open markdown

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

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. 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>
  3. Create the Aimtell connection

    In AgentKit > Connections, create an Aimtell connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. 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.actions
    const connector = 'aimtell'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { 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 call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'aimtell_sites_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each 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 to execute_tool
Try in PlaygroundRequest a tool
  • aimtell_account_analytics_getGet a metric over time across all websites in the account.Read-only

    Get 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-only

    Get 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-only

    List 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-only

    List 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-only

    Get 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-only

    Get 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-only

    List 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-only

    Get 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.