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
- 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.
