- Getting Started
- OAuth 2.0
- Authorizing OAuth Requests
- HTTP Methods
- HTTP status code summary
- API Collection
- Document API
- Template API
- Automation API
- Merge API
- Combine API
- Bulk API
- POSTSign API
- Meta API
- Conversion API
- Folder API
- Publish API
- Errors
- General Errors
- Get List of Documents - Possible Errors
- Create Document - Possible Errors
- Download Document - Possible Errors
- Document Operations - Possible Errors
- Copy Document - Possible errors
- Translate Document - Possible errors
- Template API - Possible errors
- Conversion API - Possible Errors
- Folder API - Possible Errors
- Publish API - Possible Errors
- Meta API - Possible Errors
- Sign API - Possible Errors
- Merge API - Possible Errors
- Combine PDFs - Possible errors
Get Document Metrics
Purpose
To get the count of the characters, words, sentences, comments and tracked changes present in the document.
HTTP Request URL
https://{zohoapis_domain}/writer/api/v1/documents/{{document_id}}/metrics
Path Parameters
Parameter | Data Type | Description |
Mandatory Parameters | ||
document_id | String | Specify the unique id for the Writer document. |
Note: This API is subject to throttle limits. For details on the applicable rate limits, please refer to this help link.
Sample Request
Copiedcurl "https://www.zohoapis.com/writer/api/v1/documents/2cjnf4c008254df9694b565fdc1a/metrics"
-X GET
-H "Authorization: Zoho-oauthtoken xyz"
Sample Response
Copied{
"comments_metrics": {
"all": 1,
"unresolved": 0,
"resolved": 1
},
"content_metrics": {
"number_of_sentences": 31,
"number_of_characters": 1817,
"number_of_words": 263,
"number_of_characters_without_whitespaces": 1557
},
"tracked_changes_metrics": {
"all": 3,
"insertions": 1,
"deletions": 1,
"replacements": 1,
"fields_updated": 0
}
}
Show full
Show less
© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.