Your analytics, search and outreach. One API.

Everything you open Google Analytics 4 and Search Console for, and your Auli campaigns, from Claude, Cursor or your own code. Ask in plain English over MCP, or call 20 REST endpoints. One key works for both.

On this page
Two-minute start

Create a key, connect, ask.

Three steps, and you have your workspace's traffic and search data wherever you work.

  1. 1. Create a key

    Open Team → API & MCP, name the key, keep Read only, pick the workspaces it may reach and create it. Copy it: it is shown once.

  2. 2. Connect

    In Claude Code, one command. For other clients, see MCP.

    bash · Claude Code
    claude mcp add --transport http auli https://auli.ai/api/mcp \
      --header "Authorization: Bearer auli_pat_…"

    Or from code, keep the key in an environment variable and find your workspace id:

    bash · REST
    export AULI_API_KEY=auli_pat_…
    curl https://auli.ai/api/v1/workspaces -H "Authorization: Bearer $AULI_API_KEY"
    export AULI_WORKSPACE=<workspace_id from the list>
  3. 3. Ask

    Prompt · Claude
    List my Auli workspaces. For the first one, compare last month's website traffic and Google search clicks with the month before, and tell me the three biggest changes.
    bash · the same from code
    curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/web?period=last_month" \
      -H "Authorization: Bearer $AULI_API_KEY"
Analytics comes from the workspace's own Google connections. If a call says a source is not connected, connect Google Analytics or Search Console in Team → Integrations, then check with GET /workspaces/{id}/analytics.
Access keys

Keys that can only do what you choose.

Send a key on every request as Authorization: Bearer auli_pat_…. MCP clients that can sign in (Claude Code, Claude Desktop, claude.ai) can use your Auli login instead of a key.

When you create a key, you chooseOptionsRecommended
AccessRead only: the 21 tools that change nothing. Read and write: also send_reply, schedule_reply, enroll_contacts, set_campaign_status.Read only
WorkspacesAll my workspaces (including ones you join later), or only the ones you pick.Only the ones a script needs
Expiry30, 60, 90, 180 or 365 days, or never.90 days (the default)
  • A key acts as you: it sees a workspace only while you are a member, with your role there.
  • A key never carries admin-wide access, even if your account has it. That stays with signed-in sessions.
  • The key is shown once. Auli stores only a hash, so a lost key can't be recovered: revoke it and create another. Each key shows when it was last used and when it expires.
  • GET /me tells you who a key acts as, its scope, workspaces and expiry.
json · GET /api/v1/me
{
  "user": { "id": "…", "email": "you@company.com" },
  "auth": {
    "via": "access_key",
    "scope": "read",
    "workspaces": ["68694d42-…"],
    "expires_at": "2027-02-17T15:00:00.000Z"
  }
}
Claude, Cursor & MCP

Ask in plain English.

The MCP server at https://auli.ai/api/mcp gives AI assistants every tool on this page. They pick the right report, filters and dates from your question.

Claude Code

bash · with an access key
claude mcp add --transport http auli https://auli.ai/api/mcp \
  --header "Authorization: Bearer $AULI_API_KEY"
bash · or sign in with your Auli account
claude mcp add --transport http auli https://auli.ai/api/mcp
# then run /mcp inside Claude Code, choose auli and sign in

Claude Desktop and claude.ai

Settings → Connectors → Add custom connector. Name it Auli, paste https://auli.ai/api/mcp and sign in when Claude asks.

Cursor, Windsurf, VS Code and other clients

mcp.json · remote server with a key
{
  "mcpServers": {
    "auli": {
      "url": "https://auli.ai/api/mcp",
      "headers": { "Authorization": "Bearer auli_pat_…" }
    }
  }
}
json · clients that only run local servers (via mcp-remote)
{
  "mcpServers": {
    "auli": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://auli.ai/api/mcp", "--header", "Authorization:Bearer ${AULI_API_KEY}"],
      "env": { "AULI_API_KEY": "auli_pat_…" }
    }
  }
}

Good first questions

  • “Which channels drove sign-ups this quarter, compared with last quarter?”
  • “What are people on the site doing right now?”
  • “Which queries are we on page two for, and which page should we improve for each?”
  • “Which pages lost the most Google clicks this month, and are they still indexed?”
  • “Build a weekly report of users, key events and search clicks for the last 12 weeks.”

Check the connection

bash · list the tools your key can see
curl -s https://auli.ai/api/mcp \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
REST from code

Plain HTTPS and JSON.

The base URL is https://auli.ai/api/v1. Reads are GET with query parameters; custom reports are POST with a JSON body. Every endpoint is also a tool you can call with POST /tools/{name}.

python · a weekly report for every workspace
import os, requests

API = "https://auli.ai/api/v1"
s = requests.Session()
s.headers["Authorization"] = f"Bearer {os.environ['AULI_API_KEY']}"

for w in s.get(f"{API}/workspaces", timeout=30).json()["workspaces"]:
    ws = w["workspace_id"]
    web = s.get(f"{API}/workspaces/{ws}/analytics/web", params={"period": "7d"}, timeout=60)
    search = s.get(f"{API}/workspaces/{ws}/analytics/search", params={"period": "7d"}, timeout=60)
    if web.ok and search.ok:
        t, c = web.json()["totals"], search.json()["totals"]
        print(f"{w['name']}: {t['active_users']} users, {t['key_events']} key events, {c['clicks']} search clicks")
    else:
        print(w["name"], (web.json() if not web.ok else search.json())["error"]["message"])
javascript · Node 18+, top landing pages
const API = "https://auli.ai/api/v1";
const headers = { Authorization: `Bearer ${process.env.AULI_API_KEY}` };
const ws = process.env.AULI_WORKSPACE;

const res = await fetch(`${API}/workspaces/${ws}/analytics/web/landing_pages?period=28d&limit=10`, { headers });
const body = await res.json();
if (!res.ok) throw new Error(body.error.message);
console.table(body.rows.map((r) => ({ page: r.landing_page, sessions: r.sessions, key_events: r.key_events, change: r.change_pct.sessions })));
Answer common questions

Copy, paste, get the answer.

Each recipe shows the question to ask an assistant and the same call from code. Pick a language once; every recipe follows.

Everything for a traffic dashboard, in one call?

GA4 overview with the previous period and a zero-filled daily series, top channels, landing pages, referrers, countries, devices and key events, plus Search Console totals, daily series, top queries and pages and opportunities. hostname=auto counts only the site in the GA data stream.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/summary
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/summary?period=30d&hostname=auto" \
  -H "Authorization: Bearer $AULI_API_KEY"

