A subset of Document360's API endpoints is premium. These endpoints extend what you can automate: deeper analytics, governance and access controls, content-reuse objects, and more, beyond what's included in your base plan. This article lists every premium endpoint, grouped by category.
About premium API endpoints
Premium API endpoints are advanced API endpoints available on top of your existing plan. Any endpoint not listed on this page is included in API v3 by default, at no additional cost.
The premium restriction applies to trial projects as well. Before deciding whether to enable premium endpoints for your project, you can review each endpoint's description, sample request, and sample response in the API reference.
NOTE
If your project already used an equivalent endpoint under API v2 before it became premium, that access is carried forward automatically. You can keep using it, including under API v3, at no additional cost.
Using a premium endpoint without access
If you call a premium endpoint on a project that doesn't have access to it, the API returns an error instead of the requested data:
This endpoint is part of our premium API add-on, which isn't enabled for your project. To gain access, contact your Customer Success Manager or reach out to support@document360.com
To enable premium endpoints for your project, contact your Customer Success Manager or reach out to support@document360.com.
Premium endpoint categories
Premium endpoints fall into the following categories:
| Category | Endpoints |
|---|---|
| Analytics | 18 |
| Governance, security, and administration | 34 |
| Projects | 3 |
| Attachments and content reuse | 11 |
| Style guides | 2 |
| Translations | 1 |
| Custom fields | 1 |
Analytics
The Analytics category covers article, search, AI search, and feedback analytics endpoints.
Article analytics
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/projects/{project_id}/analytics/articles/countries |
Get top countries by article visits. |
| GET | /v3/projects/{project_id}/analytics/articles/most-read |
Get the top 5 most-read articles ranked by read duration (not paginated). |
| GET | /v3/projects/{project_id}/analytics/articles/performance |
Get article performance over time (daily views, reads, likes, dislikes). |
| GET | /v3/projects/{project_id}/analytics/articles/summary |
Get article analytics summary with overall engagement metrics. |
| GET | /v3/projects/{project_id}/analytics/articles/top |
Get top articles by engagement, paginated. |
| GET | /v3/projects/{project_id}/analytics/articles/top-categories |
Get top categories by engagement, paginated. |
| GET | /v3/projects/{project_id}/analytics/articles/{article_id} |
Get detailed analytics for a specific article. |
Search analytics
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/projects/{project_id}/analytics/search/keywords |
Get top searched keywords with engagement metrics. |
| GET | /v3/projects/{project_id}/analytics/search/no-results |
Get keywords that returned no search results. |
| GET | /v3/projects/{project_id}/analytics/search/summary |
Get search analytics summary with total, successful, no-result, and bounced search counts. |
| GET | /v3/projects/{project_id}/analytics/search/timeline |
Get search trend data over time (chart data). |
AI search analytics
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/projects/{project_id}/analytics/ai-search/most-referenced-articles |
Get articles most frequently referenced in AI search answers (not paginated). |
| GET | /v3/projects/{project_id}/analytics/ai-search/summary |
Get AI search summary with total queries, answered/unanswered counts, and feedback. |
| GET | /v3/projects/{project_id}/analytics/ai-search/timeline |
Get AI search trend data over time. |
| GET | /v3/projects/{project_id}/analytics/ai-search/trending-topics |
Get trending search topics and clusters (not paginated). |
Feedback analytics
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/projects/{project_id}/analytics/feedback/articles |
Get articles with feedback data, paginated. |
| GET | /v3/projects/{project_id}/analytics/feedback/summary |
Get feedback metrics summary including likes, dislikes, and additional feedback breakdown. |
| GET | /v3/projects/{project_id}/analytics/feedback/timeline |
Get feedback trend over time (chart data). |
Governance, security, and administration
This category covers content access and eligibility, roles, users and user groups, and readers and reader groups.
Content access and eligibility
| Method | Endpoint | Description |
|---|---|---|
| DELETE | /v3/projects/{project_id}/content-access |
Remove explicit content-access entries at a content node. |
| GET | /v3/projects/{project_id}/content-access |
List content-access permissions for a content node. |
| POST | /v3/projects/{project_id}/content-access |
Grant content access to users or groups at a content node. |
| PUT | /v3/projects/{project_id}/content-access |
Update the content role of an existing content-access entry. |
| POST | /v3/projects/{project_id}/content-access/add-or-allow |
Idempotently grant access: add new entries and flip existing denies to allowed. |
| POST | /v3/projects/{project_id}/content-access/allow |
Flip a denied content-access entry to allowed. |
| POST | /v3/projects/{project_id}/content-access/deny |
Deny content access for users or groups at a content node. |
| GET | /v3/projects/{project_id}/content-access/eligible-groups |
List groups eligible to be granted access at a content node. |
| GET | /v3/projects/{project_id}/content-access/eligible-readers |
List readers eligible to be granted access at a content node. |
| PUT | /v3/projects/{project_id}/content-access/inheritance |
Override an inherited permission with an explicit allow or deny on a child node. |
| PUT | /v3/projects/{project_id}/content-access/site-protection |
Toggle private/public site protection for a version and language. |
Roles
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/roles |
Create a custom role. |
| GET | /v3/projects/{project_id}/roles/permissions-matrix |
Get the permission dependency matrix. |
| DELETE | /v3/projects/{project_id}/roles/{role_id} |
Delete a custom role. This action is irreversible. |
| PUT | /v3/projects/{project_id}/roles/{role_id} |
Update a custom role. |
| GET | /v3/projects/{project_id}/roles/{role_id}/users |
List users in a role. |
Users and user groups
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/users |
Create a user. |
| DELETE | /v3/projects/{project_id}/users/{user_id} |
Delete a user. |
| GET | /v3/projects/{project_id}/users/{user_id}/consolidated-permissions |
Get a user's consolidated permissions. |
| PUT | /v3/projects/{project_id}/users/{user_id}/portal-role |
Update a user's portal role. |
| PUT | /v3/projects/{project_id}/users/{user_id}/content-role |
Update a user's content role. |
| PUT | /v3/projects/{project_id}/users/{user_id}/groups |
Update a user's groups. |
| POST | /v3/projects/{project_id}/users/groups |
Create a user group. |
| PUT | /v3/projects/{project_id}/users/groups/{group_id} |
Update a user group. |
| DELETE | /v3/projects/{project_id}/users/groups/{group_id} |
Delete a user group. |
| GET | /v3/projects/{project_id}/users/groups/{group_id}/consolidated-permissions |
Get a user group's consolidated permissions. |
| PUT | /v3/projects/{project_id}/users/groups/{group_id}/portal-role |
Update a user group's portal role. |
Readers and reader groups
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/readers |
Create a reader. |
| PUT | /v3/projects/{project_id}/readers/{reader_id} |
Update a reader. |
| DELETE | /v3/projects/{project_id}/readers/{reader_id} |
Delete a reader. |
| DELETE | /v3/projects/{project_id}/readers/jwt |
Delete JWT readers. |
| POST | /v3/projects/{project_id}/readers/groups |
Create a reader group. |
| PUT | /v3/projects/{project_id}/readers/groups/{group_id} |
Update a reader group. |
| DELETE | /v3/projects/{project_id}/readers/groups/{group_id} |
Delete a reader group. |
Projects
| Method | Endpoint | Description |
|---|---|---|
| PATCH | /v3/projects/{project_id}/custom-scripts |
Update custom scripts. |
| POST | /v3/projects/{project_id}/exports |
Start a project export. |
| POST | /v3/projects/{project_id}/imports |
Start a project import. |
Attachments and content reuse
Article attachments
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/articles/{article_id}/attachments |
Add an article attachment. |
| DELETE | /v3/projects/{project_id}/articles/{article_id}/attachments/{attachment_id} |
Delete an article attachment. |
Snippets
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/snippets |
Create a new snippet. |
| DELETE | /v3/projects/{project_id}/snippets/{snippet_id} |
Delete a snippet. |
| PUT | /v3/projects/{project_id}/snippets/{snippet_id} |
Replace an existing snippet. |
Variables
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/variables |
Create a new variable. |
| DELETE | /v3/projects/{project_id}/variables/{variable_id} |
Delete a variable. |
| PUT | /v3/projects/{project_id}/variables/{variable_id} |
Replace an existing variable. |
Glossaries
| Method | Endpoint | Description |
|---|---|---|
| POST | /v3/projects/{project_id}/glossaries |
Create a new glossary entry. |
| DELETE | /v3/projects/{project_id}/glossaries/{glossary_id} |
Delete a glossary entry. |
| PUT | /v3/projects/{project_id}/glossaries/{glossary_id} |
Replace an existing glossary entry. |
Style guides
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/projects/{project_id}/ai/writer-style-guides |
List AI writer style guides. |
| GET | /v3/projects/{project_id}/ai/writer-style-guides/{style_guide_id} |
Get AI writer style guide. |
Translations
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/projects/{project_id}/translations |
List articles by translation status. |
Custom fields
| Method | Endpoint | Description |
|---|---|---|
| GET | /v3/customfields |
Gets all custom field definitions. |