Get AI fetch correlation report

GET

/api/sites/{id}/ai-fetch/correlation

curl --request GET \
  --url 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ai-fetch/correlation?resource_type=html&window_days=30' \
  --cookie hk_token=<hk_token>

Returns directional AI fetch correlation metrics for a site by matching AI crawler fetches to later AI-referred visits on the same path within a bounded window. Assistant filters apply to the fetch side only; correlated visit counts include any AI assistant referrer that later drove a human visit to the same path.

Authorizations

• cookieAuth
• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

from

string format: date-time

to

string format: date-time

assistant_name

string

Optional AI assistant bot name filter.

assistant_family

string

Optional AI assistant family filter.

resource_type

string

Allowed values: html document image other

Optional AI fetch resource type filter.

path

string

Optional exact fetched path filter.

window_days

integer

default: 30 >= 1 <= 90

Directional correlation window in days. Must be between 1 and 90. Defaults to 30.

Responses

200

AI fetch correlation report

Media type application/json

object

citation_yield

Array<object>

object

ai_referred_visits

integer

assistant_name

string

citation_yield_pct

number

fetch_count

integer

path

string

failure_hotspots

Array<object>

object

assistant_name

string

error_rate_pct

number

error_requests

integer

path_prefix

string

total_requests

integer

opportunity_pages

Array<object>

object

ai_referred_visits

integer

error_rate_pct

number

error_requests

integer

fetch_count

integer

path

string

summary

object

ai_referred_visits

integer

correlated_paths

integer

fetched_paths

integer

total_fetches

integer

uncorrelated_fetches

integer

Example ^generated

{
  "citation_yield": [
    {
      "ai_referred_visits": 1,
      "assistant_name": "example",
      "citation_yield_pct": 1,
      "fetch_count": 1,
      "path": "example"
    }
  ],
  "failure_hotspots": [
    {
      "assistant_name": "example",
      "error_rate_pct": 1,
      "error_requests": 1,
      "path_prefix": "example",
      "total_requests": 1
    }
  ],
  "opportunity_pages": [
    {
      "ai_referred_visits": 1,
      "error_rate_pct": 1,
      "error_requests": 1,
      "fetch_count": 1,
      "path": "example"
    }
  ],
  "summary": {
    "ai_referred_visits": 1,
    "correlated_paths": 1,
    "fetched_paths": 1,
    "total_fetches": 1,
    "uncorrelated_fetches": 1
  }
}