> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peec.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Changelog

> Track updates, improvements, and breaking changes to the Peec API.

## How to read this changelog

This changelog documents all updates, improvements, and fixes to the Peec Customer API.

<Warning>
  The API is currently in v0 (beta). During this phase, features and endpoints are subject to change, and breaking changes may occur. Once the API reaches v1, breaking changes will be minimized.
</Warning>

### Changelog Categories

* **Breaking Changes:** API changes that may require updates to your integration.
* **Added:** New features or capabilities.
* **Changed:** Updates to existing functionality that aren’t breaking.
* **Deprecated:** Features still available but planned for removal.
* **Removed:** Features removed from the API.
* **Fixed:** Bug fixes and corrections.
* **Security:** Updates addressing vulnerabilities or improving security.

# Changelog

<Update label="July 10, 2026" description="v0.33.0">
  ### Added

  * **Tag group management** Tags can now belong to a user-defined group, and tags in a group share a color.
    * [Create Tag](/api-reference/project/create-tag) and [Update Tag](/api-reference/project/update-tag) accept an optional `group` field. Setting a group moves the tag into it (inheriting the group's color, so `color` is ignored); passing `null` on Update Tag removes the tag from its group.
    * [List Tags](/api-reference/project/list-tags) now returns the user-defined `group` for user tags (previously only system tags carried a `group`) and accepts a `group` query parameter to filter by group.
    * New [List Tag Groups](/api-reference/project/list-tag-groups) endpoint returns each user-defined group with its shared color and tag count.
    * New [Update Tag Group](/api-reference/project/update-tag-group) endpoint renames and/or recolors every tag in a group.
    * New [Delete Tag Group](/api-reference/project/delete-tag-group) endpoint ungroups a group's tags by default, or deletes them with `delete_tags: true`.
</Update>

<Update label="June 27, 2026" description="v0.32.0">
  ### Added

  * **Archive and Unarchive Prompt endpoints** New [Archive Prompt](/api-reference/project/archive-prompt) and [Unarchive Prompt](/api-reference/project/unarchive-prompt) endpoints for pausing and resuming tracking of a prompt without deleting it. Archived prompts are excluded from [List Chats](/api-reference/project/list-chats) by default — pass `include_archived_prompts=true` to include their historical chats. Unarchiving is subject to your plan's active-prompt limit.
</Update>

<Update label="June 26, 2026" description="v0.31.0">
  ### Added

  * **`is_system` and `group` on List Tags** The [List Tags](/api-reference/project/list-tags) endpoint now returns `is_system` — whether the tag is a system tag maintained by Peec and auto-assigned to every prompt by its classification — and `group`, the system tag group the tag belongs to: `branding` (the branded / non-branded distinction) or `intentType` (the informational / commercial / transactional distinction). `group` is `null` for user-created tags.
</Update>

<Update label="June 25, 2026" description="v0.30.0">
  ### Added

  * **Products endpoints** A new group of Products endpoints exposes Peec's shopping data.
    * [List Products](/api-reference/products/list-products): a project's products with headline metrics (`mention_count`, `win_count`, `avg_position`, `visibility`, `share_of_voice`) over a date range, filterable by `product_ids`, `brand_ids`, `category_ids`, `merchant_ids`, `country_codes`, `model_channel_ids`, `topic_ids`, `tag_ids`, `source`, and `search`, with `order_by` (`visibility`, `win_rate`, `avg_position`, `mention_count`, `name`) and pagination.
    * [Get Product](/api-reference/products/get-product): detailed metrics for a single product over a date range, including period-over-period deltas, AI-quoted price ranges, and win rate.
    * [Create Products](/api-reference/products/create-products), [Update Products](/api-reference/products/update-products), and [Delete Products](/api-reference/products/delete-products): batch endpoints (up to 1,000 items per request) for managing products. Each returns per-item results, separating succeeded items from rejected ones with a reason.
    * [Get Shopping Attributes](/api-reference/products/get-shopping-attributes): a comparison grid of AI-extracted product attributes (`characteristics`, `facts`, `dimensions`) for a single product or the whole catalog, compared across brands or products.
  * **Category management endpoints** New [List Categories](/api-reference/products/list-categories), [Create Categories](/api-reference/products/create-categories), [Update Categories](/api-reference/products/update-categories), and [Delete Categories](/api-reference/products/delete-categories) endpoints for organizing products into a category tree. Create, update, and delete are batch endpoints returning per-item results with a rejection reason where applicable.
  * **List Global Brands endpoint** New [List Global Brands](/api-reference/products/list-global-brands) endpoint for searching Peec's global brand catalog by name or alias. Pass the optional `ownership` parameter (`own`, `competitor`, or `all`) to instead list the project's own shopping brands ranked by mention count; in that mode each result also includes `mention_count` and `is_own`.
  * **`chat_scope` on Product endpoints** [List Products](/api-reference/products/list-products) and [Get Product](/api-reference/products/get-product) accept an optional `chat_scope` parameter controlling the visibility denominator: `all` counts every in-scope chat, `shopping` counts only product-gallery chats. Defaults to `shopping`.
</Update>

<Update label="June 16, 2026" description="v0.29.0">
  ### Added

  * **`created_at` and creation-date filtering on Get Projects** The [Get Projects](/api-reference/company/get-projects) endpoint now returns a `created_at` field (RFC 3339 full-date, e.g. `2025-09-22`) for each project, and accepts optional `start_date` and `end_date` query parameters to filter projects by their creation date. Both bounds are inclusive and interpreted in UTC.
</Update>

<Update label="June 15, 2026" description="v0.28.0">
  ### Added

  * **snake\_case field-name corrections** A handful of response fields were inadvertently camelCase, inconsistent with the API's snake\_case convention. Their snake\_case equivalents have been added; the camelCase versions are now deprecated (see below). Existing integrations keep working until the camelCase fields are removed.
    * [Get Chat](/api-reference/project/get-chat): each source now includes `url_normalized`, `citation_count`, and `citation_position`; each ad includes `brand_name`, `ad_unit_type`, and `ads_request_id`; each ad card includes `image_url` and `target_url`.
    * **`total_count` on list endpoints** The [List Brands](/api-reference/project/list-brands), [List Chats](/api-reference/project/list-chats), [List Prompts](/api-reference/project/list-prompts), [List Tags](/api-reference/project/list-tags), [List Topics](/api-reference/project/list-topics), [List Fanout Search Queries](/api-reference/project/list-fanout-search-queries), and [List Fanout Shopping Queries](/api-reference/project/list-fanout-shopping-queries) endpoints now return a `total_count` field.
    * [Get Project Profile](/api-reference/project/get-project-profile): now returns `brand_presentation`, `products_and_services`, `target_markets` (each with `market_size` and `osm_id`), `audience_distribution` (with `simple_recommendation_seeker`, `informed_shopper`, and `evaluative_researcher`), and `used_prepared_profile`.

  ### Changed

  * **[Set Project Profile](/api-reference/project/set-project-profile) accepts snake\_case** The request body now also accepts snake\_case field names (`brand_presentation`, `products_and_services`, `target_markets[].market_size` / `osm_id`, `audience_distribution.simple_recommendation_seeker` / `informed_shopper` / `evaluative_researcher`), matching the rest of the API. The camelCase field names are still accepted for backward compatibility.

  ### Deprecated

  * **camelCase field names** The camelCase equivalents of the fields above are deprecated and will be removed in a future version. Migrate to snake\_case:
    * Get Chat sources: `urlNormalized` → `url_normalized`, `citationCount` → `citation_count`, `citationPosition` → `citation_position`.
    * Get Chat ads: `brandName` → `brand_name`, `adUnitType` → `ad_unit_type`, `adsRequestId` → `ads_request_id`, `imageUrl` → `image_url`, `targetUrl` → `target_url`.
    * List endpoints: `totalCount` → `total_count`.
    * Project Profile: `brandPresentation` → `brand_presentation`, `productsAndServices` → `products_and_services`, `targetMarkets` → `target_markets`, `marketSize` → `market_size`, `osmId` → `osm_id`, `audienceDistribution` → `audience_distribution`, `simpleRecommendationSeeker` → `simple_recommendation_seeker`, `informedShopper` → `informed_shopper`, `evaluativeResearcher` → `evaluative_researcher`, `usedPreparedProfile` → `used_prepared_profile`.
</Update>

<Update label="June 10, 2026" description="v0.27.0">
  ### Added

  * **`week` and `month` dimensions on Report Endpoints** The [Get Brands Report](/api-reference/reports/get-brands-report), [Get Domains Report](/api-reference/reports/get-domains-report), and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now accept `week` and `month` in the `dimensions` array, aggregating results into weekly or monthly time buckets instead of the daily breakdown provided by `date`. Results broken down by `week` include a `week` field containing the Monday that starts the ISO week; results broken down by `month` include a `month` field containing the first day of the month.
</Update>

<Update label="June 8, 2026" description="v0.26.0">
  ### Added

  * **`having` filter on Report Endpoints** The [Get Brands Report](/api-reference/reports/get-brands-report), [Get Domains Report](/api-reference/reports/get-domains-report), and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now accept an optional `having` array of post-aggregation filters that select which aggregated results are returned **without** shrinking the denominators of ratio metrics. Unlike `filters` (which apply before aggregation), `having` lets you narrow to a single brand, domain, or URL while metrics like `share_of_voice` stay measured against the full in-scope population. Population fields (`model_id`, `model_channel_id`, `country_code`, `prompt_id`, `tag_id`, `topic_id`, `chat_id`) used in `having` require the matching value in `dimensions`, otherwise the request is rejected. Multiple `having` filters are AND'd together. See [Filtering and dimensions](/api/filtering-and-dimensions) for guidance on when to use `filters` vs `having`.

  ### Fixed

  * **`share_of_voice` denominator now scoped per dimension** On the [Get Brands Report](/api-reference/reports/get-brands-report), `share_of_voice` is now computed against total mentions within each result's dimension grouping rather than a single project-wide total. When breaking down by `prompt_id` (or any other dimension), each brand's share is now its mentions in that grouping divided by all brands' mentions in the same grouping. Previously the same denominator was applied across every result, distorting share values in broken-down reports.
</Update>

<Update label="May 27, 2026" description="v0.25.2">
  ### Removed

  * **`IMAGE` removed from `features`** The `IMAGE` value is no longer part of the `features` array returned by the [List Chats](/api-reference/project/list-chats) and [Get Chat](/api-reference/project/get-chat) endpoints, and is no longer accepted by the [List Chats](/api-reference/project/list-chats) `features` filter. Remaining values: `SHOPPING`, `PRODUCT_COMPARISON`, `AD`, `MAP`, `WEB_SEARCH`.
</Update>

<Update label="May 22, 2026" description="v0.25.1">
  ### Changed

  * **List Chats excludes archived and deleted prompts by default** The [List Chats](/api-reference/project/list-chats) endpoint now excludes chats whose prompt has been archived or deleted. To include chats for archived prompts (e.g. historical lookback for a prompt that is no longer tracked), pass `include_archived_prompts=true`. Chats for deleted prompts are always excluded.

  ### Fixed

  * **`features` values on Get Chat** The [Get Chat](/api-reference/project/get-chat) endpoint now returns `features` using the same values accepted by the [List Chats](/api-reference/project/list-chats) `features` filter: `SHOPPING`, `PRODUCT_COMPARISON`, `IMAGE`, `AD`, `MAP`, `WEB_SEARCH`. Previously it returned internal element names (e.g. `PRODUCT_GALLERY`, `LOCAL_BUSINESS`, `SOURCES`), which could not be passed back as filters.
</Update>

<Update label="May 21, 2026" description="v0.25.0">
  ### Added

  * **List Bots Endpoint** New [List Bots](/api-reference/project/list-bots) endpoint returning every AI agent bot tracked by Peec Agent Analytics, with each bot's `id` (user agent), `provider`, and `type` (`training`, `search`, `userQuery`, `other`).
  * **Get Agent Visits Endpoint** New [Get Agent Visits](/api-reference/project/get-agent-visits) endpoint aggregating AI bot visit counts from connected access logs over a date range. Supports `group_by` across `bot_id`, `response_status`, `request_host`, and `request_path`, an optional `bot_ids` filter, and `time_bucket` (`hour`, `day`, `week`, `month`) for time-series breakdowns.
  * **`features` field on Chat Endpoints** The [List Chats](/api-reference/project/list-chats) and [Get Chat](/api-reference/project/get-chat) endpoints now return a `features` array — feature flags for special elements detected in the assistant response (shopping carousels, product comparisons, image galleries, ads, map widgets, web search).
  * **`features` filter on List Chats** The [List Chats](/api-reference/project/list-chats) endpoint now accepts an optional `features` array parameter. Values: `SHOPPING`, `PRODUCT_COMPARISON`, `IMAGE`, `AD`, `MAP`, `WEB_SEARCH`. Multiple values are AND'd — a chat must contain every listed feature to match.
  * **`maps` and `ads` fields on Get Chat** The [Get Chat](/api-reference/project/get-chat) endpoint now returns `maps` (local-business map cards with name and Google Maps directions URL) and `ads` (paid ad placements with brand, target URL, ad unit type, and card content).
</Update>

<Update label="April 28, 2026" description="v0.24.0">
  ### Added

  * **`domain_classification` filter for Domains and URLs reports** New filter on the [Get Domains Report](/api-reference/reports/get-domains-report) and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints to narrow results by domain classification. Operators: `in`, `not_in`. Values: array of `CORPORATE`, `EDITORIAL`, `INSTITUTIONAL`, `OTHER`, `REFERENCE`, `UGC`, `COMPETITOR`, `OWN`.
  * **`url_classification` filter for URLs Report** New filter on the [Get URLs Report](/api-reference/reports/get-urls-report) endpoint to narrow results by URL classification. Operators: `in`, `not_in`. Values: array of `HOMEPAGE`, `CATEGORY_PAGE`, `PRODUCT_PAGE`, `LISTICLE`, `COMPARISON`, `PROFILE`, `ALTERNATIVE`, `DISCUSSION`, `HOW_TO_GUIDE`, `ARTICLE`, `OTHER`.
</Update>

<Update label="April 28, 2026" description="v0.23.1">
  ### Fixed

  * **`total_chat_count` Now Respects Filters on Domains Report** The [Get Domains Report](/api-reference/reports/get-domains-report) endpoint now applies request filters to `total_chat_count`, so the denominator used for `retrieval_rate` and `retrieved_percentage` reflects the filtered scope.
</Update>

<Update label="April 27, 2026" description="v0.23.0">
  ### Added

  * **Project Profile Endpoints** New [Get Project Profile](/api-reference/project/get-project-profile) and [Set Project Profile](/api-reference/project/set-project-profile) endpoints for retrieving and updating the profile of a project.
  * **`retrieved_chat_count` and `total_chat_count` on Domains Report** The [Get Domains Report](/api-reference/reports/get-domains-report) endpoint now returns `retrieved_chat_count` (distinct chats in which at least one URL from the domain was retrieved) and `total_chat_count` (total chats in scope for the result, used as the denominator for `retrieval_rate` and `retrieved_percentage`).
</Update>

<Update label="April 23, 2026" description="v0.22.0">
  ### Added

  * **`order_by` Parameter on Report Endpoints** The [Get Brands Report](/api-reference/reports/get-brands-report), [Get Domains Report](/api-reference/reports/get-domains-report), and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now accept an optional `order_by` array to sort results by one or more fields. Each entry takes a `field` and a `direction` (`asc` or `desc`, defaults to `desc`); multiple entries create a multi-key sort.
    * Brands report sortable fields: `visibility`, `visibility_count`, `mention_count`, `sentiment`, `position`, `share_of_voice`.
    * Domains report sortable fields: `citation_rate`, `retrieval_count`, `citation_count`.
    * URLs report sortable fields: `retrieval_count`, `retrievals`, `citation_count`, `citation_rate`.
  * **`retrieval_count` and `citation_count` on Domains Report** The [Get Domains Report](/api-reference/reports/get-domains-report) endpoint now returns `retrieval_count` (total distinct URL retrievals from the domain across all chats) and `citation_count` (total citations from the domain).
  * **`retrieval_count` on URLs Report** The [Get URLs Report](/api-reference/reports/get-urls-report) endpoint now returns `retrieval_count` — the total number of distinct chats that retrieved the URL.

  ### Deprecated

  * **`retrievals` on URLs Report** The `retrievals` field on [Get URLs Report](/api-reference/reports/get-urls-report) is deprecated. Use `retrieval_count` instead.
</Update>

<Update label="April 22, 2026" description="v0.21.0">
  ### Added

  * **`totalCount` on List Endpoints** The [List Brands](/api-reference/project/list-brands), [List Chats](/api-reference/project/list-chats), [List Prompts](/api-reference/project/list-prompts), [List Tags](/api-reference/project/list-tags), [List Topics](/api-reference/project/list-topics), [List Fanout Search Queries](/api-reference/project/list-fanout-search-queries), and [List Fanout Shopping Queries](/api-reference/project/list-fanout-shopping-queries) endpoints now return a `totalCount` field — the total number of matching results across all pages, for building paginated experiences.
</Update>

<Update label="April 21, 2026" description="v0.20.0">
  ### Added

  * **Get Brand Suggestions Endpoint** New [Get Brand Suggestions](/api-reference/project/get-brand-suggestions) endpoint for listing AI-generated brand suggestions for your project.
  * **Accept Brand Suggestion Endpoint** New [Accept Brand Suggestion](/api-reference/project/accept-brand-suggestion) endpoint to accept a brand suggestion, converting it into a brand.
  * **Reject Brand Suggestion Endpoint** New [Reject Brand Suggestion](/api-reference/project/reject-brand-suggestion) endpoint to reject a brand suggestion, removing it from the project.

  ### Deprecated

  * **`model_id` filters and `model.id` in responses** The `model_id` filter and the `model.id` field in responses are deprecated in favor of [model channels](/api/model-channels). A `model_id` filter is now resolved to its channel (e.g. `gpt-4o` → `openai`) and matches every result on that channel, regardless of the underlying model version. The `model.id` field in responses now always reflects the channel's current model, not the model that originally produced the result. Migrate to `model_channel_id` filters and the `model_channel` object in responses for stable behavior as model IDs are introduced and renamed.
</Update>

<Update label="April 15, 2026" description="v0.19.0">
  ### Added

  * **List Model Channels Endpoint** New [List Model Channels](/api-reference/project/list-model-channels) endpoint returning all available model channels with their current model, description, and active status.
  * **`model_channels` on List Models Endpoint** The [List Models](/api-reference/project/list-models) endpoint now returns a `model_channels` array on each model, listing the channels it belongs to (a model can belong to more than one).
  * **`model_channel` on Chat Endpoints** The [List Chats](/api-reference/project/list-chats) and [Get Chat](/api-reference/project/get-chat) endpoints now return a `model_channel` object. [List Chats](/api-reference/project/list-chats) also accepts an optional `model_channel_id` query parameter for filtering.
  * **`model_channel` on Query Endpoints** The [List Fanout Search Queries](/api-reference/project/list-fanout-search-queries) and [List Fanout Shopping Queries](/api-reference/project/list-fanout-shopping-queries) endpoints now return a `model_channel` object and support `model_channel_id` as a filter.
  * **`model_channel_id` Dimension and Filter on Report Endpoints** The [Get Brands Report](/api-reference/reports/get-brands-report), [Get Domains Report](/api-reference/reports/get-domains-report), and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now support `model_channel_id` as a dimension and filter, with an optional `model_channel` object in the response.
</Update>

<Update label="April 14, 2026" description="v0.18.0">
  ### Added

  * **`name` field on List Models endpoint** Model objects returned by [List Models](/api-reference/project/list-models) now include a `name` field — a human-readable display name (e.g. ChatGPT, Perplexity).
  * **`channel_title` field on URLs report** The [Get URLs Report](/api-reference/reports/get-urls-report) response now includes an optional `channel_title` field (e.g. YouTube channel name, subreddit).
  * **`mentioned_brands` field on Domains and URLs reports** The [Get Domains Report](/api-reference/reports/get-domains-report) and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now return a `mentioned_brands` array on each row — a list of brand objects mentioned alongside each domain/URL.
  * **`mentioned_brand_id` filter for Domains and URLs reports** New filter on the [Get Domains Report](/api-reference/reports/get-domains-report) and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints to narrow results by which brands were mentioned in sources. Operators: `in`, `not_in`. Values: array of brand ID strings.
  * **`mentioned_brand_count` filter for Domains and URLs reports** New filter on the [Get Domains Report](/api-reference/reports/get-domains-report) and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints to narrow results by the number of distinct brands mentioned. Operators: `gt`, `gte`, `lt`, `lte`. Value: integer >= 0.
  * **`gap` filter for Domains and URLs reports** New filter on the [Get Domains Report](/api-reference/reports/get-domains-report) and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints to find sources where competitors are mentioned but your own brand is not — useful for identifying content gaps. Operators: `gt`, `gte`, `lt`, `lte`. Value: integer >= 0 (minimum number of competitor mentions).
</Update>

<Update label="April 02, 2026" description="v0.17.0">
  ### Added

  * **Get Topic Suggestions Endpoint** New [Get Topic Suggestions](/api-reference/project/get-topic-suggestions) endpoint for listing AI-generated topic suggestions for your project.
  * **Get Prompt Suggestions Endpoint** New [Get Prompt Suggestions](/api-reference/project/get-prompt-suggestions) endpoint for listing AI-generated prompt suggestions, with optional filtering by `topic_id`.
  * **Accept Topic Suggestion Endpoint** New [Accept Topic Suggestion](/api-reference/project/accept-topic-suggestion) endpoint to accept a topic suggestion, converting it into a regular topic.
  * **Reject Topic Suggestion Endpoint** New [Reject Topic Suggestion](/api-reference/project/reject-topic-suggestion) endpoint to reject a topic suggestion, removing it and its associated prompt suggestions.
  * **Accept Prompt Suggestion Endpoint** New [Accept Prompt Suggestion](/api-reference/project/accept-prompt-suggestion) endpoint to accept a prompt suggestion, creating a new prompt from it.
  * **Reject Prompt Suggestion Endpoint** New [Reject Prompt Suggestion](/api-reference/project/reject-prompt-suggestion) endpoint to reject a prompt suggestion, removing it from the suggestions list.
</Update>

<Update label="March 31, 2026" description="v0.16.0">
  ### Added

  * **Update Prompt Endpoint** New [Update Prompt](/api-reference/project/update-prompt) endpoint allowing you to assign tags and topics to prompts.
  * **Filter Parameters on Get Prompts Endpoint** The [Get Prompts](/api-reference/project/get-prompts) endpoint now supports optional `topic_id` and `tag_id` query parameters, allowing you to filter prompts by topic and tags.
</Update>

<Update label="March 27, 2026" description="v0.15.0">
  ### Added

  * **Prompt Management Endpoints** New [Create Prompt](/api-reference/project/create-prompt) and [Delete Prompt](/api-reference/project/delete-prompt) endpoints for managing prompts via the API.
  * **Brand Management Endpoints** New [Create Brand](/api-reference/project/create-brand), [Update Brand](/api-reference/project/update-brand), and [Delete Brand](/api-reference/project/delete-brand) endpoints for managing brands via the API.
  * **Tag Management Endpoints** New [Create Tag](/api-reference/project/create-tag), [Update Tag](/api-reference/project/update-tag), and [Delete Tag](/api-reference/project/delete-tag) endpoints for managing tags via the API.
  * **Topic Management Endpoints** New [Create Topic](/api-reference/project/create-topic), [Update Topic](/api-reference/project/update-topic), and [Delete Topic](/api-reference/project/delete-topic) endpoints for managing topics via the API.
</Update>

<Update label="March 26, 2026" description="v0.14.0">
  ### Added

  * **`chat_id` Dimension and Filter on Report Endpoints** All report endpoints now support `chat_id` as a dimension and filter.
</Update>

<Update label="March 23, 2026" description="v0.13.0">
  ### Added

  * **Filter Parameters on Get Chats Endpoint** The [Get Chats](/api-reference/project/get-chats) endpoint now supports optional `brand_id`, `model_id`, and `prompt_id` query parameters, allowing you to filter chat results by brand, AI model, and prompt.
  * **`is_own` Property on Get Brands Endpoint** The [Get Brands](/api-reference/project/get-brands) endpoint now returns an `is_own` property on each brand, allowing you to differentiate between your own brands and competitor brands.
</Update>

<Update label="March 19, 2026" description="v0.12.0">
  ### Added

  * **`country_code` Dimension and Filter on Report Endpoints** All report endpoints now support `country_code` as a dimension and filter.
  * **Retrieval Metrics on Domains Report** The [Get Domains Report](/api-reference/reports/get-domains-report) endpoint now returns `retrieved_percentage`, `retrieval_rate`, and `citation_rate` metrics.
  * **Retrieval Metrics on URLs Report** The [Get URLs Report](/api-reference/reports/get-urls-report) endpoint now returns `retrievals` and `citation_rate` metrics.

  ### Deprecated

  * **`citation_avg`, `usage_count`, `usage_rate` on Report Endpoints** These metrics are deprecated and will eventually be removed in a future version. Use the new retrieval metrics instead.
</Update>

<Update label="March 18, 2026" description="v0.11.0">
  ### Added

  * **`date` Dimension on Report Endpoints** The [Get Brands Report](/api-reference/reports/get-brands-report), [Get Domains Report](/api-reference/reports/get-domains-report), and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now support `date` as a dimension, enabling daily breakdowns of report data within a single API call.
</Update>

<Update label="March 13, 2026" description="v0.10.0">
  ### Added

  * **Get Fanout Search Queries Endpoint** New [Get Fanout Search Queries](/api-reference/project/get-fanout-search-queries) endpoint for retrieving expanded search queries generated during chat conversations, enabling analysis of how AI models fan out user prompts into multiple search queries.
  * **Get Fanout Shopping Queries Endpoint** New [Get Fanout Shopping Queries](/api-reference/project/get-fanout-shopping-queries) endpoint for retrieving shopping-related queries and product data captured in AI model responses, enabling insights into product recommendations and shopping search behavior.
</Update>

<Update label="March 6, 2026" description="v0.9.0">
  ### Breaking Changes

  * **`normalizedUrl` removed from URL Reports** The `normalizedUrl` field has been removed from the [Get URLs Report](/api-reference/reports/get-urls-report) endpoint. URLs in the response are now returned already normalized, making this field redundant.

  ### Changed

  * **Significant Performance Improvements** Report endpoints have been optimized for significantly improved response times across all report queries.
  * **Zero-Visibility Datapoints Included in Brands Report** The [Get Brands Report](/api-reference/reports/get-brands-report) endpoint now returns datapoints for brand + dimension combinations even when they have 0 visibility. Previously, these combinations were omitted from the response.

  ### Added

  * **Filters on Report Endpoints** The [Get Brands Report](/api-reference/reports/get-brands-report), [Get Domains Report](/api-reference/reports/get-domains-report), and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now support a `filters` array, allowing you to filter results by `model_id`, `tag_id`, `topic_id`, `prompt_id`, `brand_id`, `domain`, and `url` using `in` and `not_in` operators.
  * **`share_of_voice` and `mention_count` added to Brands Report** The [Get Brands Report](/api-reference/reports/get-brands-report) endpoint now returns `share_of_voice` and `mention_count` fields, providing additional brand performance metrics.
</Update>

<Update label="March 4, 2026" description="v0.8.0">
  ### Added

  * **Citation Position on Sources and Position on Brand Mentions in Get Chat API** The [Get Chat](/api-reference/project/get-chat) endpoint now returns `citationPosition` on each source and `position` on each brand mention, providing precise ranking data for citations and brand references in chat responses.
</Update>

<Update label="February 20, 2026" description="v0.7.1">
  ### Added

  * **Citation Count on Sources in Get Chat API** The [Get Chat](/api-reference/project/get-chat) endpoint now returns `citationCount` on each source, providing visibility into how many times a source is cited in the chat response.
</Update>

<Update label="February 19, 2026" description="v0.7.0">
  ### Added

  * **Fanout Search Queries in Get Chat API** The [Get Chat](/api-reference/project/get-chat) endpoint now returns fanout search queries, providing visibility into the expanded search queries generated during chat conversations.
  * **Shopping Products and Queries in Get Chat API** The [Get Chat](/api-reference/project/get-chat) endpoint now returns shopping products and their associated queries, enabling insights into product recommendations and shopping-related search behavior.
</Update>

<Update label="January 27, 2026" description="v0.6.0">
  ### Added

  * **New aggregation attributes in Get Brands Report** The [Get Brands Report](/api-reference/reports/get-brands-report) endpoint now returns additional attributes (`sentiment_sum`, `sentiment_count`, `position_count`, `position_sum`, `visibility_count`, `visibility_total`) enabling more flexible aggregations and analytics calculations.
</Update>

<Update label="January 14, 2026" description="v0.5.0">
  ### Added

  * **URL and Domain Classification field added** The [Get Domains Report](/api-reference/reports/get-domains-report) and [Get URLs Report](/api-reference/reports/get-urls-report) endpoints now return a `classification` field for each domain and URL, providing insights into content categories and types.
</Update>

<Update label="January 13, 2026" description="v0.4.0">
  ### Added

  * **Project Status field added** The [Get Projects](/api-reference/company/get-projects) endpoint now returns a `status` field for each project, enabling better visibility into project lifecycle and state.

  ### Changed

  * **Pagination max limit increased** The maximum pagination limit has been increased from 1,000 to 10,000 records per request, allowing for more efficient bulk retrieval.
</Update>

<Update label="December 22, 2025" description="v0.3.0">
  ### Added

  * **Topics and Tags in Get Prompts API** The [Get Prompts](/api-reference/project/get-prompts) endpoint now returns `tags` and `topics` fields for each prompt, allowing for better categorization and filtering of prompts.
</Update>

<Update label="December 01, 2025" description="v0.2.0">
  ### Added

  * **Topics and Tags as Report Dimensions** Topics and tags are now available as report dimensions in the API, enabling more granular filtering and analysis of report data.
  * **Prompt Volume in Get Prompts API** The [Get Prompts](/api-reference/project/get-prompts) endpoint now returns a `volume` field, providing insight into prompt usage and frequency.
  * **Mentioned Brands in Get Chat API** The [Get Chat](/api-reference/project/get-chat) endpoint now returns a `brands_mentioned` field, providing visibility into which brands are referenced in chat conversations.
</Update>

<Update label="October 09, 2025" description="v0.1.0">
  ### Added

  * **Initial Release** The Peec Customer API is now available.
</Update>