Skip to main content
Quick Answer: The FAII API lets you access all your monitoring data programmatically. Available on Professional and Enterprise plans. Use it for custom dashboards, automated reporting, or integration with other tools.

​
What You’ll Learn

  • What the API provides
  • How to authenticate
  • Available endpoints
  • Rate limits and best practices

​
API Availability

​
Authentication

​
API Key

  1. Go to Account > API in your dashboard
  2. Click Generate API Key
  3. Copy the key (shown once)
  4. Use in the Authorization header:
Keep your API key secret. Don’t commit it to code repositories, share in public channels, or expose in client-side code. Treat it like a password.

​
Regenerating keys

If your key is compromised:
  1. Go to Account > API
  2. Click Regenerate Key
  3. Old key is immediately invalidated
  4. Update all integrations with the new key

​
Available Endpoints

​
Campaign Data

​
Intelligence Data

​
AI Website Analytics

​
Technical Audit

​
Response Format

All responses are JSON:

​
Error responses

​
Common Use Cases

​
Custom dashboards

Build your own visualization of FAII data:
  • Pull score data into Tableau or Data Studio
  • Create client-specific dashboard views
  • Combine with other marketing metrics

​
Automated reporting

Generate reports on your schedule:
  • Pull data and format as PDF/email
  • Send weekly summaries to stakeholders
  • Integrate with Slack or Teams notifications

​
CI/CD integration

Monitor AI visibility as part of your development workflow:
  • Check technical audit grade in CI pipeline
  • Alert on score drops after deployments
  • Track content impact after publishes

​
Multi-client management

For agencies with multiple campaigns:
  • Aggregate data across all clients
  • Build white-label portals
  • Automate client reporting

​
Rate Limits

​
Handling rate limits

When rate limited, the API returns:
  • HTTP 429 status code
  • Retry-After header with seconds to wait
  • Error message in response body
Best practices:
  • Cache responses when possible
  • Use webhooks instead of polling (Enterprise)
  • Batch requests where possible
  • Implement exponential backoff

​
Webhooks (Enterprise)

Instead of polling the API, receive notifications: Configure webhooks in Account > API > Webhooks.

​
Tips

  • Start with the score endpoint - Simplest way to verify your integration works
  • Cache aggressively - Data only changes after sessions run (weekly)
  • Use pagination - Large data sets return paginated results
  • Monitor your usage - Check rate limit headers in responses
  • Secure your key - Use environment variables, never hardcode

Usage Limits

Understanding plan limits

Account Settings

Manage your account