Count APIs

Count APIs

Zoho's list of count APIs allows you to determine the number of documents, presentations and spreadsheets present in your Zoho account. It also provides details of the number of shared, published and trashed documents for the said account.

Request URI:

Developers can send the request in the following URI format :

Zoho Writer (Documents) :

https://writer.zoho.com/api/<access>/<format>/documents/count?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI

Zoho Sheet (Spreadsheets) :

https://sheet.zoho.com/api/<access>/<format>/books/count?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI

Zoho Show (Presentations) :

https://show.zoho.com/api/<access>/<format>/presentations/count?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI

Access : private only

Format : xml, json

HTTPs Method : GET

Document Count Methods :

Method Name	URI Request	Description
Count of all the documents	Writer: https://writer.zoho.com/api/private/xml/documents/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet: https://sheet.zoho.com/api/private/xml/books/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show: https://show.zoho.com/api/private/xml/presentations/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI	Gets the count of a number of documents, spreadsheets and presentations present in a user's Zoho Account.
Count of all "shared" documents	Writer: https://writer.zoho.com/api/private/xml/incomingdocuments/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet: https://sheet.zoho.com/api/private/xml/incomingbooks/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show: https://show.zoho.com/api/private/xml/incomingpresentations/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI	Gets the count of a number of documents, spreadsheets and presentations that have been "shared" to a user's Zoho Account.
Count of all "trashed" documents	Writer: https://writer.zoho.com/api/private/xml/trasheddocuments/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet: https://sheet.zoho.com/api/private/xml/trashedbooks/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show: https://show.zoho.com/api/private/xml/trashedpresentations/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI	Gets the count of a number of documents, spreadsheets and presentations that have been "trashed" from a user's Zoho Account.
Count of all "public" documents	Writer: https://writer.zoho.com/api/private/xml/publicdocuments/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet: https://public.sheet.zoho.com/api/public/xml/books/user/[username]?apikey=[APIKey] Show: https://show.zoho.com/api/private/xml/publicpresentations/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI	Gets the count of a number of documents, spreadsheets and presentations that have been made "public" from a user's Zoho Account.
Count of all the tags	Writer: https://writer.zoho.com/api/private/xml/tags/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Sheet: https://sheet.zoho.com/api/private/xml/tags/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI Show: https://show.zoho.com/api/private/xml/tags/count?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI	Gets the count of all the tags associated with Writer, Sheet & Show Service for a user's Zoho account..

Response Parameters Reference

Documents :

Parameter	Value	Description
ownerName	string	Name of the user having his account with Zoho.
documentsCount	integer	Number of documents present in the users' Zoho Writer account. (Owned, Shared, Trashed or Public)

Spreadsheets :

Parameter	Value	Description
ownerName	string	Name of the user having his account with Zoho.
workbooksCount	integer	Number of spreadsheets present in the users' Zoho Sheet account. (Owned, Shared, Trashed or Public)

Presentations :

Parameter	Value	Description
ownerName	string	Name of the user having his account with Zoho.
presentationsCount	integer	Number of presentations in the users' Zoho Sheet account. (Owned, Shared, Trashed or Public)

Tags Count :

Parameter	Value	Description
ownerName	string	Name of the user having his account with Zoho.
tagsCount	integer	Number of tags in the users' Zoho Writer/Sheet/Show account.

Sample Response :

The following is a response (both in XML & JSON) that gets a count of the number of Zoho Writer documents in a user's Zoho account.

XML

<?xml version="1.0" encoding="UTF-8" ?> 
<response uri="/api/private/xml/documents/count">
<result>
    <documents>
        <ownerName>johndoe</ownerName> 
        <documentsCount>57</documentsCount>
    </documents>
</result>
</response>

JSON

{
    "response": 
    {
        "uri": "/api/private/json/documents/count",
        "result":
        {
            "documents":
            {
                "ownerName":"johndoe",
                "documentsCount":"57"
            } 
        }
    }
}

Comments (0)

RSS of this page

Zoho API Guide

Count APIs