Skip to main content
Glama

analyticsdata.properties.runPivotReport

Runs a customized Google Analytics pivot report to dissect event data across multiple pivots and returns the API response as JSON.

Instructions

Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data [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 RunPivotReportRequest object accepting cohortSpec, comparisons, currencyCode, dateRanges, dimensionFilter, dimensions, keepEmptyRows, metricFilter and 4 more fields; pass it via params or whole via body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, checkCompatibility, getMetadata, 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 RunPivotReportRequest object.
request_bodyNoRequest body of type RunPivotReportRequest: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
kindNo
rowsNo
metadataNo
aggregatesNo
pivotHeadersNo
metricHeadersNo
propertyQuotaNo
dimensionHeadersNo

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 RunPivotReportRequest object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type RunPivotReportRequest: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "cohortSpec": {
      +      "properties": {
      +        "cohortReportSettings": {
      +          "properties": {
      +            "accumulate": {
      +              "type": "boolean"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "cohorts": {
      +          "items": {
      +            "properties": {
      +              "dateRange": {
      +                "properties": {
      +                  "endDate": {
      +                    "type": "string"
      +                  },
      +                  "name": {
      +                    "type": "string"
      +                  },
      +                  "startDate": {
      +                    "type": "string"
      +                  }
      +                },
      +                "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": {
      +                "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"
      +          },
      +          "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": {
      +                "properties": {
      +                  "andGroup": {
      +                    "type": "object"
      +                  },
      +                  "filter": {
      +                    "type": "object"
      +                  },
      +                  "notExpression": {
      +                    "type": "object"
      +                  },
      +                  "orGroup": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "filter": {
      +          "properties": {
      +            "betweenFilter": {
      +              "properties": {
      +                "fromValue": {
      +                  "type": "object"
      +                },
      +                "toValue": {
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "emptyFilter": {
      +              "type": "object"
      +            },
      +            "fieldName": {
      +              "type": "string"
      +            },
      +            "inListFilter": {
      +              "properties": {
      +                "caseSensitive": {
      +                  "type": "boolean"
      +                },
      +                "values": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "numericFilter": {
      +              "properties": {
      +                "operation": {
      +                  "enum": [
      +                    "OPERATION_UNSPECIFIED",
      +                    "EQUAL",
      +                    "LESS_THAN",
      +                    "LESS_THAN_OR_EQUAL",
      +                    "GREATER_THAN",
      +                    "GREATER_THAN_OR_EQUAL"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "stringFilter": {
      +              "properties": {
      +                "caseSensitive": {
      +                  "type": "boolean"
      +                },
      +                "matchType": {
      +                  "enum": [
      +                    "MATCH_TYPE_UNSPECIFIED",
      +                    "EXACT",
      +                    "BEGINS_WITH",
      +                    "ENDS_WITH",
      +                    "CONTAINS",
      +                    "FULL_REGEXP",
      +                    "PARTIAL_REGEXP"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "notExpression": {
      +          "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"
      +        },
      +        "orGroup": {
      +          "properties": {
      +            "expressions": {
      +              "items": {
      +                "properties": {
      +                  "andGroup": {
      +                    "type": "object"
      +                  },
      +                  "filter": {
      +                    "type": "object"
      +                  },
      +                  "notExpression": {
      +                    "type": "object"
      +                  },
      +                  "orGroup": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "dimensions": {
      +      "items": {
      +        "properties": {
      +          "dimensionExpression": {
      +            "properties": {
      +              "concatenate": {
      +                "properties": {
      +                  "delimiter": {
      +                    "type": "string"
      +                  },
      +                  "dimensionNames": {
      +                    "items": {
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "lowerCase": {
      +                "properties": {
      +                  "dimensionName": {
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "upperCase": {
      +                "properties": {
      +                  "dimensionName": {
      +                    "type": "string"
      +                  }
      +                },
      +                "type": "object"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "keepEmptyRows": {
      +      "type": "boolean"
      +    },
      +    "metricFilter": {
      +      "properties": {
      +        "andGroup": {
      +          "properties": {
      +            "expressions": {
      +              "items": {
      +                "properties": {
      +                  "andGroup": {
      +                    "type": "object"
      +                  },
      +                  "filter": {
      +                    "type": "object"
      +                  },
      +                  "notExpression": {
      +                    "type": "object"
      +                  },
      +                  "orGroup": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "filter": {
      +          "properties": {
      +            "betweenFilter": {
      +              "properties": {
      +                "fromValue": {
      +                  "type": "object"
      +                },
      +                "toValue": {
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "emptyFilter": {
      +              "type": "object"
      +            },
      +            "fieldName": {
      +              "type": "string"
      +            },
      +            "inListFilter": {
      +              "properties": {
      +                "caseSensitive": {
      +                  "type": "boolean"
      +                },
      +                "values": {
      +                  "items": {
      +                    "type": "string"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "numericFilter": {
      +              "properties": {
      +                "operation": {
      +                  "enum": [
      +                    "OPERATION_UNSPECIFIED",
      +                    "EQUAL",
      +                    "LESS_THAN",
      +                    "LESS_THAN_OR_EQUAL",
      +                    "GREATER_THAN",
      +                    "GREATER_THAN_OR_EQUAL"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "object"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "stringFilter": {
      +              "properties": {
      +                "caseSensitive": {
      +                  "type": "boolean"
      +                },
      +                "matchType": {
      +                  "enum": [
      +                    "MATCH_TYPE_UNSPECIFIED",
      +                    "EXACT",
      +                    "BEGINS_WITH",
      +                    "ENDS_WITH",
      +                    "CONTAINS",
      +                    "FULL_REGEXP",
      +                    "PARTIAL_REGEXP"
      +                  ],
      +                  "type": "string"
      +                },
      +                "value": {
      +                  "type": "string"
      +                }
      +              },
      +              "type": "object"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        "notExpression": {
      +          "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"
      +        },
      +        "orGroup": {
      +          "properties": {
      +            "expressions": {
      +              "items": {
      +                "properties": {
      +                  "andGroup": {
      +                    "type": "object"
      +                  },
      +                  "filter": {
      +                    "type": "object"
      +                  },
      +                  "notExpression": {
      +                    "type": "object"
      +                  },
      +                  "orGroup": {
      +                    "type": "object"
      +                  }
      +                },
      +                "type": "object"
      +              },
      +              "type": "array"
      +            }
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "metrics": {
      +      "items": {
      +        "properties": {
      +          "expression": {
      +            "type": "string"
      +          },
      +          "invisible": {
      +            "type": "boolean"
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "pivots": {
      +      "items": {
      +        "properties": {
      +          "fieldNames": {
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "limit": {
      +            "type": "string"
      +          },
      +          "metricAggregations": {
      +            "items": {
      +              "enum": [
      +                "METRIC_AGGREGATION_UNSPECIFIED",
      +                "TOTAL",
      +                "MINIMUM",
      +                "MAXIMUM",
      +                "COUNT"
      +              ],
      +              "type": "string"
      +            },
      +            "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"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "property": {
      +      "type": "string"
      +    },
      +    "returnPropertyQuota": {
      +      "type": "boolean"
      +    }
      +  },
      +  "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": {
      +    "aggregates": {
      +      "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"
      +    },
      +    "dimensionHeaders": {
      +      "items": {
      +        "properties": {
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "kind": {
      +      "type": "string"
      +    },
      +    "metadata": {
      +      "properties": {
      +        "currencyCode": {
      +          "type": "string"
      +        },
      +        "dataLossFromOtherRow": {
      +          "type": "boolean"
      +        },
      +        "dataTruncationReasons": {
      +          "items": {
      +            "properties": {
      +              "dataTruncationDate": {
      +                "type": "string"
      +              },
      +              "dataTruncationDateRanges": {
      +                "items": {
      +                  "properties": {
      +                    "endDate": {
      +                      "type": "string"
      +                    },
      +                    "startDate": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "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": {
      +                "properties": {
      +                  "metricName": {
      +                    "type": "string"
      +                  },
      +                  "restrictedMetricTypes": {
      +                    "items": {
      +                      "enum": [
      +                        "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
      +                        "COST_DATA",
      +                        "REVENUE_DATA"
      +                      ],
      +                      "type": "string"
      +                    },
      +                    "type": "array"
      +                  }
      +                },
      +                "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"
      +    },
      +    "pivotHeaders": {
      +      "items": {
      +        "properties": {
      +          "pivotDimensionHeaders": {
      +            "items": {
      +              "properties": {
      +                "dimensionValues": {
      +                  "items": {
      +                    "properties": {
      +                      "value": {
      +                        "type": "string"
      +                      }
      +                    },
      +                    "type": "object"
      +                  },
      +                  "type": "array"
      +                }
      +              },
      +              "type": "object"
      +            },
      +            "type": "array"
      +          },
      +          "rowCount": {
      +            "type": "integer"
      +          }
      +        },
      +        "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"
      +    },
      +    "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"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does substantial work: it discloses that this is an HTTP POST that 'creates or triggers a change' despite being a query, that it is refused under --readonly profiles, and that it returns the API response resource as JSON. What it omits is quota/cost behavior and result-size limits, which matter for the Analytics Data API.

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?

It is front-loaded with purpose before mechanics, and every block (purpose, POST/readonly caveat, request/response shape, siblings) carries information. The single dense paragraph with em-dash clauses makes it harder to scan than it needs to be.

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

Completeness5/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 detailed, and the description still says the response resource comes back as JSON. For a tool with a very large nested request body, it supplies the essential context an agent needs: the body type, two ways to supply it, the mutating POST semantics, and which sibling to consider instead.

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%, so the baseline is 3. The description enumerates the RunPivotReportRequest body fields (cohortSpec, comparisons, currencyCode, dateRanges, dimensionFilter, dimensions, keepEmptyRows, metricFilter, plus 4 more) and the two delivery paths (`params` vs `body_file`), but that routing detail is already stated in the schema's own descriptions for params and body_file, so it adds little beyond structured data.

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?

States a specific verb and resource ('Returns a customized pivot report of your Google Analytics event data') and immediately contrasts it with regular reports, explaining that dimensions are only visible when included in a pivot. It also names the concrete sibling alternatives (runReport, batchRunPivotReports, runRealtimeReport, etc.), so an agent can distinguish it without opening any schema.

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?

The description gives a real selection criterion — pivot reports are 'more advanced and expressive formats than regular reports' — and lists the sibling endpoints over the same resource, plus a hard usage constraint (refused under --readonly safety profiles). It stops short of stating explicit when-not rules (e.g., batchRunPivotReports for multiple requests in one call), leaving that inference to the agent.

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