CiteRank AI Logo
CiteRankAI
Integrations & API

Integrations & API Reference

Connect CiteRank to your existing marketing stack and automate data flows via our API and webhooks.

Available integrations

Each connector carries its current status. Items marked Planned are in our roadmap and not yet callable.

Beta

Google Search Console

Connect your GSC property to correlate organic search clicks with AI engine visibility.

  • Click-through data
  • Keyword performance
  • URL mapping
Beta

Google Analytics 4

Attribute AI-referred sessions alongside organic search performance.

  • Session attribution
  • Conversion events
  • Channel comparison
Available

Slack

Receive alerts when monitoring runs detect brand mentions or meaningful AI visibility shifts.

  • Brand alerts
  • Weekly summaries
  • Metric thresholds
Planned

Salesforce

Sync AI visibility metrics with account data to measure influence on revenue cycles.

  • Account attribution
  • Pipeline influence
  • Contact mapping
Planned

HubSpot

Map citation presence to marketing qualified leads and content performance.

  • MQL attribution
  • Content scoring
  • Lead enrichment
Planned

Adobe Analytics

Enterprise-grade integration for cross-channel attribution modeling.

  • Custom dimensions
  • Advanced attribution
  • Unified reporting
Planned

Segment

Stream CiteRank metrics into your entire customer data infrastructure.

  • Event streaming
  • Data warehousing
  • Multi-destination

API Reference

The Public API is currently in Private Beta. Access is restricted to Enterprise and authorized Beta customers.

API Overview

The CiteRank Public API allows you to programmatically manage prompt monitoring, retrieve visibility metrics, and trigger audits. It is a RESTful API designed for reliability and predictable scale.

Base URL

https://api.citerank.in/v1

Authentication

Bearer token authentication via the Authorization header.

Authorization: Bearer CR_...

Getting Access

To generate an API key, navigate to Settings → Developers → API Keys in your dashboard. If the menu is hidden, your plan does not currently include API access. Contact Support to request Private Beta access.

Permissions & Scopes

Keys are scoped to specific workspaces. We support two primary permissions:

  • metrics:read — Access visibility scores and citation data.
  • audits:write — Trigger new monitoring runs.

Versioning & Stability

CiteRank uses URI-based versioning. Current version is /v1. Breaking changes result in a new version path; non-breaking additions (new fields) are added to the existing version.

GET/v1/metrics

Retrieve visibility scores, citation presence, and sentiment analysis for your configured brand entities.

Required Permission

metrics:read

Query Parameters

  • project_idRequired · String
  • timeframeOptional · "24h" | "7d" | "30d"

Common Errors

  • 404 — project_id not found
  • 403 — Insufficient scope

Response Example 200 OK

{
  "visibility_score": 72.4,
  "citation_share": 0.45,
  "entities": [
    { "name": "Brand A", "score": 88 }
  ]
}
POST/v1/audits

Trigger a new autonomous monitoring run across 8 engines for a specific project.

Required Permission

audits:write

Request Body

  • project_idRequired · String

Common Errors

  • 429 — Concurrent audit limit reached
  • 400 — Invalid project format

Response Example 202 Accepted

{
  "audit_id": "audit_88234",
  "status": "queued",
  "estimated_completion": "5m"
}

Rate Limits & Retries

Standard keys are limited to 1,000 requests per hour. If exceeded, the API returns a 429 Too Many Requests. We recommend exponential backoff for retries. Check the X-RateLimit-Reset header for retry timing.

Error Handling & Pagination

All errors return a standard JSON body with code and message. For list endpoints, we use cursor-based pagination via limit and starting_after parameters.

API Security

All API requests must be made over HTTPS. API keys should be treated as secrets and never committed to version control or included in client-side code. If a key is compromised, revoke it immediately in the dashboard.

View API Status

Webhooks — Planned

Webhooks are currently on our immediate roadmap to support event-driven workflows. When released, webhooks will emit notifications for:

  • Monitoring run completion
  • Significant visibility score shifts
  • Competitor rank changes
  • Answer drift detection

Contact Support to be notified when Webhook Private Beta begins.

Need a custom integration? Our team builds bespoke connectors for Enterprise customers.

Contact Support
Run Free Audit