API Reference

Index of every endpoint in the AIclicks API v1.

Every endpoint below is GET, mounted under /api/v1/, and returns the standard envelope. Click through for parameters, response shape, and worked examples.

Authentication

Endpoint	Purpose
`GET /validate`	Confirm a key works and inspect its scope (teams, allowed domains, rate-limit state).

Domains

Endpoint	Purpose
`GET /domains`	List domains the caller's key can access. Returns the `domain_id` values used elsewhere.

Prompts

Endpoint	Purpose
`GET /prompts`	Tracked prompts for a domain, with per-prompt aggregates.
`GET /prompt-statistics-time-series`	Top-N prompts by mentions, each with a daily series of mentions / responses / citations / avg position, plus `estimated_search_volume` — which prompts gained or dropped.
`GET /fanout-queries`	Grounding queries the LLM generated while answering a prompt.

Competitor

Endpoint	Value	Purpose
`GET /brand-rankings`	list	Snapshot share-of-voice ranking: the brand vs. its tracked competitors.
`GET /competitor-time-series`	list	The trend version — daily visibility / SOV / position per competitor (plus the brand).
`GET /competitor-discovery`	list	Untracked brands appearing in your prompts' answers, ranked by prompts mentioned — who to start tracking.

Brand Analytics

Endpoint	Value	Purpose
`GET /mentions-time-series`	int	Daily raw count of brand mentions across all responses.
`GET /visibility-time-series`	%	Daily visibility — share of LLM responses that mention the brand.
`GET /model-leaderboard`	list	Per-AI-channel visibility and average position — which models surface the brand.

Citations

Endpoint	Value	Purpose
`GET /citations-time-series`	int	Daily raw count of citations to the brand domain.
`GET /citability-time-series`	%	Daily share-of-citations — brand's slice of all citations made that day.
`GET /citations`	list	URL-level view: every page the domain appears in, with frequency, mentions, prompt count, `prompt_ids`, and models.

Sentiment Analysis

How AI answers feel about the brand, and what drives it. All accept an optional model filter (generic channel name).

Endpoint	Value	Purpose
`GET /sentiment/overview`	%	Positive vs. negative split across the window, plus total mentions.
`GET /sentiment/themes`	list	Named themes AI answers raise, each tagged positive or negative.
`GET /sentiment/time-series`	%	Daily positive-sentiment percentage.
`GET /sentiment/theme-sources`	list	URLs cited when raising those themes, rolled up by frequency.

AI Traffic (GA4)

Real site traffic referred by AI assistants, read from the domain's connected Google Analytics 4 property and filtered to LLM/AI sources — the did AI visibility turn into visitors? side. All accept an optional llm_source filter and return empty/zeroed views (not an error) when the domain has no GA4 connection.

Endpoint	Value	Purpose
`GET /ga4/summary`	object	Totals of AI-referred sessions/users/pageviews, plus the previous period.
`GET /ga4/timeline`	list	Daily AI-referred sessions, each day split by LLM source.
`GET /ga4/by-llm`	object	Those totals broken out per LLM source, plus the previous period.
`GET /ga4/key-events`	object	Conversions attributed to AI-referred traffic — total, per-LLM, top events, plus previous total.
`GET /ga4/top-pages`	list	Pages ranked by AI-referred sessions.
`GET /ga4/top-locations`	list	AI-referred sessions by country.
`GET /ga4/devices`	list	AI-referred sessions by device category.
`GET /ga4/top-browsers`	list	AI-referred sessions by browser (top 10).

Required parameters

Most endpoints accept ?domain_id=<uuid> as a required query parameter. If you don't yet have a domain ID, call GET /domains first.

/validate is the only endpoint that takes no query parameters.

Common response shape

All endpoints share the same envelope (data, generated_at, echoed params) and the same rate-limit / cache headers — see Overview and Rate Limits for the full spec.

Was this page helpful?