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 Plan API Access Rate Limit Starter ❌ N/A Professional ✅ 100 requests/hour Enterprise ✅ 1,000 requests/hour
Authentication API Key
Go to Account > API in your dashboard
Click Generate API Key
Copy the key (shown once)
Use in the Authorization header:
Authorization: Bearer your-api-key-here
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:
Go to Account > API
Click Regenerate Key
Old key is immediately invalidated
Update all integrations with the new key
Available Endpoints Campaign Data Endpoint Method Returns /api/campaignsGET List all campaigns /api/campaigns/{id}GET Campaign details /api/campaigns/{id}/sessionsGET All session data /api/campaigns/{id}/keywordsGET Keyword list and performance /api/campaigns/{id}/competitorsGET Competitor data
Intelligence Data Endpoint Method Returns /api/campaigns/{id}/chatGET Chat Intelligence results /api/campaigns/{id}/serpGET SERP Intelligence results /api/campaigns/{id}/scoreGET AI Authority Rank and components /api/campaigns/{id}/gapsGET Publishing opportunities
AI Website Analytics Endpoint Method Returns /api/analytics/bot-visitsGET Bot visit data /api/analytics/pagesGET Page-level analytics
Technical Audit Endpoint Method Returns /api/audit/latestGET Most recent audit results /api/audit/historyGET All audit results
All responses are JSON:
{ "status" : "success" , "data" : { "campaign_id" : "abc-123" , "score" : 52 , "components" : { "chat" : 48 , "serp" : 55 , "sentiment" : 62 , "competitive" : 45 }, "last_session" : "2025-01-20T06:00:00Z" } }
Error responses { "status" : "error" , "message" : "Rate limit exceeded" , "code" : 429 }
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 Plan Limit Window Professional 100 requests Per hour Enterprise 1,000 requests Per hour
Handling rate limits When rate limited, the API returns:
HTTP 429 status code
Retry-After header with seconds to waitError 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:
Event Triggered When session.completeA monitoring session finishes score.changedAI Authority Rank changes displacement.detectedCompetitive displacement occurs gap.newNew publishing opportunity identified audit.completeTechnical audit finishes
Configure webhooks in Account > API > Webhooks .
Tips
Start with the score endpoint - Simplest way to verify your integration worksCache aggressively - Data only changes after sessions run (weekly)Use pagination - Large data sets return paginated resultsMonitor your usage - Check rate limit headers in responsesSecure your key - Use environment variables, never hardcode
Related Articles
Usage Limits Understanding plan limits
Account Settings Manage your account