Can we trust our analytics numbers?

Tracking health: localhost and preview traffic, missing key events, page_view marked as a key event, sign-in and app traffic, (not set) landing pages, and GA and Search Console on different sites. Each failing check says what to fix.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/health
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/health?period=30d" \
  -H "Authorization: Bearer $AULI_API_KEY"

How are all our sites doing, side by side?

Headline GA4 and Search Console numbers for every workspace your key reaches, each with the previous period and a daily series. A key limited to chosen workspaces covers only those.

curl · GET /api/v1/analytics/portfolio
curl "https://auli.ai/api/v1/analytics/portfolio?period=30d&hostname=auto&include_health=true" \
  -H "Authorization: Bearer $AULI_API_KEY"

How did traffic do last month, against the month before?

The overview report: users, sessions, engagement, page views, key events and revenue, each with the previous period and the change, plus a daily series.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/web
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/web?period=last_month" \
  -H "Authorization: Bearer $AULI_API_KEY"

Which channels bring people who convert?

Sessions, users, engagement and key events per channel. Swap channels for sources, campaigns or acquisition (first touch).

curl · GET /api/v1/workspaces/{workspace_id}/analytics/web/channels
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/web/channels?period=90d" \
  -H "Authorization: Bearer $AULI_API_KEY"

Which landing pages work, and on which device?

Filter any report: here, mobile visitors only. Filters combine, and a comma gives several values.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/web/landing_pages
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/web/landing_pages?period=this_month&device=mobile&limit=20" \
  -H "Authorization: Bearer $AULI_API_KEY"

Who is on the site right now?

Active users in the last 30 and 5 minutes, a per-minute series, and countries, pages, devices and events.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/web/realtime
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/web/realtime" \
  -H "Authorization: Bearer $AULI_API_KEY"

What do people search on Google to find us, without our brand name?

Search Console queries with clicks, impressions, CTR and position, compared with the previous period. exclude_query drops brand searches.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/search/queries
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/search/queries?period=28d&exclude_query=auli&limit=50" \
  -H "Authorization: Bearer $AULI_API_KEY"

Where can we win more search traffic?

Queries one push from page one (with the clicks a top-3 spot would add), weak click-through rates, the biggest gainers and losers, and pages competing for the same query.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/search/opportunities
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/search/opportunities?period=90d" \
  -H "Authorization: Bearer $AULI_API_KEY"

Is this page indexed? If not, why?

URL Inspection: index verdict, coverage, last crawl, canonical, sitemaps, mobile usability and rich results.

curl · GET /api/v1/workspaces/{workspace_id}/analytics/search/inspect
curl "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/search/inspect?url=https%3A%2F%2Fauli.ai%2Fpricing" \
  -H "Authorization: Bearer $AULI_API_KEY"

Anything else GA4 can answer

Any dimensions and metrics, including your custom ones, with filters, ordering and paging. Use list_ga4_fields (GET …/analytics/web/fields) to find names.

curl · POST /api/v1/workspaces/{workspace_id}/analytics/web/query
curl -X POST "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/web/query" \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "period": "30d",
    "dimensions": [
      "date",
      "country"
    ],
    "metrics": [
      "keyEvents",
      "activeUsers"
    ],
    "filters": [
      {
        "field": "country",
        "match": "in_list",
        "values": [
          "Germany",
          "France"
        ]
      },
      {
        "field": "eventName",
        "match": "exact",
        "value": "sign_up"
      }
    ],
    "order_by": [
      {
        "field": "date"
      }
    ],
    "limit": 500
  }'

Anything else Search Console can answer

Any Search Analytics query: dimensions in any combination, regex filters, image, video or news search, up to 25,000 rows per call.

curl · POST /api/v1/workspaces/{workspace_id}/analytics/search/query
curl -X POST "https://auli.ai/api/v1/workspaces/$AULI_WORKSPACE/analytics/search/query" \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "period": "90d",
    "dimensions": [
      "query",
      "page"
    ],
    "filters": [
      {
        "dimension": "query",
        "operator": "includingRegex",
        "expression": "(?i)price|pricing|cost"
      }
    ],
    "row_limit": 1000
  }'
From GA4 & Search Console

Where each screen lives in the API.

If you know where to click in Google Analytics or Search Console, this is the call that gives you the same numbers.

  • GA4 · Home, Reports snapshot
    Overview
    /analytics/web
  • GA4 · Realtime
    Realtime
    /analytics/web/realtime
  • GA4 · Acquisition › Traffic acquisition
    Channels, source/medium, campaigns
    /analytics/web/channels · /sources · /campaigns
  • GA4 · Acquisition › User acquisition
    First-touch acquisition
    /analytics/web/acquisition
  • GA4 · Engagement › Landing page
    Landing pages
    /analytics/web/landing_pages
  • GA4 · Engagement › Pages and screens
    Pages
    /analytics/web/pages
  • GA4 · Engagement › Events
    Events
    /analytics/web/events
  • GA4 · Engagement › Key events (Conversions)
    Key events
    /analytics/web/key_events
  • GA4 · User attributes › Demographics
    Countries, regions, cities, languages, age, gender
    /analytics/web/countries · /cities · /age …
  • GA4 · Tech › Tech details
    Devices, browsers, operating systems
    /analytics/web/devices · /browsers · /operating_systems
  • GA4 · Retention (new vs returning)
    New vs returning
    /analytics/web/new_vs_returning
  • GA4 · Monetization › Ecommerce purchases
    Ecommerce, products
    /analytics/web/ecommerce · /products
  • GA4 · Explore (free form)
    Any report
    POST /analytics/web/query
  • GA4 · Admin › Custom definitions
    Every field, custom ones included
    /analytics/web/fields
  • Search Console · Performance › Queries
    Queries
    /analytics/search/queries
  • Search Console · Performance › Pages
    Pages, queries per page
    /analytics/search/pages · /query_pages
  • Search Console · Performance › Countries, Devices
    Countries, devices
    /analytics/search/countries · /devices
  • Search Console · Performance › Search appearance
    Search appearance
    /analytics/search/search_appearance
  • Search Console · Performance › 24 hours
    By hour
    /analytics/search/hourly
  • Search Console · URL Inspection
    Inspect a URL
    /analytics/search/inspect?url=…
  • Search Console · Sitemaps
    Sitemaps
    /analytics/search/sitemaps
  • Search Console · Compare, filters, regex
    Any query
    POST /analytics/search/query
  • Not in either: one-call dashboard
    Summary: GA4 and Search Console together
    /analytics/summary
  • Not in either: tracking health
    Stray hostnames, key events, app traffic, (not set)
    /analytics/health
  • Not in either: opportunities
    Striking distance, weak CTR, movers, cannibalisation
    /analytics/search/opportunities
