Available Endpoints

This page lists all endpoints that support API key authentication. For interactive documentation and testing, visit the API Reference.

Property Information

Get Property Details

Retrieve information about your property using your API key.

GET /api/me

Headers:

• x-api-key: Your API key (required)

Response:

{
  "propertyId": "cm9ovvnnc0001wjubh0en0cpe",
  "domain": "example.com",
  "companyName": "Example Company",
  "apiKey": "sg_XXX...",
  "verified": true,
  "verifiedAt": "2025-01-01T00:00:00.000Z",
  "blockAiModelTrainers": false,
  "customBlocks": [],
  "customAllows": []
}

AI Visibility Rankings

Get AI Visibility Rankings

Retrieve prioritized grounding search opportunities from your most recent AI report.

GET /api/ai-rankings/:propertyId

Headers:

• x-api-key: Your API key (required)

Parameters:

• propertyId: Your property ID (from /api/me)

Historical Metrics

Get Brand Consistency History

Retrieve brand consistency score trends over time.

GET /api/properties/:id/historical-metrics/brand-consistency

Headers:

• x-api-key: Your API key (required)

Parameters:

• id: Your property ID

Get Discovery Metrics History

Retrieve discovery query performance trends over time.

GET /api/properties/:id/historical-metrics/discovery

Headers:

• x-api-key: Your API key (required)

Parameters:

• id: Your property ID

Get Grounding Search Metrics History

Retrieve grounding search ranking trends over time.

GET /api/properties/:id/historical-metrics/grounding-searches

Headers:

• x-api-key: Your API key (required)

Parameters:

• id: Your property ID

Query Parameters:

• onlyGaps: Set to "true" to filter to gap opportunities only

Get Competitor Share of Voice

Retrieve share of voice data for competitors from your most recent AI report.

GET /api/properties/:id/competitor-sov

Headers:

• x-api-key: Your API key (required)

Parameters:

• id: Your property ID

Get AI Visibility Rankings (Alternative)

Alternative endpoint for AI visibility rankings data.

GET /api/properties/:id/ai-visibility-rankings

Headers:

• x-api-key: Your API key (required)

Parameters:

• id: Your property ID

AI Traffic Analytics

Get AI Timeline with Trends

Retrieve AI traffic timeline data with comparison to previous period.

POST /api/analytics/ai/timeline-with-trends

Headers:

• x-api-key: Your API key (required)
• Content-Type: application/json

Body:

{
  "propertyApiKey": "sg_YOUR_API_KEY",
  "timeRange": {
    "start": "2025-01-01T00:00:00Z",
    "end": "2025-01-31T23:59:59Z"
  },
  "granularity": "day"
}

Get AI Conversion Metrics

Retrieve AI conversion metrics showing bot visits vs human visits.

POST /api/analytics/ai/conversion-metrics

Headers:

• x-api-key: Your API key (required)
• Content-Type: application/json

Body:

{
  "propertyApiKey": "sg_YOUR_API_KEY",
  "timeRange": {
    "start": "2025-01-01T00:00:00Z",
    "end": "2025-01-31T23:59:59Z"
  },
  "sessionWindowMinutes": 5
}

Get AI Traffic Summary

Retrieve AI traffic summary with breakdowns by category and referrer.

POST /api/analytics/ai/traffic-summary

Get AI Traffic Timeline

Retrieve AI traffic timeline data for charts.

POST /api/analytics/ai/timeline

Get AI Traffic Timeline by Intent

Retrieve AI traffic timeline segmented by page intent.

POST /api/analytics/ai/timeline-by-intent

Get AI Overview Visits

Retrieve visits from Google AI Overviews, Featured Snippets, and People Also Ask.

POST /api/analytics/ai/ai-overview-visits

Get Bot Types

Retrieve list of AI visitor bot types for filtering.

GET /api/analytics/ai/bot-types

Agent Analytics

Get Agent Data by Category

Retrieve analytics data for agents grouped by category.

POST /api/analytics/agent/category

Headers:

• x-api-key: Your API key (required)
• Content-Type: application/json

Body:

{
  "propertyId": "YOUR_PROPERTY_ID",
  "timeRange": {
    "start": "2025-01-01T00:00:00Z",
    "end": "2025-01-31T23:59:59Z"
  }
}

Get Agent Data by Subcategory

Retrieve analytics data for agents grouped by subcategory.

POST /api/analytics/agent/subcategory

Get Agent Data by Bot Type

Retrieve analytics data for agents grouped by bot type.

POST /api/analytics/agent/bot-type

Get Agent Data by Location

Retrieve analytics data for agents grouped by location.

POST /api/analytics/agent/location

Get Agent Data by Pages

Retrieve analytics data for agents grouped by page path.

POST /api/analytics/agent/pages

Get Live Agent Data

Retrieve real-time agent data for a property.

GET /api/analytics/agent/live/:propertyId

Get Blocked Requests Statistics

Retrieve statistics about blocked vs allowed requests.

POST /api/analytics/agent/blocked-stats

Recrawl Analytics

Get Site Recrawl Summary

Retrieve site-wide recrawl frequency statistics.

POST /api/analytics/recrawl/summary

Headers:

• x-api-key: Your API key (required)
• Content-Type: application/json

Body:

{
  "propertyId": "YOUR_PROPERTY_ID",
  "timeRange": {
    "start": "2025-01-01T00:00:00Z",
    "end": "2025-01-31T23:59:59Z"
  }
}

Get Page Recrawl Frequency

Retrieve recrawl frequency statistics for each page.

POST /api/analytics/recrawl/pages

Get Bot Recrawl Frequency

Retrieve recrawl frequency statistics for each crawler bot.

POST /api/analytics/recrawl/bots

Get Bot Page Recrawl Frequency

Retrieve recrawl frequency for pages crawled by a specific bot.

POST /api/analytics/recrawl/bots/:botTypeId/pages

Internal-Only Endpoints