Get statistics on a document
Contents
[
Hide
]
Returns statistics on a Word document.
Get statistics on a Word document REST API
Server: https://api.aspose.cloud/v4.0
| Method | Endpoint |
|---|---|
| PUT | /words/online/get/statistics |
| Parameter Name | Data Type | Required/Optional | Description |
|---|---|---|---|
loadEncoding |
string | Optional | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password |
string | Optional | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
encryptedPassword |
string | Optional | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
includeComments |
boolean | Optional | The flag indicating whether to include comments from the WordCount. The default value is “false”. |
includeFootnotes |
boolean | Optional | The flag indicating whether to include footnotes from the WordCount. The default value is “false”. |
includeTextInShapes |
boolean | Optional | The flag indicating whether to include shape’s text from the WordCount. The default value is “false”. |
Note: Requires Client Id and Secret. See Quick Start to obtain credentials.
Response
Response model: StatDataResponse
| Field | Type | Description |
|---|---|---|
| Model | StatDataResponse | The REST response with document’s statistical data. |
Error reference
| Status | Code | Description | Resolution |
|---|---|---|---|
| 400 | bad_request |
Invalid parameter value or missing required field | Check the parameter format and ensure all required fields are provided |
| 401 | unauthorized |
Missing or invalid access token | Obtain a new access token via the authentication endpoint |
| 403 | forbidden |
Access to the requested resource is denied | Verify that the access token has the required permissions |
| 404 | not_found |
The requested resource does not exist | Check the resource ID or path for typos |
| 429 | rate_limited |
Too many requests — rate limit exceeded | Wait for the Retry-After period before making another request |
| 500 | internal_error |
An unexpected server error occurred | Retry the request after a short delay; contact support if the issue persists |
Usage examples
REST API
SDK
See Also
- Cloud SDKs — Create, Edit, Convert and Render Word documents via REST API.