Skip to Content
AI Agents (MCP)Tool referenceget_environment_breakdown

get_environment_breakdown

How a product’s installations are spread. WordPress, PHP and plugin versions, locale, country and edition come from every installation’s own reports, with counts and share of installations_count. Active theme and the most common other active plugins come from environment reports, which only some sites send: installations_with_environment_count says how many, and their shares are of that number. Active installations by default; status=all includes deactivated and removed ones. Results are cached for up to 10 minutes (as_of says when they were computed). Costs 3 rate-limit units.

  • Server: Organization server
  • Scope: analytics:read
  • Read-only: yes

Input

{ "properties": { "product": { "description": "The product id (UUID) or slug, as list_products returns them.", "type": "string" }, "status": { "description": "Default active.", "enum": [ "active", "all" ], "type": "string" }, "top": { "description": "Values per dimension, default 10.", "minimum": 1, "maximum": 50, "type": "integer" } }, "type": "object", "required": [ "product" ] }

Output (structuredContent)

{ "properties": { "as_of": { "type": "string" }, "product_id": { "type": "string" }, "status": { "type": "string" }, "installations_count": { "type": "integer" }, "installations_with_environment_count": { "type": "integer" }, "wordpress_version": { "items": { "properties": { "value": { "type": [ "string", "null" ] }, "count": { "type": "integer" }, "pct": { "type": "number" } }, "type": "object" }, "type": "array" }, "php_version": { "items": { "properties": { "value": { "type": [ "string", "null" ] }, "count": { "type": "integer" }, "pct": { "type": "number" } }, "type": "object" }, "type": "array" }, "plugin_version": { "items": { "properties": { "value": { "type": [ "string", "null" ] }, "count": { "type": "integer" }, "pct": { "type": "number" } }, "type": "object" }, "type": "array" }, "locale": { "items": { "properties": { "value": { "type": [ "string", "null" ] }, "count": { "type": "integer" }, "pct": { "type": "number" } }, "type": "object" }, "type": "array" }, "country": { "items": { "properties": { "value": { "type": [ "string", "null" ] }, "count": { "type": "integer" }, "pct": { "type": "number" } }, "type": "object" }, "type": "array" }, "edition": { "items": { "properties": { "value": { "type": [ "string", "null" ] }, "count": { "type": "integer" }, "pct": { "type": "number" } }, "type": "object" }, "type": "array" }, "theme": { "type": "array" }, "co_installed_plugins": { "type": "array" } }, "type": "object", "required": [ "as_of", "product_id", "status", "installations_count", "installations_with_environment_count" ] }