Tool: query_merchant_performance
Retrieves high-level aggregated performance data and post-integration metrics for a specific merchant business profile.
The following sample demonstrate how to use curl to invoke the query_merchant_performance MCP tool.
| Curl Request |
|---|
curl --location 'https://paydeveloper.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "query_merchant_performance", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
Request message for querying merchant performance data.
QueryMerchantPerformanceRequest
| JSON representation |
|---|
{
"merchantId": string,
"timeRange": enum ( |
| Fields | |
|---|---|
merchantId |
Required. The unique identifier of the merchant for which performance data is being requested. |
timeRange |
Optional. The time range of the performance data. |
Output Schema
Response message for querying merchant performance.
QueryMerchantPerformanceResponse
| JSON representation |
|---|
{
"merchantPerformanceMetrics": [
{
object ( |
| Fields | |
|---|---|
merchantPerformanceMetrics[] |
The performance data of the merchant. |
MerchantPerformanceMetric
| JSON representation |
|---|
{ "metricDetail": { object ( |
| Fields | |
|---|---|
metricDetail |
Output only. Details of the metric. |
hourlyMetricValues[] |
Output only. A list of metric value and its timestamp, rounded to the nearest top of hour. |
MetricDetail
| JSON representation |
|---|
{
"metricType": enum ( |
| Fields | |
|---|---|
metricType |
Type of the metric. |
additionalDetails |
Key-value pairs for any additional details about the metric, e.g., "gateway": "stripe". For details see An object containing a list of |
AdditionalDetailsEntry
| JSON representation |
|---|
{ "key": string, "value": string } |
| Fields | |
|---|---|
key |
|
value |
|
HourlyMetricValue
| JSON representation |
|---|
{ "hourlyTimestamp": string, "value": number } |
| Fields | |
|---|---|
hourlyTimestamp |
The timestamp of the metric value rounded to the nearest top of hour. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
value |
The actual metric value. For conversion rate, the value is in the range of [0, 1]. For other metrics, the value is non-negative integer. |
Timestamp
| JSON representation |
|---|
{ "seconds": string, "nanos": integer } |
| Fields | |
|---|---|
seconds |
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z). |
nanos |
Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive. |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