---
title: "Get crawl-to-visit correlation"
method: GET
path: "/api/mcp/projects/{projectId}/traffic/correlation"
tags: ["Traffic"]
---

# Get crawl-to-visit correlation

`GET /api/mcp/projects/{projectId}/traffic/correlation`

## Request

- Base URL: `https://app.searchable.com`
- URL: `https://app.searchable.com/api/mcp/projects/{projectId}/traffic/correlation`
- Auth: HTTP bearer

Per page: how often AI crawlers fetched it versus same-window AI-referred human sessions. `groupBy=platform|botCategory|botName` adds the requested crawl-side breakdown; it does not attribute sessions to a crawler. Rows are ranked by AI-referral sessions. `limit` defaults to 50, max 200.

## Path parameters

- `projectId` string, uuid, required

## Query parameters

- `days` integer
- `from` string
- `to` string
- `host` string
- `groupBy` 'platform' | 'botCategory' | 'botName'
- `limit` integer

## Response `200`

Per-page crawl and AI-referral correlation rows.

- TrafficCorrelationResponse: Per page, crawls and AI-referred sessions over the SAME window, joined by path. Co-occurrence, not attribution.
  - `groupBy` 'platform' | 'botCategory' | 'botName': Present when the request selected a crawl-side grouping.
  - `pages` object[], required
    - `path` string, required
    - `crawls` number, required
    - `lastCrawl` string, nullable, required
    - `aiReferralSessions` number, required
    - `newAiVisitors` number, required
    - `pageviews` number, required
    - `gscClicks` number, required
    - `byPlatform` TrafficCrawlerPlatformBreakdownRow[]: Present when `groupBy=platform`; crawl requests for this page grouped by platform.
      - `platform` string, required: Normalized platform/vendor key, for example `openai` or `anthropic`.
      - `visits` integer, required: Crawler requests in the selected window.
    - `byCategory` TrafficCrawlerCategoryBreakdownRow[]: Present when `groupBy=botCategory`; crawl requests for this page grouped by public bot category.
      - `botCategory` string, required: Crawler category from the dashboard-visible bot registry. Current public values are `ai_training`, `ai_search`, `ai_assistant`, `ai_agent`, and `search_engine`; the registry can grow. `ai_assistant` is the distinct user-triggered category used by ChatGPT-User, Claude-User, and Perplexity-User.
      - `visits` integer, required: Crawler requests in the selected window.
    - `byBot` TrafficCrawlerBotBreakdownRow[]: Present when `groupBy=botName`; crawl requests for this page grouped by resolved bot identity. These rows do not attribute the page's referral sessions to that bot.
      - `botId` integer, required: Stable bot registry identifier.
      - `botName` string, required: Resolved crawler name, for example `GPTBot` or `ChatGPT-User`.
      - `botVendor` string, nullable, required: Resolved crawler vendor, for example `OpenAI` or `Anthropic`.
      - `botCategory` string, required: Crawler category from the dashboard-visible bot registry. Current public values are `ai_training`, `ai_search`, `ai_assistant`, `ai_agent`, and `search_engine`; the registry can grow. `ai_assistant` is the distinct user-triggered category used by ChatGPT-User, Claude-User, and Perplexity-User.
      - `visits` integer, required: Crawler requests in the selected window.
  - `pagesConsidered` number, required: Size of the ranked population — a floor on the true page count, not a site-wide total.
  - `populationTruncated` boolean, required: True when the upstream per-set cap (500) was reached, so pages are certainly missing.
  - `dateRange` object, required
    - `from` string, date-time, required
    - `to` string, date-time, required

## Other responses

- `400`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `401`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `403`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `404`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `409`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.
- `429`: Rate limited. Usually the per-API-key REST limit (600 requests/minute); on Google-backed endpoints it can also relay an upstream Google rate limit. `Retry-After` (seconds) is present when the limit was applied by Searchable's own rate limiter; it may be absent when an upstream provider rate-limits.
- `504`: Error response. `code` is the machine-readable reason — see the [error reference](/api/errors) for the full catalog and remediation per code.

## Changes

- **2026-11-03** `28a5e2a65cd3`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/searchable/apis/searchable-rest-api/changes/api/mcp/projects/:projectId/traffic/correlation/get.md)

---

[API](https://skmtc.dev/searchable/apis/searchable-rest-api.md) - [All operations](https://skmtc.dev/searchable/apis/searchable-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/searchable/apis/searchable-rest-api/revisions/a1cc70e46e73?raw)