> ## Documentation Index > Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt > Use this file to discover all available pages before exploring further. # Get live outreach metrics per source > Returns live per-source metrics (leads, cost, costPerLead, contactPercentage, closePercentage, stageDistribution, grossProfit, roi) aggregated over the authenticated user's active outreach configs. Admins can scope to another user via filterUserId, or pass filterUserId=all for an organization-wide view. Date range can be supplied as preset (today/week/month/allTime) or explicit from/to ISO timestamps. Responses are cached for 10 minutes per filter combination. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/outreach-metrics openapi: 3.0.3 info: title: Tether Relay and Tether API version: 1.0.0 description: >- Route-derived OpenAPI contract generated from tether-relay backend sources. Regenerate with scripts/sync-openapi-from-backend.mjs. servers: - url: https://your-instance.example.com description: Production - url: http://localhost:2212 description: Local API service security: [] tags: - name: AI - name: Applications - name: Approval - name: Auth - name: Automations - name: Calls - name: Campaigns - name: Contact Analytics - name: Contact Metrics - name: Contact Notes - name: Contacts - name: Conversation Monitor - name: Conversations - name: Departments - name: Email - name: Escalation Dashboard - name: Event Logs - name: Google Sheets - name: Marketplace - name: Messages - name: Notification Sounds - name: Notifications - name: Org Snapshots - name: Organizations - name: Outreach - name: Outreach Metrics - name: Outreach Sources - name: Pipelines - name: Processes - name: Prompts - name: Reminders - name: Sms - name: Templates - name: Traces - name: Training - name: Upload - name: User Snapshots - name: Users - name: Vertical - name: Webchats - name: Webhook paths: /api/outreach-metrics: get: tags: - Outreach Metrics summary: Get live outreach metrics per source description: >- Returns live per-source metrics (leads, cost, costPerLead, contactPercentage, closePercentage, stageDistribution, grossProfit, roi) aggregated over the authenticated user's active outreach configs. Admins can scope to another user via filterUserId, or pass filterUserId=all for an organization-wide view. Date range can be supplied as preset (today/week/month/allTime) or explicit from/to ISO timestamps. Responses are cached for 10 minutes per filter combination. operationId: get_outreach_metrics parameters: - in: query name: filterUserId required: false schema: type: string description: >- Admin-only. Target a specific user's configs, or 'all' for the whole organization. - in: query name: preset required: false schema: type: string enum: - today - week - month - allTime description: Named date range. Mutually exclusive with from/to. - in: query name: from required: false schema: type: string format: date-time description: Inclusive lower bound on contact createdAt (ISO timestamp). - in: query name: to required: false schema: type: string format: date-time description: Inclusive upper bound on contact createdAt (ISO timestamp). responses: '200': description: Metrics returned content: application/json: schema: $ref: '#/components/schemas/OutreachMetricsResponse' '400': description: Invalid date range or preset content: application/json: schema: $ref: '#/components/schemas/OutreachErrorResponse' '403': description: Admin access required to filter by user content: application/json: schema: $ref: '#/components/schemas/OutreachErrorResponse' '500': description: Error calculating outreach metrics content: application/json: schema: $ref: '#/components/schemas/OutreachErrorResponse' security: - bearerAuth: [] components: schemas: OutreachMetricsResponse: type: object properties: success: type: boolean data: type: array items: $ref: '#/components/schemas/OutreachSourceMetrics' required: - success - data additionalProperties: true example: success: true data: - source: Facebook Lead Ad leads: 120 cost: 1500 costPerLead: 12.5 contactPercentage: 75 closePercentage: 18 stageDistribution: - stage: Contacted count: 60 grossProfit: 4400 roi: 2.93 OutreachErrorResponse: type: object description: Error envelope returned by `/api/outreach`. properties: success: type: boolean enum: - false message: type: string error: type: string description: Stack/detail string for 500 paths. required: - success - message additionalProperties: true example: success: false message: Configuration is inactive and cannot process outreach requests OutreachSourceMetrics: type: object properties: source: type: string leads: type: integer cost: type: number costPerLead: type: number description: Average cost per lead for contacts under this source. contactPercentage: type: number description: Percentage of leads that have at least one outbound message. closePercentage: type: number description: >- Percentage of leads whose status matches the org's outreachCloseStages. stageDistribution: type: array items: $ref: '#/components/schemas/OutreachStageCount' grossProfit: type: number roi: type: number description: grossProfit / cost (0 when cost is 0). required: - source - leads - cost - costPerLead - contactPercentage - closePercentage - stageDistribution - grossProfit - roi additionalProperties: true example: source: Facebook Lead Ad leads: 120 cost: 1500 costPerLead: 12.5 contactPercentage: 75 closePercentage: 18 stageDistribution: - stage: New Lead count: 30 - stage: Contacted count: 60 - stage: Closed Won count: 22 grossProfit: 4400 roi: 2.93 OutreachStageCount: type: object properties: stage: type: string count: type: integer required: - stage - count additionalProperties: false example: stage: Contacted count: 42 securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````