Plaid get usagesPLAID_MCP_PLAID_GET_USAGES
Retrieves usage metrics for Plaid products and services.
<when_to_use>
Use this tool when you need to:
- Get usage data for specific metrics over a time period
- Track product usage and consumption
- Monitor API request volumes
- Generate usage reports for billing purposes
</when_to_use>
<details>
The data shows how many times each Plaid product was used within the specified
date range for certain metrics, with results aggregated by day. Common metrics
include number of API calls, authentication requests, and other product-specific
usage counts.
</details>
<product_mapping>
The key is the product name, and the value is the list of metric types corresponding to that product.
- Auth: ["auth-request", "auth-unverified-request"]
- Balance: "balance-request"
- Identity: ["identity-request", "identity-match-request"]
- Transactions: ["transactions", "transactions-add", "transactions-remove", "transactions-active", "transactions-refresh"]
- Investments: ["investments-h-add", "investments-h", "investments-h-remove", "investments-h-active", "investments-t-add", "investments-t", "investments-t-remove", "investments-t-active"]
- Investments Move: "investments-auth-request"
- Liabilities: ["liabilities-add", "liabilities-remove", "liabilities-active", "liabilities"]
- Assets: ["assets-add", "assets-pdf-request", "assets-refresh", "assets-refresh-monthly", "assets-audit-request", "assets-history-request"]
- Payments: "payment_initiation-initd"
- Enrich: "enriched-transaction"
- Signal: "momo-frs-eval-request"
- Income: ["income-bank-request", "income-bank-refresh", "income-payroll-request", "income-payroll-refresh", "income-document-request", "income-document-parsing", "income-doc-bank-statemnt", "income-document-fraud"]
- Statements: "statements-single-doc"
- Identity Verification: ["idv-base", "idv-lightning-group-1", "idv-lightning-group-2", "idv-lightning-group-3", "idv-document", "idv-selfie-check"]
- Consumer Report: ["cra-bank-income-request", "cra-base-report-create", "cra-base-report-refresh", "cra-network-insights-req", "income-insights-refresh", "partner-prism-attrib", "partner-prism-scores"]
- Monitor: ["monitor-wl-rescan-add", "monitor-wl-rescan-remove", "monitor-wl-base"]
- Hosted Link Delivery: ["hosted-link-delivery-eml", "hosted-link-delivery-sms"]
- Transfer: ["momo-transfer-ach", "momo-transfer-ach-sd", "momo-wire-request", "momo-rtp-request", "momo-transfer-g-ach", "momo-transfer-g-ach-sd", "momo-transfer-authorized", "momo-transfer-manual-req", "momo-transfer-return-unauthorized", "momo-transfer-return-noc", "momo-transfer-return-other"]
<note>
- If a user asks for a product similar to one on this list and you're 99% confident it's the same product, query for the product on this list and inform them which product you're querying for. Otherwise, do not query an unrelated product.
- "momo-frs-eval-request" is the metric type used in the API for Signal. When communicating with users, refer to it as "signal-request" instead.
</note>
</product_mapping>
<example_1>
User: "I want to see the usage data for Transactions"
Reasoning: The metric types for Transactions are ["transactions", "transactions-add", "transactions-remove", "transactions-active", "transactions-refresh"].
Input parameters:
{
"metric_types": ["transactions", "transactions-add", "transactions-remove", "transactions-active", "transactions-refresh"],
// other fields ...
}
</example_1>
<example_2>
User: "What metrics are available for Identity Verification?"
Response: We support the following metrics for Identity Verification: idv-base, idv-lightning-group-1, idv-lightning-group-2, idv-lightning-group-3, idv-document, idv-selfie-check.
</example_2>
<important>
- If metric_types aren't provided, use "auth-request" as the default
- If no date range is provided, ask the user for one (suggest last 30 days with current date as end date)
- The maximum look-back period is limited to 1 year from the current date
</important>