Get AI fetch overview

GET

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

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

Returns aggregate AI fetch metrics for a site including request counts, error rates, response time, assistant breakdowns, and resource type split.

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.

Responses

200

AI fetch overview

Media type application/json

object

error_rate_4xx

number

error_rate_5xx

number

median_response_ms

integer

resource_type_split

Array<object>

object

name

string

value

integer

top_assistants

Array<object>

object

name

string

value

integer

top_error_paths

Array<object>

object

name

string

value

integer

top_families

Array<object>

object

name

string

value

integer

top_paths

Array<object>

object

name

string

value

integer

total_bytes

integer

total_requests

integer

unique_assistants

integer

unique_paths

integer

Example ^generated

{
  "error_rate_4xx": 1,
  "error_rate_5xx": 1,
  "median_response_ms": 1,
  "resource_type_split": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_assistants": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_error_paths": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_families": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "top_paths": [
    {
      "name": "example",
      "value": 1
    }
  ],
  "total_bytes": 1,
  "total_requests": 1,
  "unique_assistants": 1,
  "unique_paths": 1
}