Public API - Lead Scores
Resolve signal details
Human-readable title/description for the given lead-score value ids. Each request item needs the leadScoreId (and entityId for employee signals).
POST
/
public
/
v1
/
lead-score-details
Resolve signal details
curl --request POST \
--url https://app.stairoids.com/api/public/v1/lead-score-details \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
[
{
"entityId": "<string>",
"leadScoreId": 123
}
]
'import requests
url = "https://app.stairoids.com/api/public/v1/lead-score-details"
payload = [
{
"entityId": "<string>",
"leadScoreId": 123
}
]
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{entityId: '<string>', leadScoreId: 123}])
};
fetch('https://app.stairoids.com/api/public/v1/lead-score-details', 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://app.stairoids.com/api/public/v1/lead-score-details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'entityId' => '<string>',
'leadScoreId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stairoids.com/api/public/v1/lead-score-details"
payload := strings.NewReader("[\n {\n \"entityId\": \"<string>\",\n \"leadScoreId\": 123\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.stairoids.com/api/public/v1/lead-score-details")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"entityId\": \"<string>\",\n \"leadScoreId\": 123\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.stairoids.com/api/public/v1/lead-score-details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"entityId\": \"<string>\",\n \"leadScoreId\": 123\n }\n]"
response = http.request(request)
puts response.read_body[
{
"title": "Visited page: Pricing",
"description": "<string>",
"scoreValueId": 991234
}
]{
"errorType": "EMAIL_ALREADY_EXISTS"
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123,
"addOnSlug": "<string>",
"planSlug": "<string>",
"addOnPriceMonthly": 123,
"upgradePlanSlug": "<string>",
"upgradePlanName": "<string>",
"upgradePlanPriceMonthly": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS"
}Authorizations
Your organization's public API key.
Body
application/json
⌘I
Resolve signal details
curl --request POST \
--url https://app.stairoids.com/api/public/v1/lead-score-details \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
[
{
"entityId": "<string>",
"leadScoreId": 123
}
]
'import requests
url = "https://app.stairoids.com/api/public/v1/lead-score-details"
payload = [
{
"entityId": "<string>",
"leadScoreId": 123
}
]
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify([{entityId: '<string>', leadScoreId: 123}])
};
fetch('https://app.stairoids.com/api/public/v1/lead-score-details', 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://app.stairoids.com/api/public/v1/lead-score-details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'entityId' => '<string>',
'leadScoreId' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.stairoids.com/api/public/v1/lead-score-details"
payload := strings.NewReader("[\n {\n \"entityId\": \"<string>\",\n \"leadScoreId\": 123\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.stairoids.com/api/public/v1/lead-score-details")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("[\n {\n \"entityId\": \"<string>\",\n \"leadScoreId\": 123\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.stairoids.com/api/public/v1/lead-score-details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n {\n \"entityId\": \"<string>\",\n \"leadScoreId\": 123\n }\n]"
response = http.request(request)
puts response.read_body[
{
"title": "Visited page: Pricing",
"description": "<string>",
"scoreValueId": 991234
}
]{
"errorType": "EMAIL_ALREADY_EXISTS"
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123,
"addOnSlug": "<string>",
"planSlug": "<string>",
"addOnPriceMonthly": 123,
"upgradePlanSlug": "<string>",
"upgradePlanName": "<string>",
"upgradePlanPriceMonthly": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS",
"category": "<string>",
"currentUsage": 123,
"limit": 123
}{
"errorType": "EMAIL_ALREADY_EXISTS"
}