Get transfer rate by project

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "project": "Roofing Leads",
      "leads": 120,
      "transfers": 44,
      "transferRate": 36.67
    },
    {
      "project": "HVAC Leads",
      "leads": 88,
      "transfers": 5,
      "transferRate": 5.68
    }
  ]
}

{
  "success": false,
  "error": "BadRequest",
  "message": "dateToUTC must be a valid ISO 8601 UTC date-time"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "InsufficientScope",
  "message": "This API key does not have the required scope.",
  "requiredScope": "dashboard:read"
}

{
  "success": false,
  "error": "TooManyRequests"
}

{
  "success": false,
  "error": "Unexpected server error."
}

GET

api

dashboard

transfer-rate-by-project

cURL

curl --request GET \
  --url https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project \
  --header 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.teamfollowup.ai/api/dashboard/transfer-rate-by-project")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": [
    {
      "project": "Roofing Leads",
      "leads": 120,
      "transfers": 44,
      "transferRate": 36.67
    },
    {
      "project": "HVAC Leads",
      "leads": 88,
      "transfers": 5,
      "transferRate": 5.68
    }
  ]
}

{
  "success": false,
  "error": "BadRequest",
  "message": "dateToUTC must be a valid ISO 8601 UTC date-time"
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "InsufficientScope",
  "message": "This API key does not have the required scope.",
  "requiredScope": "dashboard:read"
}

{
  "success": false,
  "error": "TooManyRequests"
}

{
  "success": false,
  "error": "Unexpected server error."
}

Authorizations

Authorization

string

header

required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

dateFromUTC

string<date-time>

Start of the reporting window as a UTC ISO timestamp.

dateToUTC

string<date-time>

End of the reporting window as a UTC ISO timestamp.

projectName

string

Restrict the comparison to a single project by name.

Minimum string length: 1

agency

string

Restrict the comparison to a single agency tag.

Minimum string length: 1

projects

string[]

Restrict the comparison to these projects. Repeat the parameter for each name.

Minimum string length: 1

excludeProjects

string[]

Omit these projects from the comparison. Repeat the parameter for each name.

Minimum string length: 1

campaignId

string

Restrict the comparison to the leads one campaign dialled. Only V2 activity carries campaign attribution.

Minimum string length: 1

masterCampaignId

string

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.

Minimum string length: 1

Response

Transfer rate per project.

success

boolean

required

Example:

true

data

object[]

required

One row per project, sorted by transfer rate descending. Projects with no leads in the window are omitted.

Show child attributes

Agents

Skills & Tools

Campaigns

Campaign Workflows

Calls

Analytics

Projects

Power Dialer

Contacts

Phone Numbers

Voices

GHL

Authorizations

Query Parameters

Response