Match Presets
curl --request GET \
--url https://api.revenuebase.ai/v2/contact/match-presets \
--header 'X-Key: <api-key>'import requests
url = "https://api.revenuebase.ai/v2/contact/match-presets"
headers = {"X-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Key': '<api-key>'}};
fetch('https://api.revenuebase.ai/v2/contact/match-presets', 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.revenuebase.ai/v2/contact/match-presets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Key: <api-key>"
],
]);
$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.revenuebase.ai/v2/contact/match-presets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.revenuebase.ai/v2/contact/match-presets")
.header("X-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/contact/match-presets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"recommended": "similar",
"title": [
{
"match": "exact",
"label": "Exact",
"help": "Only people with essentially the same role. Includes equivalent wording and languages.",
"maxDistance": 0.05,
"similarityPct": 95,
"onTargetPct": 99,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Same underlying job. May include a small number of adjacent roles.",
"maxDistance": 0.15,
"similarityPct": 85,
"onTargetPct": 91,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "Same function, with some variation in seniority and responsibilities.",
"maxDistance": 0.25,
"similarityPct": 75,
"onTargetPct": 82,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "Explore related roles and functions. More results will require review.",
"maxDistance": 0.3,
"similarityPct": 70,
"onTargetPct": 73,
"recommended": false
}
],
"company": [
{
"match": "exact",
"label": "Exact",
"help": "Only companies that are precisely what you described.",
"maxDistance": 0.4,
"similarityPct": 60,
"onTargetPct": 86,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Companies clearly in the space you described.",
"maxDistance": 0.5,
"similarityPct": 50,
"onTargetPct": 56,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "Companies in and around the space you described.",
"maxDistance": 0.55,
"similarityPct": 45,
"onTargetPct": 42,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "Anything with a real connection. More results will require review.",
"maxDistance": 0.6,
"similarityPct": 40,
"onTargetPct": 24,
"recommended": false
}
],
"lookalike": [
{
"match": "exact",
"label": "Exact",
"help": "Direct competitors and near-twins of this company.",
"maxDistance": 0.15,
"similarityPct": 85,
"onTargetPct": 85,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Same market, with an overlapping offering.",
"maxDistance": 0.3,
"similarityPct": 70,
"onTargetPct": 78,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "A similar space, but a different offering.",
"maxDistance": 0.35,
"similarityPct": 65,
"onTargetPct": 50,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "The wider industry around this company. More results will require review.",
"maxDistance": 0.4,
"similarityPct": 60,
"onTargetPct": 34,
"recommended": false
}
]
}Contact Endpoints
Match Presets
Discover the named SmartSearch settings for titles, descriptions, and lookalike filters.
GET
/
match-presets
Match Presets
curl --request GET \
--url https://api.revenuebase.ai/v2/contact/match-presets \
--header 'X-Key: <api-key>'import requests
url = "https://api.revenuebase.ai/v2/contact/match-presets"
headers = {"X-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Key': '<api-key>'}};
fetch('https://api.revenuebase.ai/v2/contact/match-presets', 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.revenuebase.ai/v2/contact/match-presets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Key: <api-key>"
],
]);
$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.revenuebase.ai/v2/contact/match-presets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.revenuebase.ai/v2/contact/match-presets")
.header("X-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.revenuebase.ai/v2/contact/match-presets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"recommended": "similar",
"title": [
{
"match": "exact",
"label": "Exact",
"help": "Only people with essentially the same role. Includes equivalent wording and languages.",
"maxDistance": 0.05,
"similarityPct": 95,
"onTargetPct": 99,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Same underlying job. May include a small number of adjacent roles.",
"maxDistance": 0.15,
"similarityPct": 85,
"onTargetPct": 91,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "Same function, with some variation in seniority and responsibilities.",
"maxDistance": 0.25,
"similarityPct": 75,
"onTargetPct": 82,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "Explore related roles and functions. More results will require review.",
"maxDistance": 0.3,
"similarityPct": 70,
"onTargetPct": 73,
"recommended": false
}
],
"company": [
{
"match": "exact",
"label": "Exact",
"help": "Only companies that are precisely what you described.",
"maxDistance": 0.4,
"similarityPct": 60,
"onTargetPct": 86,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Companies clearly in the space you described.",
"maxDistance": 0.5,
"similarityPct": 50,
"onTargetPct": 56,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "Companies in and around the space you described.",
"maxDistance": 0.55,
"similarityPct": 45,
"onTargetPct": 42,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "Anything with a real connection. More results will require review.",
"maxDistance": 0.6,
"similarityPct": 40,
"onTargetPct": 24,
"recommended": false
}
],
"lookalike": [
{
"match": "exact",
"label": "Exact",
"help": "Direct competitors and near-twins of this company.",
"maxDistance": 0.15,
"similarityPct": 85,
"onTargetPct": 85,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Same market, with an overlapping offering.",
"maxDistance": 0.3,
"similarityPct": 70,
"onTargetPct": 78,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "A similar space, but a different offering.",
"maxDistance": 0.35,
"similarityPct": 65,
"onTargetPct": 50,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "The wider industry around this company. More results will require review.",
"maxDistance": 0.4,
"similarityPct": 60,
"onTargetPct": 34,
"recommended": false
}
]
}Credits and plans
PAYG is Pay-as-you-go. AYCE is All-you-can-eat.| Usage | PAYG | AYCE |
|---|---|---|
| Preset catalog | Free 0 credits | Free 0 credits |
When to use Match Presets
Build a SmartSearch selector in your application or choose a named match setting for a filter. Use the service’s preset catalog instead of hardcoding numeric distance thresholds.Example
SetREVENUEBASE_API_KEY to your API key.
curl --request GET 'https://api.revenuebase.ai/v2/contact/match-presets' \
--header "X-Key: $REVENUEBASE_API_KEY"
{
"recommended": "similar",
"title": [
{
"match": "exact",
"label": "Exact",
"help": "Only people with essentially the same role. Includes equivalent wording and languages.",
"maxDistance": 0.05,
"similarityPct": 95,
"onTargetPct": 99,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Same underlying job. May include a small number of adjacent roles.",
"maxDistance": 0.15,
"similarityPct": 85,
"onTargetPct": 91,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "Same function, with some variation in seniority and responsibilities.",
"maxDistance": 0.25,
"similarityPct": 75,
"onTargetPct": 82,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "Explore related roles and functions. More results will require review.",
"maxDistance": 0.3,
"similarityPct": 70,
"onTargetPct": 73,
"recommended": false
}
],
"company": [
{
"match": "exact",
"label": "Exact",
"help": "Only companies that are precisely what you described.",
"maxDistance": 0.4,
"similarityPct": 60,
"onTargetPct": 86,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Companies clearly in the space you described.",
"maxDistance": 0.5,
"similarityPct": 50,
"onTargetPct": 56,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "Companies in and around the space you described.",
"maxDistance": 0.55,
"similarityPct": 45,
"onTargetPct": 42,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "Anything with a real connection. More results will require review.",
"maxDistance": 0.6,
"similarityPct": 40,
"onTargetPct": 24,
"recommended": false
}
],
"lookalike": [
{
"match": "exact",
"label": "Exact",
"help": "Direct competitors and near-twins of this company.",
"maxDistance": 0.15,
"similarityPct": 85,
"onTargetPct": 85,
"recommended": false
},
{
"match": "similar",
"label": "Similar",
"help": "Same market, with an overlapping offering.",
"maxDistance": 0.3,
"similarityPct": 70,
"onTargetPct": 78,
"recommended": true
},
{
"match": "related",
"label": "Related",
"help": "A similar space, but a different offering.",
"maxDistance": 0.35,
"similarityPct": 65,
"onTargetPct": 50,
"recommended": false
},
{
"match": "broad",
"label": "Broad",
"help": "The wider industry around this company. More results will require review.",
"maxDistance": 0.4,
"similarityPct": 60,
"onTargetPct": 34,
"recommended": false
}
]
}
Read the response
| Field | Meaning |
|---|---|
recommended | Recommended default match name. |
title, company, lookalike | Preset lists for job-title semantics, company-description semantics, and lookalike filters. |
match, label, help | Name to send in the filter and display text for a selector. |
maxDistance, similarityPct | The threshold associated with that preset for this target. |
onTargetPct | Measured calibration guidance, rather than a guarantee for your audience. |
recommended on a preset | Whether that entry is recommended for the target. |
Use a named preset
Send match on a semantic or lookalike filter node. Do not also send maxDistance; those choices are mutually exclusive. A named preset lets the service apply its current calibration. These are filter settings. The standalone Lookalike endpoint accepts a seed and a nearest-results limit; it does not accept match or maxDistance.Next steps
Read SmartSearch and test a proposed filter with free Count and View.Authorizations
Response
200 - application/json
Successful Response
The response is of type Response Match Presets V1 Match Presets Get · object.
Was this page helpful?
