API Access

Waikay API

Programmatic access to your brand visibility data across ChatGPT, Claude, Gemini, and Sonar (Perplexity). Integrate directly into your reporting workflows, automation systems, and BI tools.

Available on Level 2 plans and above ($69.95/month) Standard JSON responses Credits required per call

Overview Capabilities Use Cases Integration Getting Started

Overview

The Waikay API provides programmatic access to your brand visibility data across major LLMs. Rather than manually exporting data from the dashboard, you can integrate directly into your existing reporting workflows, automation systems, and tools like Looker Studio or n8n.

The API is available to users on Level 2 plans and above ($69.95/month). It provides two endpoints that let you list projects and pull brand visibility metrics at both the project and prompt levels.

For complete technical specifications, authentication details, and request/response examples, refer to the official API documentation.

API Capabilities

The API currently provides access to three types of brand visibility data.

Data Type	What It Returns	Time Window
Overview	Brand mention counts by model and timeframe, including JSON versions of Topic Action Plans	7-day windows (current vs previous week)
Rankings	Share of voice and competitive positioning	30-day rolling window
Sources	Citation analysis showing which URLs and domains are being referenced	30-day rolling window

Data can be retrieved at project level (aggregated across all prompts) or filtered to specific prompts for granular analysis.

Practical Use Cases

Automated Competitive Intelligence Dashboards

Pull rankings data weekly and feed it into your BI tool for always-on competitive visibility.

Challenge Understanding how your visibility compares to competitors across LLMs requires constant monitoring. Manual checks do not scale.

Endpoint rankings – returns share of voice percentages, brand occurrence counts, and competitive positioning.

Implementation Set up a scheduled script via GitHub Actions, Zapier, Make, or n8n to pull data every Monday and push to Google Sheets, Looker Studio, or your BI platform.

Citation Gap Analysis

Identify authoritative sources that cite your competitors but not you.

Endpoint sources – returns domains citing your brand, citation counts per domain, breakdown by LLM, and specific URLs referenced.

Implementation Cross-reference against your content distribution list. Build a script that flags any new high-citation domain (more than 10 citations) appearing in competitor data but not yours.

Prompt Performance Tracking

Monitor individual prompt performance over time as an early warning system for visibility drops.

Endpoint overview filtered by prompt ID – returns weekly mention counts per model, week-over-week changes, and historical performance.

Implementation Track 10 to 20 critical prompts. Flag any where mentions drop by more than 20% week-over-week as an early warning for visibility degradation on specific topics.

Model-Specific Strategy

Analyse performance by individual model to identify optimisation opportunities missed by a one-size-fits-all approach.

Endpoints overview and sources – both break down data by model: Gemini, ChatGPT, Claude, and Sonar.

Implementation If you are being cited heavily by Claude but rarely by ChatGPT, investigate the source difference. Use this to inform content strategy and distribution decisions by model.

Client Reporting Automation

Eliminate manual data collection for agency client reports entirely.

Endpoints rankings and sources pulled programmatically per client project.

Implementation Use Google Apps Script to pull data into Google Sheets on a schedule, feeding automated Looker Studio dashboards. Combine with GA4, GSC, and social metrics for a full picture.

Historical Tracking Database

Build a complete long-term record beyond the dashboard’s retention window.

Implementation Set up a daily or weekly job to pull all relevant data into your data warehouse (PostgreSQL, BigQuery, Snowflake). Gives you unlimited history, custom retention periods, and the ability to join with other data sources. Particularly valuable for tracking the impact of content campaigns and PR efforts over months or years.

Integration Approach

Project-Level vs Prompt-Level

All brand visibility queries work at both levels:

Level	How	Best For
Project-level	Omit the prompt parameter	High-level dashboards, executive summaries
Prompt-level	Include the prompt ID parameter	Granular analysis, per-query performance tracking

Time Windows

Be aware of the different time windows when planning your automation schedule.

Endpoint	Window	Recommended Pull Frequency
Overview	7-day (current vs previous week)	Daily
Rankings	30-day rolling	Weekly
Sources	30-day rolling	Weekly

Authentication and Credits

Your API key is available in your Waikay account settings. All requests require this key as a query parameter. API calls cost credits which must be purchased in advance, either as part of your monthly subscription or in batches of 40 or 80 units.

Rate limits may apply based on your Waikay plan. Consult the API documentation for current limits and credit costs per endpoint.

Getting Started

Review the full API documentation to understand the request and response structure.

Retrieve your API key from your Waikay account settings.

Use the projects endpoint to get your project IDs.

Test with a simple curl command or API client like Postman.

Build your integration using your preferred language or platform. The API returns standard JSON, making it simple to integrate with any modern data stack.

Ready to integrate?

Complete request examples, response schemas, and the OpenAPI specification are in the official documentation.

View API Documentation