API DocumentationIntroduction

Introduction

Welcome to the AIclicks API.

The AIclicks API gives you programmatic access to the same AI-search analytics data that powers the dashboard: visibility, share-of-voice, citations, prompts, topics, and competitors across ChatGPT, Claude, Perplexity, Gemini, and other AI assistants.

The API is read-only and export-shaped. You can pull data into your warehouse, BI tool, or custom dashboards. There are no write endpoints, no automation hooks, no webhooks.

API Versions

We currently support one version:

  • API v1 — stable. Mounted under /api/v1/. Additive changes only — we may add new fields without warning but will not remove or rename fields without a deprecation window.

Quick Start

  1. Get your API key. Open the dashboard and navigate to Settings → Developers. Click Create API Key.

  2. Validate it. Hit GET /api/v1/validate to confirm the key works and see its scope (teams, allowed domains, rate limit).

  3. List your domains. Hit GET /api/v1/domains to get the domain_id you'll pass to every other endpoint.

  4. Pull data. Use the API Reference to find the endpoint you need.

Base URL

https://api.aiclicks.io

All endpoint paths in this reference are appended to this base.

Authentication

Every request must include your API key in the Authorization header as a Bearer token:

curl -X GET "https://api.aiclicks.io/api/v1/domains" \
  -H "Authorization: Bearer ak_live_your-api-key-here"

Keys are scoped to one team. They inherit the allowed_domains allowlist of the user who created the key, and the team's developer_access flag must be enabled.

Conventions

  • Envelope: every response has a top-level data field and a generated_at ISO-8601 timestamp.

  • Pagination: list endpoints use page (1-indexed) and size (default 25, max 100). Iterate until page > total_pages.

  • Dates: use days=<N> (last N days, max 90) or timeframe=<preset> (7d, 30d, 90d, etc.).

See the Overview page for the full conventions reference (caching, rate limits, errors, headers).

Support

Need help? Contact us at support@aiclicks.io.

When reporting an issue, include the X-Request-Id header value from the failing response — it lets us find your request in our logs.

Next Steps

  • Read the Overview for envelopes, pagination, caching, errors, and rate limits.

  • Hit GET /validate first to confirm your key works.

Was this page helpful?