Skip to main content
Glama

analyticsdata.properties.batchRunReports

Run multiple Google Analytics reports for one property in a single batch request, returning combined JSON responses for dashboards or bulk reporting.

Instructions

Returns multiple reports in a batch. All reports must be for the same Google Analytics property [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON BatchRunReportsRequest object accepting requests; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, checkCompatibility, getMetadata, runPivotReport, runRealtimeReport, runReport.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
dry_runNoReturn the request that would be sent, without sending it.
propertyYes[URL path segment] A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID]
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON BatchRunReportsRequest object.
request_bodyNoRequest body of type BatchRunReportsRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
kindNo
reportsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / body_file / description
      Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON BatchRunReportsRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type BatchRunReportsRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "requests": {
      +      "items": {
      +        "properties": {
      +          "cohortSpec": {
      +            "properties": {
      +              "cohortReportSettings": {
      +                "properties": {
      +                  "accumulate": {
      +                    "type": "boolean"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "cohorts": {
      +                "items": {
      +                  "properties": {
      +                    "dateRange": {
      +                      "type": "object"
      +                    },
      +                    "dimension": {
      +                      "type": "string"
      +                    },
      +                    "name": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "cohortsRange": {
      +                "properties": {
      +                  "endOffset": {
      +                    "type": "integer"
      +                  },
      +                  "granularity": {
      +                    "enum": [
      +                      "GRANULARITY_UNSPECIFIED",
      +                      "DAILY",
      +                      "WEEKLY",
      +                      "MONTHLY"
      +                    ],
      +                    "type": "string"
      +                  },
      +                  "startOffset": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "comparisons": {
      +            "items": {
      +              "properties": {
      +                "comparison": {
      +                  "type": "string"
      +                },
      +                "dimensionFilter": {
      +                  "properties": {
      +                    "andGroup": {
      +                      "type": "object"
      +                    },
      +                    "filter": {
      +                      "type": "object"
      +                    },
      +                    "notExpression": {
      +                      "type": "object"
      +                    },
      +                    "orGroup": {
      +                      "type": "object"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "name": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "currencyCode": {
      +            "type": "string"
      +          },
      +          "dateRanges": {
      +            "items": {
      +              "properties": {
      +                "endDate": {
      +                  "type": "string"
      +                },
      +                "name": {
      +                  "type": "string"
      +                },
      +                "startDate": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "dimensionFilter": {
      +            "properties": {
      +              "andGroup": {
      +                "properties": {
      +                  "expressions": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "filter": {
      +                "properties": {
      +                  "betweenFilter": {
      +                    "type": "object"
      +                  },
      +                  "emptyFilter": {
      +                    "type": "object"
      +                  },
      +                  "fieldName": {
      +                    "type": "string"
      +                  },
      +                  "inListFilter": {
      +                    "type": "object"
      +                  },
      +                  "numericFilter": {
      +                    "type": "object"
      +                  },
      +                  "stringFilter": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "notExpression": {
      +                "properties": {
      +                  "andGroup": {
      +                    "type": "object"
      +                  },
      +                  "filter": {
      +                    "type": "object"
      +                  },
      +                  "notExpression": {
      +                    "type": "object"
      +                  },
      +                  "orGroup": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "orGroup": {
      +                "properties": {
      +                  "expressions": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "dimensions": {
      +            "items": {
      +              "properties": {
      +                "dimensionExpression": {
      +                  "properties": {
      +                    "concatenate": {
      +                      "type": "object"
      +                    },
      +                    "lowerCase": {
      +                      "type": "object"
      +                    },
      +                    "upperCase": {
      +                      "type": "object"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "name": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "keepEmptyRows": {
      +            "type": "boolean"
      +          },
      +          "limit": {
      +            "type": "string"
      +          },
      +          "metricAggregations": {
      +            "items": {
      +              "enum": [
      +                "METRIC_AGGREGATION_UNSPECIFIED",
      +                "TOTAL",
      +                "MINIMUM",
      +                "MAXIMUM",
      +                "COUNT"
      +              ],
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "metricFilter": {
      +            "properties": {
      +              "andGroup": {
      +                "properties": {
      +                  "expressions": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "filter": {
      +                "properties": {
      +                  "betweenFilter": {
      +                    "type": "object"
      +                  },
      +                  "emptyFilter": {
      +                    "type": "object"
      +                  },
      +                  "fieldName": {
      +                    "type": "string"
      +                  },
      +                  "inListFilter": {
      +                    "type": "object"
      +                  },
      +                  "numericFilter": {
      +                    "type": "object"
      +                  },
      +                  "stringFilter": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "notExpression": {
      +                "properties": {
      +                  "andGroup": {
      +                    "type": "object"
      +                  },
      +                  "filter": {
      +                    "type": "object"
      +                  },
      +                  "notExpression": {
      +                    "type": "object"
      +                  },
      +                  "orGroup": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "orGroup": {
      +                "properties": {
      +                  "expressions": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "metrics": {
      +            "items": {
      +              "properties": {
      +                "expression": {
      +                  "type": "string"
      +                },
      +                "invisible": {
      +                  "type": "boolean"
      +                },
      +                "name": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "offset": {
      +            "type": "string"
      +          },
      +          "orderBys": {
      +            "items": {
      +              "properties": {
      +                "desc": {
      +                  "type": "boolean"
      +                },
      +                "dimension": {
      +                  "properties": {
      +                    "dimensionName": {
      +                      "type": "string"
      +                    },
      +                    "orderType": {
      +                      "enum": [
      +                        "ORDER_TYPE_UNSPECIFIED",
      +                        "ALPHANUMERIC",
      +                        "CASE_INSENSITIVE_ALPHANUMERIC",
      +                        "NUMERIC"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "metric": {
      +                  "properties": {
      +                    "metricName": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "pivot": {
      +                  "properties": {
      +                    "metricName": {
      +                      "type": "string"
      +                    },
      +                    "pivotSelections": {
      +                      "items": {
      +                        "type": "object"
      +                      },
      +                      "type": "array"
      +                    }
      +                  },
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "property": {
      +            "type": "string"
      +          },
      +          "returnPropertyQuota": {
      +            "type": "boolean"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / property / description
      Previous value: -"A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID]"New value: +"[URL path segment] A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID]"
    • addedInput schema / properties / property / pattern
      Added value: +"^properties/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "kind": {
      +      "type": "string"
      +    },
      +    "reports": {
      +      "items": {
      +        "properties": {
      +          "dimensionHeaders": {
      +            "items": {
      +              "properties": {
      +                "name": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "kind": {
      +            "type": "string"
      +          },
      +          "maximums": {
      +            "items": {
      +              "properties": {
      +                "dimensionValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "metricValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "metadata": {
      +            "properties": {
      +              "currencyCode": {
      +                "type": "string"
      +              },
      +              "dataLossFromOtherRow": {
      +                "type": "boolean"
      +              },
      +              "dataTruncationReasons": {
      +                "items": {
      +                  "properties": {
      +                    "dataTruncationDate": {
      +                      "type": "string"
      +                    },
      +                    "dataTruncationDateRanges": {
      +                      "items": {
      +                        "type": "object"
      +                      },
      +                      "type": "array"
      +                    },
      +                    "dataTruncationMessage": {
      +                      "type": "string"
      +                    },
      +                    "dataTruncationType": {
      +                      "enum": [
      +                        "DATA_TRUNCATION_TYPE_UNSPECIFIED",
      +                        "DATA_TRUNCATION_TYPE_RULES_BASED_MODELS",
      +                        "DATA_TRUNCATION_TYPE_DATA_DRIVEN_ATTRIBUTION",
      +                        "DATA_TRUNCATION_TYPE_DV360",
      +                        "DATA_TRUNCATION_TYPE_CM360",
      +                        "DATA_TRUNCATION_TYPE_ITEM_SCOPED_ECOMMERCE_METRICS",
      +                        "DATA_TRUNCATION_TYPE_EVENT_SCOPED_ECOMMERCE_METRICS",
      +                        "DATA_TRUNCATION_TYPE_DATE_RANGE",
      +                        "DATA_TRUNCATION_TYPE_PROPERTY",
      +                        "DATA_TRUNCATION_TYPE_CONVERSIONS",
      +                        "DATA_TRUNCATION_TYPE_GOOGLE_ADS"
      +                      ],
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "emptyReason": {
      +                "type": "string"
      +              },
      +              "samplingMetadatas": {
      +                "items": {
      +                  "properties": {
      +                    "samplesReadCount": {
      +                      "type": "string"
      +                    },
      +                    "samplingSpaceSize": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "schemaRestrictionResponse": {
      +                "properties": {
      +                  "activeMetricRestrictions": {
      +                    "items": {
      +                      "type": "object"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "subjectToThresholding": {
      +                "type": "boolean"
      +              },
      +              "timeZone": {
      +                "type": "string"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "metricHeaders": {
      +            "items": {
      +              "properties": {
      +                "name": {
      +                  "type": "string"
      +                },
      +                "type": {
      +                  "enum": [
      +                    "METRIC_TYPE_UNSPECIFIED",
      +                    "TYPE_INTEGER",
      +                    "TYPE_FLOAT",
      +                    "TYPE_SECONDS",
      +                    "TYPE_MILLISECONDS",
      +                    "TYPE_MINUTES",
      +                    "TYPE_HOURS",
      +                    "TYPE_STANDARD",
      +                    "TYPE_CURRENCY",
      +                    "TYPE_FEET",
      +                    "TYPE_MILES",
      +                    "TYPE_METERS",
      +                    "TYPE_KILOMETERS"
      +                  ],
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "minimums": {
      +            "items": {
      +              "properties": {
      +                "dimensionValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "metricValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "propertyQuota": {
      +            "properties": {
      +              "concurrentRequests": {
      +                "properties": {
      +                  "consumed": {
      +                    "type": "integer"
      +                  },
      +                  "remaining": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "potentiallyThresholdedRequestsPerHour": {
      +                "properties": {
      +                  "consumed": {
      +                    "type": "integer"
      +                  },
      +                  "remaining": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "serverErrorsPerProjectPerHour": {
      +                "properties": {
      +                  "consumed": {
      +                    "type": "integer"
      +                  },
      +                  "remaining": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "tokensPerDay": {
      +                "properties": {
      +                  "consumed": {
      +                    "type": "integer"
      +                  },
      +                  "remaining": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "tokensPerHour": {
      +                "properties": {
      +                  "consumed": {
      +                    "type": "integer"
      +                  },
      +                  "remaining": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "tokensPerProjectPerHour": {
      +                "properties": {
      +                  "consumed": {
      +                    "type": "integer"
      +                  },
      +                  "remaining": {
      +                    "type": "integer"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "rowCount": {
      +            "type": "integer"
      +          },
      +          "rows": {
      +            "items": {
      +              "properties": {
      +                "dimensionValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "metricValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "totals": {
      +            "items": {
      +              "properties": {
      +                "dimensionValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                },
      +                "metricValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.6/5.0
Behavior4/5

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

With no annotations, the description does the heavy lifting: it discloses HTTP POST, classifies the operation as change-triggering and refused under --readonly profiles, and states the response is the API's resource as JSON. It also explains the two body input routes (`params` merge vs `body_file`). It stops short of quota/rate-limit or error behavior for a batched analytics query.

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

Conciseness3/5

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

Purpose is front-loaded, but the middle sentence chains three clauses with em dashes ('Returns the API's response resource as JSON — request body is a JSON BatchRunReportsRequest object accepting requests; pass it via params or whole via body_file'), which reads as spliced rather than structured. Nothing is padded, but the density hurts scanability.

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 deeply nested request-body tool, the definition covers method, side-effect profile, body-passing mechanism, and the shared-property constraint; an output schema exists so return values need no elaboration. The remaining gap is guidance on how the batched `requests` entries are composed and any quota implications of batching.

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 the nested BatchRunReportsRequest fields are self-documented, so the baseline is 3. The description adds only a little beyond that: it identifies the request body type and where to put it (`params` or `body_file`) and mentions the required property path, but adds no semantics for the nested `requests` array items.

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?

The description opens with a specific verb and resource ('Returns multiple reports in a batch') and adds a real constraint: all reports must target the same property. It also enumerates the analyticsdata siblings (runReport, batchRunPivotReports, etc.), so the agent can see the family, though it does not explain how this tool differs from a plain runReport beyond the word 'batch'.

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: 'multiple reports in a batch' plus the same-property constraint hints at batching, and the readonly-profile refusal is genuinely useful context. But there is no explicit routing guidance such as 'use runReport for one report, this for many' or 'prefer batchRunPivotReports when you need pivots', even though the sibling list is right there.

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

Deploy Server

Other Tools