Overview
This changelog tracks all changes, updates, and improvements to the Profound REST API. We document new features, bug fixes, breaking changes, deprecations, and security updates to help you stay informed and plan your integrations accordingly.The current API version is
v1. All endpoints are prefixed with /v1 to ensure compatibility as the API evolves. For more information about API versioning, see the Introduction.Change Categories
Changes are organized into the following categories:- Added - New endpoints, features, or capabilities
- Changed - Modifications to existing endpoints or behavior
- Deprecated - Features that will be removed in a future version
- Removed - Features that have been removed
- Fixed - Bug fixes and corrections
- Security - Security improvements and vulnerability patches
- Breaking - Changes that require action to maintain compatibility
Added
- New endpoint: Get Referrals Report - Retrieve referral traffic data from daily aggregated reports
- New endpoint: Get Bots Report - Retrieve bot traffic analytics with metrics for citations, indexing, training, and visit counts
Changed
- Reorganized example documentation structure under new Example Requests tab
Removed
- Legacy examples page
Added
- New endpoint: Get Personas - Retrieve all personas associated with your organization
- New endpoint: Get Category Personas - Retrieve all personas associated to the given category
personadimension to citations, visibility and sentiment reportspersonato the prompt answersmodel_idto the prompt answerssentiment_themesto the prompt answers, deprecatingthemes.sentiment_themesreturns the theme and its sentiment
Changed
- Require a non-empty list value when using the
inornot_infilter operator created_atfield is not allowed to be disabled
Fixed
- Avoid exporting duplicate prompts in the prompt answers.
Added
- New endpoint: Get Category Assets - Retrieve assets associated with a specific category
- New endpoint: Get Assets - Retrieve all assets associated with your organization
asset_iddimension in Query Visibility and Query Sentiment
Changed
- Require
hostname,path,root_domainandurlto be included as dimensions when used as filters
Fixed
containsfilter not being applied correctly- Typo in sentiment metric field name
- Before:
ocurrences - After:
occurrences
- Before:
- Filters containing UUID’s not being applied correctly
- Incorrect handling of mixed timezone and non-timezone values in
start_dateandend_datefilters