---
title: "Get Models"
method: GET
path: "/get-models"
tags: ["public-api"]
---

# Get Models

`GET /get-models`

## Request

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

Get visibility breakdown by AI model.

## Query parameters

- `brand_id` string, uuid, required: Brand UUID
- `days` integer: Analysis period in days
- `include_trends` boolean: Include daily breakdown
- `period` string, nullable: A frozen calendar period instead of a rolling window: a month as YYYY-MM (2026-08) or a quarter as YYYY-Qn (2026-Q3). A closed month is read from the archive frozen when it closed; the open month is computed to date. When period is given, days is ignored and the response carries a `period` block saying exactly what was resolved. Definitions: /get-metrics.

## Response `200`

Successful Response

- ModelsResponse: GET /get-models response.
  - `period` PeriodMeta: What a period-scoped response actually resolved.
    - `key` string, required
    - `kind` string, required
    - `label` string, required
    - `start` string, required
    - `end` string, required
    - `status` string, required
    - `source` string, required
    - `frozen_at` string, nullable
    - `pipeline_version` string, nullable
    - `restated_at` string, nullable
    - `restatements` object[]
    - `coverage` object
    - `fields_computed` string[]
    - `fields_missing` string[]
    - `notes` string[]
    - `months` object, nullable
    - `rank_source` string, nullable
  - `models` ModelPerformance[], required
    - `model` string, required
    - `total_queries` integer, required: Number of report observations for this model, not prompt requests
    - `mentions` integer, required: Responses mentioning the tracked brand itself, excluding competitors
    - `visibility_rate` number, required
    - `presence` number, nullable
    - `average_position` number, nullable
    - `top_3_rate` number, nullable
    - `top_3_count` integer, nullable
  - `summary` ModelsSummary, required: Models summary.
    - `total_results` integer, required
    - `total_mentions` integer, required: Mentions of the tracked brand itself across models, excluding competitors
    - `overall_visibility_rate` number, required
    - `model_count` integer, required
    - `period_days` 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)