Skip to main content

​
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 latest API version is v2 for Agent Analytics report endpoints (/v2/reports/*). V1 endpoints remain active, including V1 report endpoints. 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
​
April 2026
v1.5.0

​
Added

  • New endpoint: List Agents - List agents available to your organization
  • New endpoint: Get an Agent - Retrieve an agent and its schema details
  • New endpoint: Run an Agent - Start a new run for an agent
  • New endpoint: Get an Agent Run - Retrieve the status and result details for an agent run
​
April 2026
Deprecation Notice

​
Deprecated

  • Deprecated raw Agent Analytics endpoints:
    • POST /v1/logs/raw - Get Logs
    • POST /v1/logs/raw/bots - Get Bots
  • Deprecation started on 2026-04-10
  • API keys created on or after 2026-04-10 can no longer access these endpoints
  • Existing API keys created before 2026-04-10 can continue using these endpoints until the sunset date of 2026-06-10
  • Migrate to the V2 aggregated report endpoints instead:
    • POST /v2/reports/bots for bot traffic reporting
    • POST /v2/reports/referrals for referral traffic reporting
  • For examples using the replacement endpoints, see Agent Analytics V2
​
March 2026
v2.0.0

​
Added

  • New /v2/reports endpoints with hourly granularity, bucketed by UTC hour — see Agent Analytics V2
    • POST /v2/reports/bots - Bot traffic data at hourly resolution
    • POST /v2/reports/referrals - Referral traffic data at hourly resolution, including UTM and referrer distinction
  • Because V2 uses UTC hour buckets rather than EST day buckets, users in any timezone can now align queries to their own local calendar days
​
December 2025
v1.4.0

​
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

​
Removed

  • Legacy examples page
​
December 2025
v1.3.0

​
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
  • persona dimension to citations, visibility and sentiment reports
  • persona to the prompt answers
  • model_id to the prompt answers
  • sentiment_themes to the prompt answers, deprecating themes. sentiment_themes returns the theme and its sentiment

​
Changed

  • Require a non-empty list value when using the in or not_in filter operator
  • created_at field is not allowed to be disabled

​
Fixed

  • Avoid exporting duplicate prompts in the prompt answers.
​
November 2025
v1.2.0

​
Added

​
Changed

  • Require hostname, path, root_domain and url to be included as dimensions when used as filters

​
Fixed

  • contains filter not being applied correctly
  • Typo in sentiment metric field name
    • Before: ocurrences
    • After: occurrences
  • Filters containing UUID’s not being applied correctly
  • Incorrect handling of mixed timezone and non-timezone values in start_date and end_date filters