cURL
pcall GET "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview"const res = await call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview",
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-api-key: <api-key>",
"x-secret-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-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-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-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML",
"campaign_count": 1,
"kpis": {
"uploaded": 120,
"rejected": 6,
"sent": 118,
"delivered": 110,
"link_opened": 64,
"completed": 41,
"opted_out": 2
},
"standing": {
"completed": 41,
"in_progress": 8,
"sent": 62,
"not_interested": 5,
"opted_out": 2
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Enrichments
Get the overview of an enrichment
Funnel numbers across all campaigns: uploaded, rejected, sent, delivered, link opened, completed and opted out, and how many candidates stand in each status.
Scope: enrichment:read or enrichment:write or enrichment:campaigns
GET
/
enrichments
/
{enrichment_id}
/
overview
cURL
pcall GET "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview"const res = await call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview");
const { data } = await res.json();res = call("GET", "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/overview")
data = res.json()["data"]<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview",
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-api-key: <api-key>",
"x-secret-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-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-secret-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-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview")
.header("x-api-key", "<api-key>")
.header("x-secret-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-bc.userecord.io/api/v1/partner/enrichments/{enrichment_id}/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-secret-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enrichment_id": "WF_EN_261121094822026AEDRUB86TQVSML",
"campaign_count": 1,
"kpis": {
"uploaded": 120,
"rejected": 6,
"sent": 118,
"delivered": 110,
"link_opened": 64,
"completed": 41,
"opted_out": 2
},
"standing": {
"completed": 41,
"in_progress": 8,
"sent": 62,
"not_interested": 5,
"opted_out": 2
}
}
}{
"success": false,
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": [
{
"path": "<string>",
"message": "<string>"
}
],
"request_id": "<string>"
}
}Authorizations
Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

