> ## Documentation Index > Fetch the complete documentation index at: https://docs.teamfollowup.ai/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the public API base URL: https://api.teamfollowup.ai/api. > Authenticate public API requests with Authorization: Bearer YOUR_API_KEY. > Use product-owned terms: agents, calls, campaigns, contacts, phone numbers, billing, and configuration. # Get transfer rate by project > Returns the live-transfer rate for each project as transfers divided by leads, sorted highest first. Projects with no leads in the window are omitted rather than reported as a zero rate. Rows cover every project the caller can see, so an agency credential gets its own projects and a staff credential gets all of them. Allowed customer roles: `agency_admin`, `project_user`. Required API key scope: `dashboard:read`. ## OpenAPI ````yaml /openapi.yaml get /api/dashboard/transfer-rate-by-project openapi: 3.1.0 info: title: TFUAI Server API version: 1.0.0 description: >- API reference for the TFUAI SaaS server. All published endpoints are mounted under `/api`. Responses use a standard envelope: `{ "success": true, ... }` on success and `{ "success": false, "error": "..." }` on failure. Product API modules are being launched module by module. This spec currently exposes only contracted public modules. Authenticate public API requests with an API key in the `Authorization` header: `Authorization: Bearer YOUR_API_KEY`. servers: - url: https://api.teamfollowup.ai description: Production API origin. Public API paths are under /api. - url: https://devapi.teamfollowup.ai description: Development API origin. Public API paths are under /api. security: [] tags: - name: Agents description: Manage voice agents, campaigns, workflows, and outcomes. - name: Analytics description: >- Minimal, non-billing performance summary: volume, conversion, and pickup metrics. - name: Calls description: Review calls, test runs, and execution history. - name: Campaign Workflows description: >- What runs after a call lands: for each outcome (booked, opted out, asked for a callback…), an ordered chain of actions — tag the contact, move a pipeline stage, send an SMS, book an appointment. Stored as a graph: `nodes` are the actions, `edges` say what follows what, and `dispositionEntries` maps each outcome to the node its chain starts at. **Pick the narrowest endpoint that does the job.** | To | Call | | | --- | --- | --- | | See what fires per outcome | `GET .../workflow/digest` | Reads as plain text, no graph walking | | Add steps to an outcome | `POST .../outcomes/{outcome}/nodes` | Server derives node ids, edge ids, handles, layout | | Change a message, tag or setting | `PATCH .../workflow` | Merges; carries no graph, so it cannot damage one | | Remove one step | `DELETE .../nodes/{nodeId}` | Also re-links the chain around it | | Author or replace the whole graph | `PUT .../workflow` | Replaces everything you send | `PUT` is the only one that can re-wire, position nodes, build an `if`, save an unconfigured draft, or copy a whole workflow — and the only one that can overwrite a change someone else made after you read it. Use it when you are genuinely authoring the graph, and send `expectedVersion` when you do. For everything else the narrower endpoints are both easier and safer. - name: Contacts description: Contact list, filters, contact call history, and do-not-call actions. - name: GHL description: CRM variables and contact helpers used by agent and campaign setup flows. - name: Phone Numbers description: >- Caller ID pool, number search, assignment, movement, and release endpoints. - name: Power Dialer description: >- Power Dialer queue, lead cadence, callback, parked lead, and campaign schedule endpoints. - name: Projects description: >- Project management endpoints: list, update, disconnect, configure project campaigns, and validate setup. - name: Skills and Tools description: Manage reusable agent behaviors and in-call tool descriptions. - name: Voices description: Voice catalogue endpoints for choosing the voice used by an agent. paths: /api/dashboard/transfer-rate-by-project: get: tags: - Analytics summary: Get transfer rate by project description: >- Returns the live-transfer rate for each project as transfers divided by leads, sorted highest first. Projects with no leads in the window are omitted rather than reported as a zero rate. Rows cover every project the caller can see, so an agency credential gets its own projects and a staff credential gets all of them. Allowed customer roles: `agency_admin`, `project_user`. Required API key scope: `dashboard:read`. operationId: get-dashboard-transfer-rate-by-project parameters: - name: dateFromUTC in: query required: false schema: type: string format: date-time description: Start of the reporting window as a UTC ISO timestamp. example: '2026-07-01T00:00:00.000Z' - name: dateToUTC in: query required: false schema: type: string format: date-time description: End of the reporting window as a UTC ISO timestamp. example: '2026-07-31T23:59:59.999Z' - name: projectName in: query required: false schema: type: string minLength: 1 description: Restrict the comparison to a single project by name. example: Roofing Leads - name: agency in: query required: false schema: type: string minLength: 1 description: Restrict the comparison to a single agency tag. example: acme-agency - name: projects in: query required: false schema: type: array items: type: string minLength: 1 description: >- Restrict the comparison to these projects. Repeat the parameter for each name. example: - Roofing Leads - HVAC Leads - name: excludeProjects in: query required: false schema: type: array items: type: string minLength: 1 description: >- Omit these projects from the comparison. Repeat the parameter for each name. example: - Sandbox Project - name: campaignId in: query required: false schema: type: string minLength: 1 description: >- Restrict the comparison to the leads one campaign dialled. Only V2 activity carries campaign attribution. example: cmp_9f7a123 - name: masterCampaignId in: query required: false schema: type: string minLength: 1 description: >- Restrict the comparison to the leads an entire master campaign dialled, across every linked project the caller can see. A master campaign is fanned out into one child campaign per project, each with its own id, so filtering by a single campaignId returns one project's share of it. Mutually exclusive with campaignId: the two are contradictory scopes rather than narrowing ones, and sending both is a 400. example: mc_84f1be18-2329-4af1-a2f0-abcf2170aba9 responses: '200': description: Transfer rate per project. content: application/json: schema: $ref: '#/components/schemas/AnalyticsTransferRateByProjectResponse' examples: default: value: success: true data: - project: Roofing Leads leads: 120 transfers: 44 transferRate: 36.67 - project: HVAC Leads leads: 88 transfers: 5 transferRate: 5.68 '400': description: A query parameter is malformed (e.g. an unparseable date). content: application/json: schema: $ref: '#/components/schemas/AnalyticsErrorResponse' examples: default: value: success: false error: BadRequest message: dateToUTC must be a valid ISO 8601 UTC date-time '401': description: Missing or invalid authentication. content: application/json: schema: $ref: '#/components/schemas/AnalyticsErrorResponse' examples: default: value: success: false error: Unauthorized '403': description: The credential is authenticated but not scoped for `dashboard:read`. content: application/json: schema: $ref: '#/components/schemas/AnalyticsErrorResponse' examples: default: value: success: false error: InsufficientScope message: This API key does not have the required scope. requiredScope: dashboard:read '429': description: Rate limit exceeded. content: application/json: schema: $ref: '#/components/schemas/AnalyticsErrorResponse' examples: default: value: success: false error: TooManyRequests '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/AnalyticsErrorResponse' examples: default: value: success: false error: Unexpected server error. security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: cURL source: |- curl --request GET \ --url https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project \ --header 'Authorization: Bearer YOUR_API_KEY' components: schemas: AnalyticsTransferRateByProjectResponse: type: object additionalProperties: false required: - success - data properties: success: type: boolean example: true data: type: array description: >- One row per project, sorted by transfer rate descending. Projects with no leads in the window are omitted. items: $ref: '#/components/schemas/AnalyticsTransferRateByProject' AnalyticsErrorResponse: type: object additionalProperties: false required: - success - error properties: success: type: boolean example: false error: type: string example: Unauthorized message: type: string example: The request is not permitted. requiredScope: type: string description: On a scope refusal, the scope the credential was missing. example: dashboard:read AnalyticsTransferRateByProject: type: object additionalProperties: false required: - project - leads - transfers - transferRate properties: project: type: string description: Project (business) name. leads: type: integer description: Distinct leads dialled in the window. transfers: type: integer description: Live transfers completed in the window. transferRate: type: number description: Transfers as a percentage of leads, to two decimal places. securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your API key as `Authorization: Bearer YOUR_API_KEY`.' ````