Skip to main content
Glama
apify-insights

apify-insights

by Devansh-365

Revenue summary

revenue_summary
Read-onlyIdempotent

Summarize account revenue, cost, profit, and margin for a chosen period, optionally comparing results with the previous period or the same days last month.

Instructions

Account revenue, cost, profit and margin for any period (yesterday, last7d, a month, a date range), optionally compared with the previous period or the same days last month.

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": "revenue_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
periodNotoday | yesterday | last7d | last30d (both end yesterday) | thisMonth | lastMonth | "YYYY-MM" | {from, to} (YYYY-MM-DD, max 12 months)thisMonth
audienceNopaying = money from paying users (what you earn); all = includes free-plan users.paying
compareToNoAdds the same figures for the comparison period and the change.
includeDailyNoAdd one revenue/profit row per day (periods up to 62 days).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, openWorld and non-destructive, so the safety profile is covered. The description adds the useful behavioural note that comparisons return the same figures for a comparison window plus the change, but says nothing about aggregation semantics, currency, empty-result handling, or the 12-month cap that lives only in the schema.

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?

A single sentence with the resource and metrics front-loaded and no filler. It is slightly wasteful in re-enumerating period examples that the schema already spells out, but nothing is padded or buried.

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

Completeness4/5

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

For a read-only aggregate with full schema coverage and no output schema, naming the four returned metrics and the comparison behaviour is enough for an agent to call it correctly. Remaining gaps (currency, null/empty periods) are minor.

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 100% and each parameter already carries a precise description, including the max-12-month limit and the 62-day daily-row cap. The description only restates the period variants and the comparison concept, adding no syntax or edge-case meaning beyond the schema.

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

Purpose4/5

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

States a specific set of returned metrics (revenue, cost, profit, margin) plus the scoping dimension (any period) in a single front-loaded phrase. It is clearly distinguishable from per-actor siblings like actor_profitability or list_actors, though it never names an alternative explicitly.

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

Usage Guidelines3/5

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

Usage is implied rather than stated: an agent can infer this is the tool for period-based account-wide money metrics, and the mention of optional comparison hints at the comparison use case. There is no explicit when-not guidance or routing to a sibling report.

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