get_connector_analytics
Members, access and revenue per connector — which connector earns, and which one members actually use.
Purpose
Return one row per connector the creator's projects run or ever granted access on: the live installations, the members holding a linked account (and how many linked one in the window), the live and pending grants, the grants issued and revoked in the window, the gross revenue in USD with its transaction count and its share of the total. The same figures the dashboards' By Connector panel and GET /v1/analytics/connectors show. A purchase that grants access on two connectors counts toward both; attribution says so in the creator's language.
Required ability
dashboard:read
Input schema
{
"type": "object",
"properties": {
"project_id": {
"type": "string",
"description": "Optional project UUID to scope the figures. Leave blank for all projects in the current team."
},
"period": {
"type": "string",
"description": "Period preset — 7d, 14d, 30d, 60d, 90d, mtd, qtd, ytd, 1y, all. Defaults to 30d."
},
"from": {
"type": "string",
"description": "Explicit start date (ISO YYYY-MM-DD). Overrides period when paired with 'to'."
},
"to": {
"type": "string",
"description": "Explicit end date (ISO YYYY-MM-DD). Overrides period when paired with 'from'."
}
}
}Output shape
{
"data": {
"range": { "from": "2026-08-13", "to": "2026-09-12" },
"total_gross_usd": 1682.0,
"attribution": "A purchase that grants access on two connectors counts toward both.",
"connectors": [
{
"key": "telegram",
"name": "Telegram",
"installations": 2,
"members": 241,
"members_linked_in_window": 18,
"live_grants": 236,
"pending_grants": 3,
"granted_in_window": 21,
"revoked_in_window": 4,
"gross_usd": 1682.0,
"transactions": 58,
"share_percent": 100
}
]
},
"meta": { "period": "30d", "project_id": null }
}Example prompts
"Which connector brought in the most revenue this quarter?"
"How many members are on Telegram versus Discord in the Signals project?"
Failure modes
AUTHENTICATION_REQUIRED— no authenticated user on the request.TOKEN_MISSING_ABILITY— token lacksdashboard:read.
Related
get_dashboard_metricsget_subscriber_analyticslist_connectors— the connectors themselves.- Analytics API
How is this guide?