zohoApiUsage

Requires permission settings:integration:read.

Returns today's Zoho API usage as a JSON string: calls made, the daily limit, whether the 80 and 95 percent thresholds were reached, and the percent used. Requires permission to read integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ZohoApiUsage {
  zohoApiUsage
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ZohoApiUsage {\n  zohoApiUsage\n}"
}
EOF

Response:

{
  "data": {
    "zohoApiUsage": "string"
  }
}

zohoApiUsage(
  organizationId: String
): String

Arguments

zohoApiUsage.organizationId ● String scalar

Deprecated — org comes from the JWT

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.