zscaler-mcp-server

Official

by zscaler

Overview Schema Source Related Servers Discussions Admin

Python

Hybrid

zins_get_web_traffic_by_location

Read-only

Get web traffic aggregated per location. Read-only analytics.

Instructions

Get web traffic aggregated per location. Read-only analytics.

Each row is a location with its total transactions or bytes; pass include_trend=True for the per-location time-series under trend. Window must be a 7- or 14-day historical interval (see the time-window inputs).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`limit`	No
`query`	No	Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Examples: "[?enabled==`true`]", "[*].{name: name, id: id}", "length(@)". Omit to get the full records. IMPORTANT: field names are the keys of the returned records, which are usually snake_case (`custom_category`) even where the Zscaler API documents camelCase (`customCategory`) — guessing the spelling yields an empty list that looks like a real answer. If you have not already seen a record from this tool, call it once without `query` and read the keys off the response.
`end_time`	No
`start_time`	No
`end_days_ago`	No
`traffic_unit`	No		TRANSACTIONS
`include_trend`	No
`start_days_ago`	No
`trend_interval`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed12 schema fields changedv0.15.3Aug 19, 2026

removedInput schema / additionalProperties
```
Removed value: -false
```
addedInput schema / properties / end_days_ago / title
```
Added value: +"End Days Ago"
```
addedInput schema / properties / end_time / title
```
Added value: +"End Time"
```
addedInput schema / properties / include_trend / title
```
Added value: +"Include Trend"
```
addedInput schema / properties / limit / title
```
Added value: +"Limit"
```

changedInput schema / properties / query / description

Previous value: -"Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Field names are exactly what the Zscaler API returns. Examples: \"[?enabled==`true`]\", \"[*].{name: name, id: id}\", \"length(@)\". Omit to get the full records."New value: +"Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Examples: \"[?enabled==`true`]\", \"[*].{name: name, id: id}\", \"length(@)\". Omit to get the full records. IMPORTANT: field names are the keys of the returned records, which are usually snake_case (`custom_category`) even where the Zscaler API documents camelCase (`customCategory`) — guessing the spelling yields an empty list that looks like a real answer. If you have not already seen a record from this tool, call it once without `query` and read the keys off the response."

addedInput schema / properties / query / title
```
Added value: +"Query"
```
addedInput schema / properties / start_days_ago / title
```
Added value: +"Start Days Ago"
```
addedInput schema / properties / start_time / title
```
Added value: +"Start Time"
```
addedInput schema / properties / traffic_unit / title
```
Added value: +"Traffic Unit"
```
addedInput schema / properties / trend_interval / title
```
Added value: +"Trend Interval"
```

addedInput schema / title

Added value: +"zins_get_web_traffic_by_locationArguments"

Changed20 schema fields changedv0.14.0Jul 28, 2026

addedInput schema / additionalProperties
```
Added value: +false
```

removedInput schema / properties / end_days_ago / description

Removed value: -"Days ago for end. Default: 2. Interval = start - end must be 7 or 14."

removedInput schema / properties / end_days_ago / title
```
Removed value: -"End Days Ago"
```

removedInput schema / properties / end_time / description

Removed value: -"ALTERNATIVE: End time as Unix epoch in MILLISECONDS. Only use if you need a specific timestamp. Overrides end_days_ago."

removedInput schema / properties / end_time / title
```
Removed value: -"End Time"
```

removedInput schema / properties / include_trend / description

Removed value: -"Include trend data showing traffic patterns over time."

removedInput schema / properties / include_trend / title
```
Removed value: -"Include Trend"
```

removedInput schema / properties / limit / description

Removed value: -"Maximum number of location entries to return (1-1000)."

removedInput schema / properties / limit / title
```
Removed value: -"Limit"
```

addedInput schema / properties / query

Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Optional JMESPath expression applied to the results after the API call, for client-side filtering and projection. Field names are exactly what the Zscaler API returns. Examples: \"[?enabled==`true`]\", \"[*].{name: name, id: id}\", \"length(@)\". Omit to get the full records."
+}

removedInput schema / properties / start_days_ago / description

Removed value: -"Days ago for start. Default: 9 (7-day interval with end=2). API requires intervals of exactly 7 or 14 days. For 14-day use 16."

removedInput schema / properties / start_days_ago / title
```
Removed value: -"Start Days Ago"
```

removedInput schema / properties / start_time / description

Removed value: -"ALTERNATIVE: Start time as Unix epoch in MILLISECONDS. Only use if you need a specific timestamp. Overrides start_days_ago."

removedInput schema / properties / start_time / title
```
Removed value: -"Start Time"
```

removedInput schema / properties / traffic_unit / description

Removed value: -"Traffic measurement unit. Values: TRANSACTIONS, BYTES"

removedInput schema / properties / traffic_unit / title
```
Removed value: -"Traffic Unit"
```

removedInput schema / properties / trend_interval / description

Removed value: -"Trend interval for time series data. Values: DAY, HOUR. Only applicable when include_trend=True."

removedInput schema / properties / trend_interval / title
```
Removed value: -"Trend Interval"
```

removedInput schema / title

Removed value: -"zins_get_web_traffic_by_locationArguments"

changedOutput schema / (root)

Previous value: -{
-  "properties": {
-    "result": {
-      "items": {
-        "additionalProperties": true,
-        "type": "object"
-      },
-      "title": "Result",
-      "type": "array"
-    }
-  },
-  "required": [
-    "result"
-  ],
-  "title": "zins_get_web_traffic_by_locationOutput",
-  "type": "object"
-}New value: +null

First observedv0.12.7Jun 24, 2026

TDQS

A4.1/5.0

Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare readOnlyHint, and the description adds beyond that: row structure per location, the include_trend=True behavior producing a time-series under `trend`, and the window constraint. No annotation contradiction exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tightly written sentences: purpose first, then row/trend behavior, then constraint. Every sentence earns its place and there is no filler or redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 9 parameters and no output schema, the description gives a useful high-level response shape but leaves many parameter interactions and defaults undocumented. It is adequate for orientation but not fully complete for such a parameter-rich tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 11%, so the description must compensate. It does add meaning for include_trend, hints at traffic_unit via "transactions or bytes," and points to time-window inputs. However, limit, start_time/end_time, start_days_ago/end_days_ago, and trend_interval remain largely unexplained.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Description opens with a specific verb and resource: "Get web traffic aggregated per location." The aggregation-by-location qualifier clearly distinguishes this from sibling tools like zins_get_web_traffic_no_grouping, making the tool's purpose immediately identifiable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear usage context: read-only analytics and the required 7- or 14-day historical window. It does not explicitly name alternatives or state when not to use this tool, so it falls short of the top score.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

zins_get_web_traffic_by_location

Instructions

Input Schema

Schema Changelog

TDQS

Other Tools