---
title: "Get Crawler"
method: GET
path: "/get-crawler"
tags: ["public-api"]
---

# Get Crawler

`GET /get-crawler`

## Request

- Base URL: `https://api.trakkr.ai`
- URL: `https://api.trakkr.ai/get-crawler`
- Auth: HTTP bearer

Get AI crawler analytics for a brand.

Requires the 'crawler' feature entitlement (paid plans, not trials).

- view=dashboard: summary, distribution, time series, top pages, recent activity
- view=recent: last 100 crawler visits

## Query parameters

- `brand_id` string, uuid, required: Brand UUID
- `view` 'dashboard' | 'recent': View type
- `days` integer: Number of days (dashboard view, 1-90)

## Response `200`

Successful Response

- union
  - CrawlerDashboardResponse: GET /get-crawler?view=dashboard response.
    - `summary` CrawlerSummaryItem, required: Summary metrics for crawler dashboard.
      - `total_visits` integer, required
      - `total_visits_change` number, nullable
      - `unique_pages` integer, required
      - `unique_pages_change` number, nullable
      - `avg_daily_visits` number, required
      - `top_crawler` string, nullable
    - `distribution` CrawlerDistributionItem[], required
      - `crawler` string, required
      - `count` integer, required
      - `percentage` number, required
    - `time_series` CrawlerTimeSeriesItem[], required
      - `date` string, required
      - `count` integer, required
      - `by_crawler` object
    - `top_pages` CrawlerTopPageItem[], required
      - `url` string, required
      - `count` integer, required
      - `crawlers` string[]
    - `recent_activity` CrawlerVisitItem[], required
      - `id` string, required
      - `url` string, required
      - `pathname` string, nullable
      - `crawler` string, required
      - `visited_at` string, required
    - `date_range` object, required
  - CrawlerRecentResponse: GET /get-crawler?view=recent response.
    - `visits` CrawlerVisitItem[], required
      - `id` string, required
      - `url` string, required
      - `pathname` string, nullable
      - `crawler` string, required
      - `visited_at` string, required
    - `total` integer, required

## Other responses

- `401`: Missing, malformed, or expired credentials
- `402`: The current plan does not fund this operation
- `403`: Invalid credentials, missing brand access, or insufficient role
- `422`: Validation Error
- `429`: Rate limit exceeded
- `500`: The operation failed
- `503`: Authentication, entitlement, or a required dependency is temporarily unavailable

---

[API](https://skmtc.dev/trakkr/apis/trakkr-api.md) · [All operations](https://skmtc.dev/trakkr/apis/trakkr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trakkr/apis/trakkr-api/revisions/189a9e76b8d5?raw)