---
title: "Get the overview"
method: GET
path: "/overview"
tags: ["Visibility"]
---

# Get the overview

`GET /overview`

## Request

- Base URL: `https://app.getintel.ai/api/v1`
- URL: `https://app.getintel.ai/api/v1/overview`
- Auth: HTTP bearer

Everything on the app's Home page for a period: visibility, share of voice, position and citations against the top rivals (overall and per day), brand perception, cited pages, topics weakest first, AI traffic, the AI readiness score and open tasks per layer.

## Query parameters

- `brand_id` integer
- `market` string
- `days` integer
- `from` string, date
- `to` string, date

## Response `200`

OK

- object
  - `data` object, required
  - `meta` Meta, required
    - `api_version` string
    - `brand` object
      - `id` integer
      - `name` string
    - `market` object
      - `id` integer
      - `code` string
      - `label` string

## Other responses

- `400`: Invalid parameter, or brand_id missing on a multi-brand account (brand_required).
- `401`: Missing, revoked or unknown API key (invalid_api_key).
- `403`: The plan doesn't include this data (feature_not_in_plan) or the plan isn't active (plan_inactive).
- `404`: The brand or the requested item doesn't exist (brand_not_found, not_found).
- `409`: The integration this needs isn't connected (integration_not_connected).
- `429`: Monthly read limit reached (quota_exceeded) or more than 60 requests a minute (rate_limited).
- `502`: An upstream service failed; retry later (upstream_error).

---

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