Call Tracking Metrics - Accounts
📖 Overview
Call Tracking Metrics account management provides listing of accounts and sub-accounts with pagination. This module enables users to browse their CTM account hierarchy and select accounts for campaign tracking.
Source Files:
- Controller:
external/Integrations/CallTrackingMetrics/Controllers/accounts.js - Provider:
external/Integrations/CallTrackingMetrics/Providers/account-api.js - Routes:
external/Integrations/CallTrackingMetrics/Routes/accounts.js
External API: GET https://api.calltrackingmetrics.com/api/v1/accounts
🔧 Key Functions
getAccountList(req, res, next)
Purpose: Retrieve paginated list of CTM accounts
Endpoint: GET /v1/e/calltrackingmetrics/:tokenId/accounts
Parameters:
req.query.page(Number) - Page numberreq.query.limit(Number) - Results per pagereq.tokenId(String) - Credential document ID
Returns: Paginated account list
{
"success": true,
"message": "SUCCESS",
"data": [
{
"id": "act_123456",
"name": "Main Account",
"company": "Acme Corp"
}
],
"pagination": {
"current_page": 1,
"total_pages": 2,
"total_items": 15
}
}
getAccount(req, res, next)
Purpose: Get specific account details
Endpoint: GET /v1/e/calltrackingmetrics/:tokenId/accounts/:calltrackingAccountId
Returns: Account details
{
"success": true,
"message": "SUCCESS",
"data": {
"id": "act_123456",
"name": "Main Account",
"company": "Acme Corp",
"timezone": "America/New_York"
}
}
⚠️ Important Notes
- 📊 Hierarchy: Accounts → Sub-Accounts → Tracking Numbers
- 🔍 Pagination: Support for page and limit parameters
- 🔐 Authentication: Uses Basic Auth with access_key:secret
- 📝 Sub-Accounts: Optional sub-account support for segmentation
🔗 Related Documentation
- Integration Overview: Call Tracking Metrics
- Authentication: Credential Management