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

# Get Crawler Overview

`GET /crawler/overview`

## Request

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

Crawler dashboard overview aligned to the product's hero and chart.

## Query parameters

- `brand_id` string, uuid, required: Brand UUID
- `range_preset` '24h' | '7d' | '30d' | '90d' | 'custom'
- `start_date` string, nullable
- `end_date` string, nullable
- `compare_to` 'none' | 'previous_period'

## Response `200`

Successful Response

- CrawlerOverviewResponse
  - `brand_id` string, required
  - `range` CrawlerRangeMeta, required
    - `range_preset` string, required
    - `start` string, required
    - `end` string, required
    - `days` integer, required
    - `compare_to` string
  - `state` object, required
  - `hero` object, required
  - `chart` object, required
  - `breakdown` object, required
  - `top_pages` object[], required
  - `recent_preview` object[], required
  - `sessions_preview` object[]
  - `compare` object, nullable
  - `connections` object, nullable

## 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)