AIclicks

Daily citation count for the domain (URLs from this domain appearing in AI answers).

get_citations_time_series

Competitors that show up in AI answers to your prompts but you AREN'T tracking yet. Detected (non-dedicated) brands mentioned alongside you, ranked by how many of your prompts mention them (`prompts_mentioned` out of `total_prompts`). Use to find rivals worth adding to tracking. Distinct from get_brand_rankings, which only covers already-tracked competitors.

get_competitor_discovery

Daily visibility / share-of-voice / position per tracked competitor (plus the brand) over time. The trend version of get_brand_rankings: each entry (brand first, then competitors) has a `series` of daily {visibility, sov, mentions, avg_position, sentiment} plus window averages. Use for "how is competitor X trending vs us?" questions.

get_competitor_time_series

Create a new brand (domain) with the prompts that will be tracked. Creation is not reversible through this API, and the prompts drive all subsequent analysis. Requires prompts the user has supplied or approved, passed as `prompts` (each {"text": str, "topics"?: [str], "tags"?: [str]}). `generate_prompts=true` is a fallback where the backend picks prompts server-side; those are not returned for the user to review, so it applies only when the user has opted out of reviewing them. A brand with no prompts is rejected (400): a non-empty `prompts` list OR `generate_prompts=true` is required. Also requires the caller to be a member of `team_id`, on a Pro+ plan, and within the team's domain limit. Returns the created domain. Results can take a while to appear in the aiclicks dashboard (it caches for ~30 min).

create_domain

AI-referred traffic broken out per LLM source (ChatGPT, Perplexity, Claude, Gemini…) — sessions/users/pageviews each — plus the previous period, to see which assistants actually send visitors.

get_ga4_by_llm

AI-referred traffic by device category (mobile/desktop/tablet) — device + sessions.

get_ga4_devices

GA4 key events / conversions attributed to AI-referred traffic — total, per-LLM breakdown, and top events — plus the previous period's total. The 'did AI traffic convert?' view.

get_ga4_key_events

Totals of AI-referred traffic from GA4 over the window — sessions, users, pageviews — plus the previous period's totals for delta comparison.

get_ga4_summary

Daily AI-referred sessions over the window, each day broken down by LLM source. Use for trend/time-series of AI-driven traffic.

get_ga4_timeline

AI-referred traffic by browser — browser + sessions, top 10 sorted desc.

get_ga4_top_browsers

AI-referred traffic by country/location — location + sessions, sorted desc.

get_ga4_top_locations

Which pages pull the most AI-referred traffic — page_path + sessions, sorted desc. The 'which content wins AI visitors' view.

get_ga4_top_pages

List the competitors tracked for one domain, optionally filtered by dedicated/active.

list_competitors

List every aiclicks domain (brand) the caller's API key can read. **Always call this first** — every other tool needs a `domain_id` from the response. The response shape depends on the key type (check `validate_key` if unsure): - **Team key** (scoped to one team): `data.items` is a flat array of domains — `{id, name, website, created_at}`. Every domain belongs to the key's single team. - **Master key** (spans all the user's teams): `data.items` is an array of teams, each `{team_id, team_name, domains: [{id, name, website, created_at}]}`. Read the `domain_id` from `items[].domains[]`, and use `team_name` to tell which team a domain belongs to. Detect which you got: if an item has a `domains` array it's a team group (master key); otherwise items are domains directly (team key).

list_domains

List the fanout (expanded) queries derived from the domain's prompts. Fanout queries are the broader set of question variants the discovery pipeline runs against AI search engines on top of the seed prompts. Useful to see what the search graph looks like beyond the user's curated prompt list.

list_fanout_queries

List the prompts/queries tracked for one domain. Each prompt is a search query aiclicks runs against AI search engines to see whether the brand shows up. Results are paginated; default page size is 50.

list_prompts

List the tags defined for a domain, each with its UUID and name. Use this to resolve tag names to the `tag_ids` that add_prompt expects. add_prompt takes UUIDs, not names — there is no create-tag tool, so only existing tags can be attached.

list_tags

List the topics defined for a domain, each with its UUID and name. Use this to resolve topic names to the `topic_ids` that add_prompt expects. add_prompt takes UUIDs, not names — there is no create-topic tool, so only existing topics can be attached.

list_topics

Daily mention count for the domain (brand name appearing in AI responses).

get_mentions_time_series

Per-AI-model breakdown of how often the domain appears. Tells you whether ChatGPT, Perplexity, AI Overviews, etc. surface this brand at different rates over the window.

get_model_leaderboard

Per-prompt performance over time — which tracked prompts win or lose the brand visibility. Returns the top `limit` prompts (by total mentions), each with its `estimated_search_volume` and a daily `series` of `mentions`, `responses`, `citations`, and `avg_position`. Use for "which prompts gained/dropped the most" questions.

get_prompt_statistics

Positive/negative sentiment split for how AI answers talk about the domain. Returns positive_percent, negative_percent, and total_mentions across the window. Use for "how do LLMs feel about my brand right now?" questions.

get_sentiment_overview

URLs the AI answers cite when raising sentiment themes about the domain. Returns each cited URL with its domain, citation frequency, the themes it appears under, and the models that cited it (sorted by frequency desc). Use to find which pages shape how LLMs talk about the brand.

get_sentiment_theme_sources

Themes AI answers raise about the domain, each tagged positive or negative. Returns theme name, sentiment, and occurrence count (sorted by occurrences desc). Use to see *what* drives sentiment — e.g. "pricing" negative, "support" positive.

list_sentiment_themes

Daily positive-sentiment percentage for the domain over the past `days` days. Each point is the share of that day's sentiment themes that are positive. Use to see whether brand sentiment in AI answers is trending up or down.

get_sentiment_time_series

Validate the caller's aiclicks API key and return the team(s) it can access. Call this once at the start of a session to confirm the key is healthy and to learn the team name(s). A team key reports one team; a master key reports every team the user belongs to. Returns 401-style error inside the response payload if the key is invalid.

validate_key

Daily visibility share for the domain over the past `days` days. Visibility = share of tracked AI-search responses that cite the domain. Use this for "is my brand showing up more or less lately?" questions.

get_visibility_time_series