Get Document Metrics

Retrieves content metrics for a specific document, including the count of characters, words, sentences, comments, and tracked changes.

Endpoints

get https://www.zohoapis.com/writer/api/v1/documents/{document_id}/metrics

Copy full URL

OAuth Scope

ZohoWriter.documentEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL, WorkDrive.workspace.ALLCopied!

curl --request GET \
  --url https://www.zohoapis.com/writer/api/v1/documents/a1b2c3d4e5f6g7h8i9/metrics \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/writer/api/v1/documents/{document_id}/metrics"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

Path Parameters

document_idstring(Required)

The unique ID of the document.

  {
    "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