Early Access Feature
Usage and Query History APIs v2
We will be expanding our Usage and Workplace History Export APIs to provide deeper, more granular visibility into activity across Harvey.
Interested in testing this feature?
Contact your Customer Success Manager for early access.
Overview
We will be enhancing Harvey’s Usage and Workplace History Export APIs to provide a more complete and actionable view of platform activity. These updates will give Admins and Knowledge Managers the precision they need to measure adoption, support compliance and client reporting, and prepare for renewals with confidence.
With deeper visibility into workflows, playbooks, vaults, drafting activity, and distinct user actions, organizations will better understand engagement and high-value use cases. The result is more reliable reporting, clearer ROI measurement, and stronger operational oversight.
Important: The resource names returned through these APIs may include sensitive data from across your entire workspace. This data is not gated by client-matter or ethical wall boundaries. We recommend exercising caution when retrieving this information via API and sharing API tokens carefully and selectively.
With this feature you can expect:
- New workflow, playbook, and vault identifiers to better track common use cases
- More granular product-level usage tracking, including workflow-based Review Tables and draft-level activity
- Clear distinction between creating and running workflows and playbooks
- Clear distinction between starting new threads and submitting follow-up queries
- Expanded usage signals designed to support ROI analysis
For more detail on how the API schema is changing, see our developer guides: History Exports, Get Usage History, Get Query History
How This Works with Your Current API
These updates will be released as a new v2 version of the Usage and Query History APIs. The existing APIs will remain available, so current integrations and reporting pipelines will not break.
We will maintain the existing version through June 30, giving organizations time to evaluate and migrate to v2 on their own timeline. Historical data will be available in the new schema once you adopt the updated API.
Within the Admin Dashboard, an opt-in toggle will allow you to export usage data using the new v2 schema. This will make it easy to compare outputs and transition reporting when ready.
What’s Different in v2
The updated version introduces a unified, event-based schema designed to improve clarity, consistency, and reporting accuracy across Harvey surfaces.
Previous (v1) | Updated (v2) |
|---|---|
Message-based tracking | Event-based tracking |
Limited product visibility | Product surface and subsurface fields |
No consistent resource identifiers | Workflow, playbook, vault, and review table identifiers included |
No distinction between new vs. follow-up activity | Explicit separation |
No distinction between create vs. run for workflows, playbooks | New Create vs. Run distinction |
Schema inconsistencies across reporting surfaces | Unified schema across dashboard, export, and API |
Together, these changes create a more reliable and defensible single source of truth for usage data across Harvey.
FAQs
Q: Why was this change made?
This update reflects direct feedback from customers and internal stakeholders who asked for more granular visibility, clearer attribution, and stronger renewal-ready reporting. Organizations wanted a more comprehensive and defensible view of engagement across product surfaces.
Moving to an event-based schema will enable more precise tracking, clearer categorization of activity, and richer reporting across Harvey. It will also standardize how usage is logged, creating a more reliable source of truth across the dashboard, exports, and APIs.
Q: How will this differ from the previous version?
The updated version will shift from message-based tracking to event-based tracking, providing more structured and explicit usage signals. It will introduce product surface and subsurface fields, consistent identifiers for workflows, playbooks, vaults, and review tables, and clear distinctions between:
- New threads and follow-up queries
- Creation and run events for workflows and playbooks
It will also unify reporting under a single schema across the dashboard, exports, and APIs—eliminating prior inconsistencies.
Q: Will historical data still be available?
Yes. Historical data will be migrated into the new schema to preserve continuity. Once you adopt the updated API, you will be able to access historical records in the new format.
Q: Are there any data handling considerations?
Yes. Resource names returned through the usage and query APIs may include sensitive information and are not restricted by client-matter or ethical wall boundaries. Organizations should carefully manage API tokens and ensure downstream reporting systems handle exported data in accordance with internal security and compliance policies.