Gumlet

retrieve_analytics

Read-onlyIdempotent

This endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "retrieve_analytics"
  }
}

Input Schema

Name	Required	Description	Default
`filters`	No
`metrics`	No	Define the metric you need the data for. Supported values: `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `drm_requests`, `ai_credit_usage`, and `errored_videos`.
`group_by`	No	Group by hourly, daily or monthly. If you don't specify anything it's `hourly` by default.	hourly
`date_range`	No	The timeframe to get the data for. Currently we only support a maximum of 60 days between `start_at` and `end_at`.
`top_assets_page`	No	top_assets metric may get paginated response. Iterate this parameter to get more data.	0
`top_assets_count`	No	Count of video assets that should be returned. Max assets count is 1000 per page.	5

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedNov 9, 2026

changedInput schema / properties / filters / properties / collection_id / description

Previous value: -"The ID of the `workspace` you want to filter the data for."New value: +"Deprecated. Use `workspace_id` instead. Still accepted for backwards compatibility."

changedInput schema / properties / filters / properties / source_id / description

Previous value: -"The ID of the `workspace` you want to filter the data for. Deprecated."New value: +"Deprecated. Use `workspace_id` instead. Still accepted for backwards compatibility."

addedInput schema / properties / filters / properties / workspace_id

Added value: +{
+  "description": "Gumlet video workspace ID. Preferred over deprecated `collection_id` / `source_id` (same ID).",
+  "examples": [
+    "646df1c9173a4a2fcac180b4"
+  ],
+  "type": "string"
+}

changedInput schema / properties / filters / x-apidog-orders

Previous value: -[
-  "collection_id",
-  "source_id"
-]New value: +[
+  "workspace_id",
+  "collection_id",
+  "source_id"
+]

First observedNov 4, 2026

TDQS

C2.7/5.0

Behavior2/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so safety is covered. The description adds no behavioral context beyond that: it does not mention that date ranges are capped at 60 days, that top_assets results are paginated and must be iterated, or that metrics must be requested explicitly — all behaviors an agent would benefit from knowing up front.

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

Conciseness4/5

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

Two short sentences with the resource named first and examples second; no filler. The informal "Ex -" phrasing is slightly loose but the definition is compact and front-loaded.

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?

An output schema exists, so return values need not be explained, and the schema documents most parameters. However, for a 6-parameter nested analytics tool sitting among a dozen analytics siblings, the description leaves the key differentiators and constraints (60-day cap, pagination, metric selection) to the schema.

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 83%, so parameters are largely self-documenting, making 3 the baseline. The description's only parameter-related contribution is naming two sample metric values (top assets, bandwidth consumption), which the metrics enum already enumerates.

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

Purpose3/5

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

The description states a general verb+resource ("gives usage analytics data of your videos") and offers two examples ("top assets, bandwidth consumption"). But it never distinguishes this tool from the many analytics siblings such as analytics_aggregated_data, analytics_breakdown_data, asset_analytics, insights_aggregated_data, top_assets, and viewer_analytics_data, so an agent cannot tell which analytics endpoint to pick.

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

Usage Guidelines2/5

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

There is no when-to-use guidance at all: no mention of when this general analytics endpoint should be chosen over the aggregated/breakdown/asset/viewer analytics siblings. The examples hint at content but not at selection criteria or exclusions.

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

All Gumlet tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?