How to read this changelog
This changelog documents all updates, improvements, and fixes to the Peec Customer API.
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.
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
Added
- Update Prompt Endpoint New Update Prompt endpoint allowing you to assign tags and topics to prompts.
- Filter Parameters on Get Prompts Endpoint The Get Prompts endpoint now supports optional
topic_id and tag_id query parameters, allowing you to filter prompts by topic and tags.
Added
chat_id Dimension and Filter on Report Endpoints All report endpoints now support chat_id as a dimension and filter.
Added
- Filter Parameters on Get Chats Endpoint The 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 endpoint now returns an is_own property on each brand, allowing you to differentiate between your own brands and competitor brands.
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 endpoint now returns
retrieved_percentage, retrieval_rate, and citation_rate metrics.
- Retrieval Metrics on URLs Report The 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.
Added
- Get Fanout Search Queries Endpoint New 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 endpoint for retrieving shopping-related queries and product data captured in AI model responses, enabling insights into product recommendations and shopping search behavior.
Breaking Changes
normalizedUrl removed from URL Reports The normalizedUrl field has been removed from the 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 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, Get Domains Report, and 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 endpoint now returns share_of_voice and mention_count fields, providing additional brand performance metrics.
Added
- Citation Position on Sources and Position on Brand Mentions in Get Chat API The 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.
Added
- Citation Count on Sources in Get Chat API The Get Chat endpoint now returns
citationCount on each source, providing visibility into how many times a source is cited in the chat response.
Added
- Fanout Search Queries in Get Chat API The 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 endpoint now returns shopping products and their associated queries, enabling insights into product recommendations and shopping-related search behavior.
Added
- New aggregation attributes in Get Brands Report The 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.
Added
- URL and Domain Classification field added The Get Domains Report and Get URLs Report endpoints now return a
classification field for each domain and URL, providing insights into content categories and types.
Added
- Project Status field added The 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.
Added
- Topics and Tags in Get Prompts API The Get Prompts endpoint now returns
tags and topics fields for each prompt, allowing for better categorization and filtering of prompts.
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 endpoint now returns a
volume field, providing insight into prompt usage and frequency.
- Mentioned Brands in Get Chat API The Get Chat endpoint now returns a
brands_mentioned field, providing visibility into which brands are referenced in chat conversations.
Added
- Initial Release The Peec Customer API is now available.
