Metrics API

Query analytics metrics, bot visits, and traffic data programmatically.

List Websites

Get all websites associated with your account.

GET/api/v1/websites

curl -X GET https://aisearchindex.com/api/v1/websites \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "success": true,
  "data": {
    "websites": [
      {
        "id": "ws_xxxxx",
        "domain": "example.com",
        "tracking_id": "t_xxxxx",
        "created_at": "2024-01-01T00:00:00Z"
      }
    ]
  }
}

Get Traffic Summary

Get a summary of traffic for a specific website.

GET/api/v1/websites/:id/summary

curl -X GET "https://aisearchindex.com/api/v1/websites/ws_xxxxx/summary?period=last_7_days" \
  -H "x-api-key: YOUR_API_KEY"

Query Parameters

Parameter	Type	Description
period	string	today, yesterday, last_7_days, last_30_days, this_month, last_month
start_date	string	Custom start date (YYYY-MM-DD)
end_date	string	Custom end date (YYYY-MM-DD)

Response

{
  "success": true,
  "data": {
    "total_visits": 15234,
    "bot_visits": 1847,
    "human_visits": 13387,
    "ai_bot_visits": 523,
    "period": {
      "start": "2024-01-01",
      "end": "2024-01-07"
    }
  }
}

Get Bot Visits

Get detailed bot visit data grouped by bot type.

GET/api/v1/websites/:id/bots

curl -X GET "https://aisearchindex.com/api/v1/websites/ws_xxxxx/bots?period=last_7_days" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "success": true,
  "data": {
    "bots": [
      {
        "name": "GPTBot",
        "provider": "OpenAI",
        "visits": 234,
        "pages_visited": 156,
        "category": "ai_search"
      },
      {
        "name": "ClaudeBot",
        "provider": "Anthropic",
        "visits": 189,
        "pages_visited": 98,
        "category": "ai_search"
      }
    ]
  }
}

Get Top Pages

Get the most visited pages by bots.

GET/api/v1/websites/:id/pages

curl -X GET "https://aisearchindex.com/api/v1/websites/ws_xxxxx/pages?period=last_7_days&limit=10" \
  -H "x-api-key: YOUR_API_KEY"

Response

{
  "success": true,
  "data": {
    "pages": [
      {
        "path": "/",
        "bot_visits": 156,
        "human_visits": 1234
      },
      {
        "path": "/blog/ai-search-guide",
        "bot_visits": 89,
        "human_visits": 456
      }
    ]
  }
}

Get Time Series Data

Get bot visits over time for trend analysis.

GET/api/v1/websites/:id/timeseries

curl -X GET "https://aisearchindex.com/api/v1/websites/ws_xxxxx/timeseries?period=last_30_days&interval=day" \
  -H "x-api-key: YOUR_API_KEY"

Query Parameters

Parameter	Type	Description
interval	string	hour, day, week, month

Response

{
  "success": true,
  "data": {
    "series": [
      {
        "date": "2024-01-01",
        "total_visits": 523,
        "bot_visits": 67,
        "ai_bot_visits": 23
      },
      {
        "date": "2024-01-02",
        "total_visits": 489,
        "bot_visits": 54,
        "ai_bot_visits": 19
      }
    ]
  }
}