Dates, filters, responses

Learn these once.

Dates

Give a period or exact start_date and end_date (YYYY-MM-DD, inclusive). Without either, reports cover the last 28 days, as Google does. A range can cover up to 366 days.

todayyesterday7d14d28d30d90d180d365dthis_monthlast_monththis_quarterlast_quarterthis_yearlast_year

Reports compare with the previous period of the same length unless you pass compare=false.

Filters

Every ready-made report takes the same filters. Combine them freely; a comma gives several values (country=Germany,France).

Web analytics

FilterMeaning
countryCountry name as GA4 shows it, e.g. "United States". Comma-separate several.
devicedesktop, mobile or tablet. Comma-separate several.
channele.g. "Organic Search", "Direct". Comma-separate several.
sourcee.g. "google", "linkedin.com".
mediume.g. "organic", "referral", "cpc".
campaignUTM campaign name.
pagePage path contains this, e.g. "/pricing".
landing_pageLanding page contains this.
eventEvent name, e.g. "sign_up".
hostnameOnly these hostnames, for properties that also record previews, localhost or an app. Comma-separate several; "*.example.com" matches example.com and every subdomain. e.g. "www.example.com,example.com".

Search

FilterMeaning
queryQuery contains this text. Comma-separate several to match any.
exact_queryQuery is exactly this.
exclude_queryLeave out queries containing this, e.g. your brand name. Comma-separate several.
pagePage URL contains this, e.g. /blog/.
exact_pagePage URL is exactly this.
exclude_pageLeave out pages whose URL contains this.
countryCountry as an ISO 3166-1 alpha-3 code, e.g. "usa", "gbr", "tur".
deviceDESKTOP, MOBILE or TABLET.
search_appearanceA search appearance type, e.g. "VIDEO" (see the search_appearance report).

Responses

