add_competitor
ChatGPTTrack a new competitor for a domain, using the competitor identity the user has specified. By default (is_dedicated=true) the competitor is added to the tracked list: actively analyzed and counted against the plan's dedicated-competitor limit. is_dedicated=false adds a passive discovery entry that isn't actively tracked. Requires membership of the domain's team on a Pro+ plan. Fails (error in payload) if the competitor already exists or the dedicated-competitor limit is reached. It can take a while for a new competitor to appear in the aiclicks dashboard (it caches for ~30 min).
add_prompt
ChatGPTAdd a prompt/query the user wants tracked to a domain, optionally with topics and tags. topic_ids/tag_ids are UUIDs (not names), resolvable via list_topics / list_tags; only existing tags/topics can be attached (there is no create-tag/topic tool). A prompt consumes one of the team's prompt credits. Requires the caller to be a member of the domain's team, on a Pro+ plan. Fails (error in payload) on a duplicate prompt or when the team is out of prompt credits. It can take a while for a new prompt to appear in the aiclicks dashboard (it caches for ~30 min).
create_domain
ChatGPTCreate 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).
get_brand_rankings
ChatGPTCurrent share-of-voice ranking for the domain vs. its tracked competitors.
get_chatgpt_ads_cards
ChatGPTIndividual ChatGPT ad cards (creatives/advertisers) seen for the domain's prompts over the past days days, paginated.
get_chatgpt_ads_kpis
ChatGPTHeadline ChatGPT-ads metrics for the domain over the past days days. Returns prompts with ads, brand appearances, unique advertisers, and total ad cards seen, each with a delta vs the previous equal-length window.
get_chatgpt_ads_leaderboard
ChatGPTBrands advertising on ChatGPT for the domain's prompts over the past days days, ranked by how many prompts they appear in (coverage).
get_chatgpt_ads_prompts
ChatGPTTracked prompts that triggered ChatGPT ads over the past days days, paginated.
get_chatgpt_ads_timeline
ChatGPTDaily ChatGPT-ads activity for the domain over the past days days — the ads trend.
get_citability_time_series
ChatGPTDaily citability score — how often the domain's URLs are cited (not just mentioned).
get_citations
ChatGPTURL-level citations the domain appears in across AI search results — page type, citation frequency (primary ranking metric), aggregate mentions, prompt count, models. Sorted by frequency desc. Each row also carries prompt_ids: the tracked prompts whose responses cited that URL — resolve them to text and search volume via list_prompts.
get_citations_time_series
ChatGPTDaily citation count for the domain (URLs from this domain appearing in AI answers).
get_competitor_discovery
ChatGPTCompetitors 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_time_series
ChatGPTDaily 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_ga4_by_llm
ChatGPTAI-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_devices
ChatGPTAI-referred traffic by device category (mobile/desktop/tablet) — device + sessions.
get_ga4_key_events
ChatGPTGA4 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_summary
ChatGPTTotals of AI-referred traffic from GA4 over the window — sessions, users, pageviews — plus the previous period's totals for delta comparison.
get_ga4_timeline
ChatGPTDaily AI-referred sessions over the window, each day broken down by LLM source. Use for trend/time-series of AI-driven traffic.
get_ga4_top_browsers
ChatGPTAI-referred traffic by browser — browser + sessions, top 10 sorted desc.
get_ga4_top_locations
ChatGPTAI-referred traffic by country/location — location + sessions, sorted desc.
get_ga4_top_pages
ChatGPTWhich pages pull the most AI-referred traffic — page_path + sessions, sorted desc. The 'which content wins AI visitors' view.
get_mentions_time_series
ChatGPTDaily mention count for the domain (brand name appearing in AI responses).
get_model_leaderboard
ChatGPTPer-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_prompt_statistics
ChatGPTPer-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_sentiment_overview
ChatGPTPositive/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_theme_sources
ChatGPTURLs 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_time_series
ChatGPTDaily 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_visibility_time_series
ChatGPTDaily 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.
list_competitors
ChatGPTList the competitors tracked for one domain, optionally filtered by dedicated/active.
list_domains
ChatGPTList 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_fanout_queries
ChatGPTList 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_prompts
ChatGPTList 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_sentiment_themes
ChatGPTThemes 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_tags
ChatGPTList 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_topics
ChatGPTList 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.
validate_key
ChatGPTValidate 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.
add_competitor
Claudeadd_prompt
Claudecreate_domain
Claudeget_brand_rankings
Claudeget_chatgpt_ads_cards
Claudeget_chatgpt_ads_kpis
Claudeget_chatgpt_ads_leaderboard
Claudeget_chatgpt_ads_prompts
Claudeget_chatgpt_ads_timeline
Claudeget_citability_time_series
Claudeget_citations
Claudeget_citations_time_series
Claudeget_competitor_discovery
Claudeget_competitor_time_series
Claudeget_ga4_by_llm
Claudeget_ga4_devices
Claudeget_ga4_key_events
Claudeget_ga4_summary
Claudeget_ga4_timeline
Claudeget_ga4_top_browsers
Claudeget_ga4_top_locations
Claudeget_ga4_top_pages
Claudeget_mentions_time_series
Claudeget_model_leaderboard
Claudeget_prompt_statistics
Claudeget_sentiment_overview
Claudeget_sentiment_theme_sources
Claudeget_sentiment_time_series
Claudeget_visibility_time_series
Claudelist_competitors
Claudelist_domains
Claudelist_fanout_queries
Claudelist_prompts
Claudelist_sentiment_themes
Claudelist_tags
Claudelist_topics
Claudevalidate_key
Claude
