Connectors
List connector fields
List a connector's dimensions and metrics, optionally including custom conversions.
GET /teams/{teamId}/connectors/{connectorId}/fields
Returns the fields a connector exposes, split into dimensions and metrics. Each is an array of field groups — { groupId, groupName, fields } — where fields is a list of { id, name, description } entries.
Pass one or more accountIds to additionally include the custom conversions (custom dimensions and metrics) defined on those accounts. For connectors without custom fields, accountIds has no effect.
Authentication: Bearer token · Role: viewer · Permission:
connectors:read · Rate limit: default (120 / 60s)Path parameters
teamId
string · uuid v7 required
The team making the request.
connectorId
string required
The connector ID (e.g.
gadw). A value that is not a recognized connector returns 400 BAD_REQUEST.Query parameters
accountIds
string[]
Optional, repeatable. Account IDs whose custom conversions should be merged into the field groups. Repeat the parameter once per account — e.g.
?accountIds=gadw_123&accountIds=gadw_456.Custom conversions are only fetched when you supply
accountIds. Omit it to get just the connector's built-in dimensions and metrics.Request
curl "https://api.twominutereports.com/v1/teams/0190f8b0-1a2b-7c3d-8e4f-5a6b7c8d9e0f/connectors/gadw/fields?accountIds=gadw_123&accountIds=gadw_456" \
-H "Authorization: Bearer tmrc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Response
{
"success": true,
"data": {
"dimensions": [
{
"groupId": "general",
"groupName": "General",
"fields": [
{ "id": "campaign.name", "name": "Campaign" },
{ "id": "ad_group.name", "name": "Ad group" }
]
},
{
"groupId": "time",
"groupName": "Time",
"fields": [
{ "id": "segments.date", "name": "Date" }
]
}
],
"metrics": [
{
"groupId": "performance",
"groupName": "Performance",
"fields": [
{ "id": "metrics.impressions", "name": "Impressions" },
{ "id": "metrics.clicks", "name": "Clicks" },
{ "id": "metrics.cost_micros", "name": "Cost" }
]
},
{
"groupId": "custom-fields",
"groupName": "Custom Fields",
"fields": [
{ "id": "conversions.purchase", "name": "Purchases" }
]
}
]
}
}
{
"success": false,
"error": { "code": "BAD_REQUEST", "message": "Invalid connector ID: gads" }
}
{
"success": false,
"error": { "code": "UNAUTHORIZED", "message": "Authentication required" }
}
{
"success": false,
"error": { "code": "FORBIDDEN", "message": "You do not have permission to perform this action" }
}
{
"success": false,
"error": { "code": "NOT_FOUND", "message": "No field metadata found for connector \"gadw\"" }
}
The field group object
groupId
string
Stable identifier for the group.
groupName
string
Human-friendly group label (e.g.
Performance).fields
object[]
The fields in the group — each an object with an
id (use this in queries), a name (display label) and an optional description (field description).