Every report has the same shape. Field names are snake_case (custom reports keep GA4's own names). Rates are fractions: 0.53 is 53%.

json · GET …/analytics/web/channels?period=28d (shortened)
{
  "workspace_id": "68694d42-…",
  "property": { "id": "412345678", "name": "Upsight" },
  "report": "channels",
  "period": { "start_date": "2026-10-23", "end_date": "2026-11-19", "days": 28 },
  "previous_period": { "start_date": "2026-09-25", "end_date": "2026-10-22" },
  "filters": {},
  "totals": { "sessions": 963, "active_users": 431, "engagement_rate": 0.53, "key_events": 12 },
  "previous_totals": { "sessions": 310, "active_users": 136, "engagement_rate": 0.49, "key_events": 4 },
  "change_pct": { "sessions": 210.6, "active_users": 216.9, "engagement_rate": 8.2, "key_events": 200 },
  "rows": [
    {
      "session_default_channel_group": "Referral",
      "sessions": 512,
      "active_users": 240,
      "previous": { "sessions": 120, "active_users": 70 },
      "change_pct": { "sessions": 326.7, "active_users": 242.9 }
    }
  ],
  "row_count": 7,
  "truncated": false,
  "notes": []
}
  • change_pct is null when there is nothing to compare with.
  • Search results carry change instead: clicks_pct, impressions_pct, ctr_points and positions_gained (positive means you moved up).
  • notes says when Google withheld small numbers, sampled the data, or left anonymised queries out of the rows.
  • Paging: custom GA4 reports return next_offset; custom search queries return next_start_row. Pass it back to get the next page.
Summary & tracking health

One call for the dashboard, one for whether to trust it.

Built for dashboards and agents that report on several sites: fewer calls, and a clear answer on whether the numbers are clean.

EndpointWhat you get
GET /workspaces/{id}/analytics/summaryweb: totals, previous_totals, change_pct, daily (one row per day, zeros included), channels (with change), landing_pages, referrers, countries, devices, key_events. search: totals, change, daily, queries and pages (with change), opportunities. Takes period, hostname, exclude_query, limit (rows per list, default 10) and include_health.
GET /workspaces/{id}/analytics/healthstatus (ok, warn or bad), the main site and where it came from, suggested_filters.hostname to pass to other reports, and checks: each with status, detail, fix and the numbers behind it.
GET /analytics/portfolioEvery workspace the key can reach, each with web and search totals, change and daily series. hostname=auto uses each workspace's own site; include_health adds its health status and failing checks; workspace_ids narrows the list.

A source that is not connected does not fail the call: its section says {"status": "not_connected"} with the reason.

Health checks

CheckFlags
ga_connected · gsc_connectedGoogle Analytics or Search Console not connected, or no property or site picked.
same_siteThe GA property's site and the Search Console site are different domains.
receiving_dataNo sessions at all in the period.
other_hostnamesSessions on hosts other than the real site — localhost, 127.0.0.1, *.vercel.app and *.framer.app previews, app subdomains — with each one's share.
key_events_configuredNo key events set up (read from the property), or none fired in the period.
noise_key_eventspage_view, session_start, first_visit, user_engagement or scroll marked as a key event, inflating conversions.
app_trafficProduct use counted as site visits: referrals from accounts.google.com or login hosts, app paths such as /dashboard or /login as landing pages, app subdomains.
not_set_landing_pagesA high share of sessions with landing page "(not set)".

The real site comes from your hostname if you give one, else the GA web data stream's URL, else the Search Console site, else the busiest hostname.

json · GET …/analytics/health?period=30d (shortened)
{
  "status": "bad",
  "counts": { "ok": 5, "warn": 1, "bad": 2, "skipped": 0 },
  "main_site": { "hosts": ["www.upsight.fyi", "upsight.fyi"], "source": "data_stream" },
  "suggested_filters": { "hostname": "www.upsight.fyi,upsight.fyi" },
  "checks": [
    {
      "id": "other_hostnames",
      "status": "bad",
      "detail": "31.2% of sessions are on hosts other than www.upsight.fyi, upsight.fyi: 127.0.0.1 (local, 22.4%), localhost (local, 8.8%).",
      "fix": "Pass hostname=www.upsight.fyi,upsight.fyi to reports to count the real site only, …"
    },
    { "id": "key_events_configured", "status": "bad", "detail": "No key events are set up, …" }
  ]
}
Web analytics reports

29 GA4 reports, ready to use.

Each is one GET. They all take a period, the web filters and limit, and compare with the previous period.

ReportWhat it answersBreaks down byEndpoint
overviewOverviewHeadline numbers (users, sessions, engagement, page views, key events, revenue) with a daily series.Totals/analytics/web
dailyBy dayOne row per day.date/analytics/web/daily
weeklyBy weekOne row per ISO week.isoYearIsoWeek/analytics/web/weekly
monthlyBy monthOne row per month.yearMonth/analytics/web/monthly
hourlyBy hourOne row per hour (property time zone).dateHour/analytics/web/hourly
channelsChannelsSessions by default channel group (Organic Search, Direct, Referral, Paid Social…).sessionDefaultChannelGroup/analytics/web/channels
sourcesSource / mediumSessions by source and medium (google / organic, linkedin.com / referral…).sessionSource, sessionMedium/analytics/web/sources
referralsReferralsSites that send visitors through links.sessionSource/analytics/web/referrals
campaignsCampaignsSessions by UTM campaign, with source and medium.sessionCampaignName, sessionSource, sessionMedium/analytics/web/campaigns
acquisitionNew-user acquisitionWhere new users first came from (first-touch channel and source).firstUserDefaultChannelGroup, firstUserSource/analytics/web/acquisition
landing_pagesLanding pagesThe first page of each session, with engagement and key events.landingPage/analytics/web/landing_pages
pagesPagesPages and screens by views, with users and engagement time.pagePath, pageTitle/analytics/web/pages
eventsEventsEvery event by count and users.eventName/analytics/web/events
key_eventsKey eventsConversions (GA4 key events) such as sign-ups and purchases.eventName/analytics/web/key_events
countriesCountriesUsers by country.country/analytics/web/countries
regionsRegionsUsers by region and country.region, country/analytics/web/regions
citiesCitiesUsers by city and country.city, country/analytics/web/cities
languagesLanguagesUsers by browser language.language/analytics/web/languages
devicesDevicesDesktop, mobile and tablet.deviceCategory/analytics/web/devices
browsersBrowsersUsers by browser.browser/analytics/web/browsers
operating_systemsOperating systemsUsers by operating system.operatingSystem/analytics/web/operating_systems
new_vs_returningNew vs returningNew and returning users.newVsReturning/analytics/web/new_vs_returning
ageAgeUsers by age bracket. Needs Google signals; small numbers are withheld by Google.userAgeBracket/analytics/web/age
genderGenderUsers by gender. Needs Google signals; small numbers are withheld by Google.userGender/analytics/web/gender
site_searchSite searchWhat visitors search for on the site (needs enhanced measurement).searchTerm/analytics/web/site_search
outbound_clicksOutbound clicksLinks to other sites that visitors click (needs enhanced measurement).linkUrl/analytics/web/outbound_clicks
file_downloadsFile downloadsFiles visitors download (needs enhanced measurement).fileName/analytics/web/file_downloads
ecommerceEcommercePurchases, revenue and the shopping funnel.Totals/analytics/web/ecommerce
productsProductsItems viewed, added to cart and purchased, with revenue.itemName/analytics/web/products

Also: /analytics/web/realtime for right now, /analytics/web/fields for every field the property has, and POST /analytics/web/query for any report you can build in GA4 Explorations.

Search reports

9 Search Console reports, plus what it doesn't tell you.

Clicks, impressions, CTR and average position for every report, compared with the previous period. Sort by any of them with sort_by.

ReportWhat it answersBreaks down byEndpoint
overviewOverviewClicks, impressions, CTR and average position, with a daily series.Totals/analytics/search
queriesQueriesWhat people searched for when the site appeared.query/analytics/search/queries
pagesPagesPages that appeared in search, by clicks.page/analytics/search/pages
query_pagesQueries by pageEach query with the page that ranked for it.query, page/analytics/search/query_pages
countriesCountriesSearchers by country (ISO 3166-1 alpha-3 codes).country/analytics/search/countries
devicesDevicesDesktop, mobile and tablet.device/analytics/search/devices
search_appearanceSearch appearanceRich results, videos, AMP and other result types.searchAppearance/analytics/search/search_appearance
dailyBy dayOne row per day.date/analytics/search/daily
hourlyBy hourOne row per hour for roughly the last 10 days (Search Console's hourly data).hour/analytics/search/hourly
Beyond the reportsEndpointWhat you get
Opportunities/analytics/search/opportunitiesStriking-distance queries with estimated extra clicks, weak CTR at top positions, biggest gainers and losers (queries and pages), and cannibalisation.
URL inspection/analytics/search/inspect?url=…Indexed or not and why, last crawl, robots.txt, canonical, sitemaps, mobile usability, rich results.
Sitemaps/analytics/search/sitemapsEach submitted sitemap with last read, errors, warnings and URL counts.
Any queryPOST /analytics/search/queryAny dimensions, regex filters, image/video/news/Discover, by page or property, up to 25,000 rows a call.
Endpoints

Everything under /api/v1.

Every response carries an X-Request-Id header; include it when you report a problem. Unknown query parameters are refused, so a typo never silently returns the wrong data.

Account

MethodPathWhat it returns
GET/meWho the key acts as, its scope, workspaces and expiry.
GET/toolsEvery tool this key can call, with its input schema.
POST/tools/{name}Run any tool. The body is a JSON object of its arguments.
GET/openapi.jsonThe OpenAPI 3.1 description of the API. No key needed.

Workspaces

MethodPathWhat it returns
GET/workspacesWorkspaces you can reach, with your role in each. list_workspaces

Analytics

MethodPathWhat it returns
GET/workspaces/{workspace_id}/analyticsWhich Google sources are connected and what they unlock. get_analytics_status
GET/workspaces/{workspace_id}/distributionTraffic and search demand in one call, with the previous period. get_distribution_report
GET/workspaces/{workspace_id}/analytics/summaryGA4 and Search Console in one call: overview, daily series, top lists, opportunities. get_analytics_summary
GET/workspaces/{workspace_id}/analytics/healthTracking health checks: stray hostnames, key events, app traffic, (not set), setup. get_tracking_health
GET/analytics/portfolioHeadline GA4 and Search Console numbers for every workspace the key reaches. get_analytics_portfolio

Web analytics

MethodPathWhat it returns
GET/workspaces/{workspace_id}/analytics/web/realtimeWho is on the site right now. get_realtime_visitors
GET/workspaces/{workspace_id}/analytics/web/fieldsEvery GA4 dimension and metric, including custom ones. list_ga4_fields
POST/workspaces/{workspace_id}/analytics/web/queryAny GA4 report: your dimensions, metrics, filters and order. run_ga4_report
GET/workspaces/{workspace_id}/analytics/webThe overview report: headline numbers and a daily series. get_web_analytics
GET/workspaces/{workspace_id}/analytics/web/{report}A ready-made GA4 report: channels, sources, pages, countries, devices, events and more. get_web_analytics

Search

MethodPathWhat it returns
GET/workspaces/{workspace_id}/analytics/search/opportunitiesStriking-distance queries, weak CTR, movers and cannibalisation. get_search_opportunities
GET/workspaces/{workspace_id}/analytics/search/inspectIndex status of one URL (?url=…). inspect_url
GET/workspaces/{workspace_id}/analytics/search/sitemapsSubmitted sitemaps and their state. list_sitemaps
POST/workspaces/{workspace_id}/analytics/search/queryAny Search Analytics query: dimensions, regex filters, paging. run_search_console_query
GET/workspaces/{workspace_id}/analytics/searchThe overview: clicks, impressions, CTR, position and a daily series. get_search_performance
GET/workspaces/{workspace_id}/analytics/search/{report}A ready-made search report: queries, pages, countries, devices and more. get_search_performance

Outreach

MethodPathWhat it returns
GET/workspaces/{workspace_id}/gtm-reportOutreach results: funnel, campaigns, senders, inbox, pipeline and CRM sync. get_gtm_report
GET/workspaces/{workspace_id}/campaignsCampaigns with their status and how many contacts are in each state. list_campaigns
GET/workspaces/{workspace_id}/campaigns/{campaign_id}One campaign's sequence and progress. get_campaign
Tools

25 tools, the same over MCP and REST.

Over MCP, call them by name with tools/call. Over REST, use the endpoint shown or POST the arguments to /api/v1/tools/{name}. This list is generated from the server's own code.

Workspaces & analytics

list_workspaces

Read only

Workspaces you can reach, with your role in each. Call this first: every other tool takes a workspace_id. An access key limited to chosen workspaces lists only those.

REST: GET /api/v1/workspaces or POST /api/v1/tools/list_workspaces

No arguments.

curl · POST /api/v1/tools/list_workspaces
curl -X POST https://auli.ai/api/v1/tools/list_workspaces \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

get_distribution_report

Read only

How many people reach the workspace's product in a date range: web traffic from its Google Analytics property (users, sessions, channels, key events such as sign-ups) and search demand from its Search Console site (clicks, impressions, position), each with the previous period. `sources` says which of the two are connected; a source that is not connected returns null.

REST: GET /api/v1/workspaces/{workspace_id}/distribution or POST /api/v1/tools/get_distribution_report

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
start_datestringNoYYYY-MM-DD. Default: 29 days before end_date.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
curl · POST /api/v1/tools/get_distribution_report
curl -X POST https://auli.ai/api/v1/tools/get_distribution_report \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_analytics_status

Read only

Which Google sources the workspace has connected (Google Analytics 4 property, Search Console site) and which analytics tools they unlock. Call this first when an analytics tool says a source is not connected.

REST: GET /api/v1/workspaces/{workspace_id}/analytics or POST /api/v1/tools/get_analytics_status

1 argument
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
curl · POST /api/v1/tools/get_analytics_status
curl -X POST https://auli.ai/api/v1/tools/get_analytics_status \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_web_analytics

Read only

A ready-made Google Analytics 4 report, compared with the previous period. Reports: overview (Headline numbers (users, sessions, engagement, page views, key events, revenue) with a daily series); daily (One row per day); weekly (One row per ISO week); monthly (One row per month); hourly (One row per hour (property time zone)); channels (Sessions by default channel group (Organic Search, Direct, Referral, Paid Social…)); sources (Sessions by source and medium (google / organic, linkedin.com / referral…)); referrals (Sites that send visitors through links); campaigns (Sessions by UTM campaign, with source and medium); acquisition (Where new users first came from (first-touch channel and source)); landing_pages (The first page of each session, with engagement and key events); pages (Pages and screens by views, with users and engagement time); events (Every event by count and users); key_events (Conversions (GA4 key events) such as sign-ups and purchases); countries (Users by country); regions (Users by region and country); cities (Users by city and country); languages (Users by browser language); devices (Desktop, mobile and tablet); browsers (Users by browser); operating_systems (Users by operating system); new_vs_returning (New and returning users); age (Users by age bracket. Needs Google signals; small numbers are withheld by Google); gender (Users by gender. Needs Google signals; small numbers are withheld by Google); site_search (What visitors search for on the site (needs enhanced measurement)); outbound_clicks (Links to other sites that visitors click (needs enhanced measurement)); file_downloads (Files visitors download (needs enhanced measurement)); ecommerce (Purchases, revenue and the shopping funnel); products (Items viewed, added to cart and purchased, with revenue). Every report takes the same simple filters (country, device, channel, source, medium, campaign, page, landing_page, event, hostname). For anything else use run_ga4_report.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/web or POST /api/v1/tools/get_web_analytics

17 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
reportstringNoWhich report. Default overview.overview, daily, weekly, monthly, hourly, channels, sources, referrals, campaigns, acquisition, landing_pages, pages, events, key_events, countries, regions, cities, languages, devices, browsers, operating_systems, new_vs_returning, age, gender, site_search, outbound_clicks, file_downloads, ecommerce, products
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period of the same length and the change. Default true.
limitintegerNoRows to return, 1–1000. Default 25.
countrystringNoCountry name as GA4 shows it, e.g. "United States". Comma-separate several.
devicestringNodesktop, mobile or tablet. Comma-separate several.
channelstringNoe.g. "Organic Search", "Direct". Comma-separate several.
sourcestringNoe.g. "google", "linkedin.com".
mediumstringNoe.g. "organic", "referral", "cpc".
campaignstringNoUTM campaign name.
pagestringNoPage path contains this, e.g. "/pricing".
landing_pagestringNoLanding page contains this.
eventstringNoEvent name, e.g. "sign_up".
hostnamestringNoOnly these hostnames, for properties that also record previews, localhost or an app. Comma-separate several; "*.example.com" matches example.com and every subdomain. e.g. "www.example.com,example.com".
curl · POST /api/v1/tools/get_web_analytics
curl -X POST https://auli.ai/api/v1/tools/get_web_analytics \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

run_ga4_report

Read only

Any Google Analytics 4 report: up to 9 dimensions and 10 metrics by their GA4 API names (activeUsers, sessionSource, customEvent:plan…), with dimension and metric filters, ordering and paging. The same power as GA4 Explorations. list_ga4_fields lists every field, including the property's custom ones.

REST: POST /api/v1/workspaces/{workspace_id}/analytics/web/query or POST /api/v1/tools/run_ga4_report

13 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
dimensionsstring[]NoGA4 dimension names, e.g. ["date", "sessionDefaultChannelGroup"]. Optional.
metricsstring[]YesGA4 metric names, e.g. ["activeUsers", "keyEvents"]. At least one.
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period and the change. Default false.
filtersobject[]NoDimension filters, all must match. Each: {field, match, value | values, not?, case_sensitive?}. match: exact, contains, begins_with, ends_with, regex, partial_regex, in_list. Example: [{"field":"country","match":"in_list","values":["Germany","France"]}].
metric_filtersobject[]NoMetric filters applied after aggregation. Each: {field, match, value | values}. match: eq, gt, gte, lt, lte, between. Example: [{"field":"sessions","match":"gte","value":100}].
order_byobject[]NoSort order. Each: {field, desc?}. As a string: "-sessions,date". Default: first metric, highest first.
limitintegerNoRows, 1–10000. Default 100.
offsetintegerNoRows to skip, for paging. Default 0.
keep_empty_rowsbooleanNoInclude rows whose metrics are all zero. Default false.
curl · POST /api/v1/tools/run_ga4_report
curl -X POST https://auli.ai/api/v1/tools/run_ga4_report \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","metrics":["…"]}'

get_realtime_visitors

Read only

Who is on the site right now: active users in the last 30 and 5 minutes, a minute-by-minute series, and breakdowns by country, page, device and event (also city, platform, audience).

REST: GET /api/v1/workspaces/{workspace_id}/analytics/web/realtime or POST /api/v1/tools/get_realtime_visitors

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
breakdownsstring[]NoDefault: countries, pages, devices, events.countries, cities, pages, devices, platforms, events, audiences
limitintegerNoRows per breakdown, 1–100. Default 10.
curl · POST /api/v1/tools/get_realtime_visitors
curl -X POST https://auli.ai/api/v1/tools/get_realtime_visitors \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

list_ga4_fields

Read only

Every dimension and metric the workspace's GA4 property supports, including its custom dimensions and metrics, with descriptions. Use the names in run_ga4_report.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/web/fields or POST /api/v1/tools/list_ga4_fields

4 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
kindstringNoDefault all.all, dimensions, metrics
searchstringNoOnly fields whose name or description contains this, e.g. "revenue".
custom_onlybooleanNoOnly the property's custom definitions. Default false.
curl · POST /api/v1/tools/list_ga4_fields
curl -X POST https://auli.ai/api/v1/tools/list_ga4_fields \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_search_performance

Read only

Google Search performance from Search Console, compared with the previous period: clicks, impressions, CTR and average position. Reports: overview (Clicks, impressions, CTR and average position, with a daily series); queries (What people searched for when the site appeared); pages (Pages that appeared in search, by clicks); query_pages (Each query with the page that ranked for it); countries (Searchers by country (ISO 3166-1 alpha-3 codes)); devices (Desktop, mobile and tablet); search_appearance (Rich results, videos, AMP and other result types); daily (One row per day); hourly (One row per hour for roughly the last 10 days (Search Console's hourly data)). Filters: query, exact_query, exclude_query (e.g. your brand), page, exact_page, exclude_page, country, device, search_appearance. For anything else use run_search_console_query.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/search or POST /api/v1/tools/get_search_performance

19 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
reportstringNoWhich report. Default overview.overview, queries, pages, query_pages, countries, devices, search_appearance, daily, hourly
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period of the same length and the change. Default true.
search_typestringNoDefault web.web, image, video, news, discover, googleNews
sort_bystringNoDefault clicks (position sorts best first).clicks, impressions, ctr, position
limitintegerNoRows to return, 1–1000. Default 25.
data_statestringNoall includes the freshest, still-changing days (as the Search Console UI does). Default all.all, final
querystringNoQuery contains this text. Comma-separate several to match any.
exact_querystringNoQuery is exactly this.
exclude_querystringNoLeave out queries containing this, e.g. your brand name. Comma-separate several.
pagestringNoPage URL contains this, e.g. /blog/.
exact_pagestringNoPage URL is exactly this.
exclude_pagestringNoLeave out pages whose URL contains this.
countrystringNoCountry as an ISO 3166-1 alpha-3 code, e.g. "usa", "gbr", "tur".
devicestringNoDESKTOP, MOBILE or TABLET.
search_appearancestringNoA search appearance type, e.g. "VIDEO" (see the search_appearance report).
curl · POST /api/v1/tools/get_search_performance
curl -X POST https://auli.ai/api/v1/tools/get_search_performance \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

run_search_console_query

Read only

Any Search Console Search Analytics query: dimensions date, hour, query, page, country, device and searchAppearance in any combination, regex filters, every search type, aggregation by page or property, fresh or final data, and up to 25,000 rows per call with paging.

REST: POST /api/v1/workspaces/{workspace_id}/analytics/search/query or POST /api/v1/tools/run_search_console_query

12 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
dimensionsstring[]NoOptional; none gives totals.date, hour, query, page, country, device, searchAppearance
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period and the change per row. Default false.
search_typestringNoDefault web.web, image, video, news, discover, googleNews
filtersobject[]NoAll must match. Each: {dimension, operator, expression}. operator: equals, notEquals, contains, notContains, includingRegex, excludingRegex. Example: [{"dimension":"query","operator":"includingRegex","expression":"(?i)pricing|cost"}].
aggregation_typestringNoDefault auto.auto, byPage, byProperty, byNewsShowcasePanel
data_statestringNoDefault all. hourly_all is needed for the hour dimension.final, all, hourly_all
row_limitintegerNo1–25000. Default 1000.
start_rowintegerNoRows to skip, for paging. Default 0.
curl · POST /api/v1/tools/run_search_console_query
curl -X POST https://auli.ai/api/v1/tools/run_search_console_query \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_search_opportunities

Read only

Where search traffic can grow or is slipping, worked out from Search Console data: striking-distance queries (position 4–20) with the clicks a top-3 spot would add, high-ranking queries with a weak click-through rate (rewrite the title and description), the queries and pages losing or gaining the most clicks against the previous period, and queries where several of your pages compete (cannibalisation). Use exclude_query for brand terms.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/search/opportunities or POST /api/v1/tools/get_search_opportunities

17 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period of the same length and the change. Default true.
search_typestringNoDefault web.web, image, video, news, discover, googleNews
min_impressionsintegerNoIgnore queries with fewer impressions. Default scales with the period (20 for 28 days).
limitintegerNoRows per list, 1–100. Default 15.
querystringNoQuery contains this text. Comma-separate several to match any.
exact_querystringNoQuery is exactly this.
exclude_querystringNoLeave out queries containing this, e.g. your brand name. Comma-separate several.
pagestringNoPage URL contains this, e.g. /blog/.
exact_pagestringNoPage URL is exactly this.
exclude_pagestringNoLeave out pages whose URL contains this.
countrystringNoCountry as an ISO 3166-1 alpha-3 code, e.g. "usa", "gbr", "tur".
devicestringNoDESKTOP, MOBILE or TABLET.
search_appearancestringNoA search appearance type, e.g. "VIDEO" (see the search_appearance report).
curl · POST /api/v1/tools/get_search_opportunities
curl -X POST https://auli.ai/api/v1/tools/get_search_opportunities \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

inspect_url

Read only

Google's index status for one page of the site, as Search Console's URL Inspection shows it: whether it is indexed and why not, last crawl, robots.txt and fetch state, Google's chosen canonical against yours, sitemaps that list it, mobile usability and rich results.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/search/inspect or POST /api/v1/tools/inspect_url

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
urlstringYesThe full page URL, on the workspace's Search Console site.
language_codestringNoFor translated issue messages, e.g. "en-US". Optional.
curl · POST /api/v1/tools/inspect_url
curl -X POST https://auli.ai/api/v1/tools/inspect_url \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","url":"…"}'

list_sitemaps

Read only

The sitemaps submitted for the workspace's Search Console site, with when Google last read them, errors and warnings, and how many URLs each lists.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/search/sitemaps or POST /api/v1/tools/list_sitemaps

1 argument
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
curl · POST /api/v1/tools/list_sitemaps
curl -X POST https://auli.ai/api/v1/tools/list_sitemaps \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_analytics_summary

Read only

Everything a traffic dashboard needs in one call: the GA4 overview with the previous period and a daily series (zero-filled, one row per day), top channels (with change), landing pages, referrers, countries, devices and key events; and Search Console totals, daily series, top queries and pages (with change) and opportunities. A source that is not connected comes back with its status instead of failing the call. Optional: include_health adds the tracking health checks.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/summary or POST /api/v1/tools/get_analytics_summary

9 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period of the same length and the change. Default true.
hostnamestringNoCount only these hostnames in Google Analytics. Comma-separate several; "*.example.com" matches example.com and its subdomains; "auto" uses the site from the GA data stream (or Search Console). Default: every hostname.
exclude_querystringNoLeave Search Console queries containing these out (e.g. your brand). Comma-separate several.
limitintegerNoRows per list, 1–100. Default 10.
include_healthbooleanNoAlso run get_tracking_health. Default false.
curl · POST /api/v1/tools/get_analytics_summary
curl -X POST https://auli.ai/api/v1/tools/get_analytics_summary \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_tracking_health

Read only

Whether the workspace's analytics can be trusted, as a list of checks (ok, warn, bad, skipped) with what to fix: Google Analytics and Search Console connected and pointing at the same site; GA receiving data; traffic on hostnames other than the real site (localhost, 127.0.0.1, *.vercel.app and *.framer.app previews, app subdomains) with each one's share; no key events set up; automatic events (page_view, session_start, first_visit, user_engagement, scroll) marked as key events; app and sign-in traffic mixed into the site (referrals from accounts.google.com or login hosts, app paths as landing pages); and a high share of "(not set)" landing pages. Returns suggested_filters.hostname to pass to the other reports.

REST: GET /api/v1/workspaces/{workspace_id}/analytics/health or POST /api/v1/tools/get_tracking_health

5 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
hostnamestringNoThe real site's hostnames, when the GA data stream does not say (comma-separate; *.example.com allowed). Default: from the data stream, then Search Console.
curl · POST /api/v1/tools/get_tracking_health
curl -X POST https://auli.ai/api/v1/tools/get_tracking_health \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_analytics_portfolio

Read only

Headline GA4 and Search Console numbers for every workspace you can reach (an access key limited to chosen workspaces covers only those), each with the previous period and a zero-filled daily series. Use hostname=auto to count only each workspace's own site. Workspaces without analytics say so instead of failing the call.

REST: GET /api/v1/analytics/portfolio or POST /api/v1/tools/get_analytics_portfolio

7 arguments
ArgumentTypeRequiredDescription
periodstringNoA named period. Default 28d. Ignored when start_date or end_date is given.today, yesterday, 7d, 14d, 28d, 30d, 90d, 180d, 365d, this_month, last_month, this_quarter, last_quarter, this_year, last_year
start_datestringNoYYYY-MM-DD. Default: from period.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
comparebooleanNoAlso return the previous period of the same length and the change. Default true.
hostnamestringNoauto: count only each workspace's own site in GA (from its data stream or Search Console). Default: every hostname.auto
include_healthbooleanNoAlso return each workspace's tracking health status and failing checks. Default false.
workspace_idsstringNoOnly these workspaces (comma-separated ids). Default: all you can reach.
curl · POST /api/v1/tools/get_analytics_portfolio
curl -X POST https://auli.ai/api/v1/tools/get_analytics_portfolio \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Outreach

get_gtm_report

Read only

Outreach results for a date range: funnel (invited, accepted, replied, meetings), campaigns, senders, inbox, pipeline and CRM sync.

REST: GET /api/v1/workspaces/{workspace_id}/gtm-report or POST /api/v1/tools/get_gtm_report

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
start_datestringNoYYYY-MM-DD. Default: 30 days ago.
end_datestringNoYYYY-MM-DD, inclusive. Default: today.
curl · POST /api/v1/tools/get_gtm_report
curl -X POST https://auli.ai/api/v1/tools/get_gtm_report \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

list_campaigns

Read only

Campaigns in a workspace with status and how many contacts are in each state.

REST: GET /api/v1/workspaces/{workspace_id}/campaigns or POST /api/v1/tools/list_campaigns

1 argument
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
curl · POST /api/v1/tools/list_campaigns
curl -X POST https://auli.ai/api/v1/tools/list_campaigns \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_campaign

Read only

One campaign's sequence (steps and message texts) and progress: contacts per step and status, sends, replies and accepted invitations.

REST: GET /api/v1/workspaces/{workspace_id}/campaigns/{campaign_id} or POST /api/v1/tools/get_campaign

2 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
campaign_idstringYes
curl · POST /api/v1/tools/get_campaign
curl -X POST https://auli.ai/api/v1/tools/get_campaign \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","campaign_id":"<campaign_id>"}'

search_contacts

Read only

Find contacts by name, email or company. Returns ids for other tools.

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
querystringNoName, email or company. Empty lists recent contacts.
limitnumberNoMax 50, default 20.
curl · POST /api/v1/tools/search_contacts
curl -X POST https://auli.ai/api/v1/tools/search_contacts \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

list_conversations

Read only

Inbox conversations, newest first. Filter to unread or by reply label.

4 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
unread_onlybooleanNo
labelstringNointerested, not_interested, meeting_booked, out_of_office, referral, …
limitnumberNoMax 50, default 20.
curl · POST /api/v1/tools/list_conversations
curl -X POST https://auli.ai/api/v1/tools/list_conversations \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>"}'

get_conversation

Read only

All messages in one inbox conversation, oldest first, plus scheduled replies.

2 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
conversation_idstringYes
curl · POST /api/v1/tools/get_conversation
curl -X POST https://auli.ai/api/v1/tools/get_conversation \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","conversation_id":"<conversation_id>"}'

Changes data

send_reply

Changes data · write keySends a message

Sends a reply in an inbox conversation right away, on its channel (LinkedIn message or email) from the connected account. Confirm the text with the user first.

4 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
conversation_idstringYes
bodystringYes
subjectstringNoEmail only; defaults to Re: the thread subject.
curl · POST /api/v1/tools/send_reply
curl -X POST https://auli.ai/api/v1/tools/send_reply \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","conversation_id":"<conversation_id>","body":"…"}'

schedule_reply

Changes data · write keySends a message

Schedules a reply in an inbox conversation for a later time (sent within 5 minutes of it). Use an ISO 8601 time with offset, e.g. 2026-11-10T09:00:00-05:00.

6 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
conversation_idstringYes
bodystringYes
send_atstringYesISO 8601 with offset.
time_zonestringNoIANA zone to show it in, e.g. Europe/Istanbul.
subjectstringNo
curl · POST /api/v1/tools/schedule_reply
curl -X POST https://auli.ai/api/v1/tools/schedule_reply \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","conversation_id":"<conversation_id>","body":"…","send_at":"…"}'

enroll_contacts

Changes data · write keySends a message

Adds contacts to a campaign. Contacts already active in another campaign are skipped. In an active campaign they start within minutes.

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
campaign_idstringYes
contact_idsstring[]Yes
curl · POST /api/v1/tools/enroll_contacts
curl -X POST https://auli.ai/api/v1/tools/enroll_contacts \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","campaign_id":"<campaign_id>","contact_ids":["…"]}'

set_campaign_status

Changes data · write key

Pauses an active campaign or resumes a paused one. Launching a draft is done in the Auli app.

3 arguments
ArgumentTypeRequiredDescription
workspace_idstringYesWorkspace id from list_workspaces.
campaign_idstringYes
statusstringYespaused, active
curl · POST /api/v1/tools/set_campaign_status
curl -X POST https://auli.ai/api/v1/tools/set_campaign_status \
  -H "Authorization: Bearer $AULI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id":"<workspace_id>","campaign_id":"<campaign_id>","status":"…"}'
Errors

Errors say what to fix.

json · every error has this shape
{
  "error": {
    "type": "invalid_request",
    "message": "Unknown query parameter \"contry\" for /workspaces/{workspace_id}/analytics/web/{report}. Allowed: period, start_date, end_date, compare, limit, country, …",
    "docs": "https://auli.ai/docs/api#endpoints"
  }
}
StatusTypeMeaning
400invalid_requestAn argument is missing or malformed, or a query parameter is unknown. The message names it and lists what is allowed.
400invalid_jsonThe request body is not valid JSON.
400tool_errorThe tool ran but could not answer.
401unauthorizedNo key or token, or it is unknown, revoked or expired. An expired key says so.
403forbiddenYou are not a member of that workspace, the key is limited to other workspaces, or the action needs an owner or admin.
403insufficient_scopeThe tool changes data and the key is read-only.
404not_foundNo such endpoint, tool or report. A wrong report name lists the real ones.
405method_not_allowedWrong HTTP method. The message says which to use.

Google's own errors come through in plain words, prefixed with the source, for example Google Analytics: Field fooBar is not a valid dimension. Over MCP, a failed tool returns isError: true with the same message, so the assistant can correct its call.

Security & limits

What a key can and can't do.

  • A key never sees more than you can, and only in the workspaces it was given.
  • Keys never carry admin-wide access. Expired and revoked keys stop working at once.
  • All analytics tools only read. They use the workspace's Google connection; Google credentials never leave Auli.
  • Tools that send messages or change campaigns are recorded in the workspace audit log with the key that called them.
  • Keep keys out of code and repositories. Keys start with auli_pat_, so secret scanners can spot one that leaks; revoke it in Team → API & MCP.
  • Reports query Google live. Allow up to a minute for large ranges, and expect Google's per-property quotas: if one is used up, wait a minute and retry.
  • Search Console keeps 16 months of data; GA4 keeps what the property's retention setting allows.
Changelog

What changed, and when.

DateVersionChange
2026-11-191.2Summary endpoint (GA4 and Search Console in one call), tracking health checks, and a portfolio call across every workspace a key reaches. The hostname filter takes several hosts and *.domain. Daily series have one row per day, with zeros for days Google leaves out.
2026-11-191.1Full GA4 and Search Console coverage: 29 web reports, 9 search reports, custom GA4 reports and Search Analytics queries, realtime, GA4 fields, search opportunities, URL inspection and sitemaps. Named periods. Keys can be limited to chosen workspaces, expire, and never carry admin-wide access. Unknown query parameters are refused.
2026-11-191.0Personal access keys with read and write scopes. REST API v1 with resource routes, tool calls and an OpenAPI spec. MCP accepts access keys. Distribution report.