Introduction
Welcome to 6sense, a leading ABM platform helping B2B organizations achieve predictable revenue growth by putting the power of AI, big data, and machine learning behind every member of the revenue team.
6sense uncovers anonymous buying behaviour, prioritizes accounts for sales and marketing, and enables them to engage resistant buying teams with personalized, multi-channel, multi-touch campaigns. 6sense helps revenue teams know everything they need to know about their buyers so they can easily do anything needed to generate more opportunities, increase deal size, get into opportunities sooner, and compete and win more often.
API Overview
The 6sense API is the easiest way to connect with the 6sense platform. It's an HTTP-based API that your apps can use to programmatically. Based on your API endpoint, APIs can return informations like firmographic data, product scoring data and if you have multiple segments published in 6sense ABM platform for APIs then you can also get those. All you need is to pass IP address or email or company Name or any other required input data mentioned in each APIs.
APIs essentially allows two application to communicate with each other. External applications generally uses APIs to request data from 6sense system.
List of 6sense APIs
API Name | How it helps? |
---|---|
Company Details API | Company Details API (previously known as 6signal API) help you identify your anonymous website visitor or leads by taking an IP as input and returns firmographs, segments and scores associated with that IP. In order to consume this API, you would need 6sense Platform Package. |
Lead Scoring API | Lead Scoring API help you to score your leads using email id on real time basis. In order to consume this API, you would need 6sense Advance Package. This API returns our predictive scores at the product level. |
Lead Enrichment API | Lead Enrichment API help you to enrich your lead using email id. In order to consume this API, you would need 6sense Essentials Package. This API returns firmographic and your Segments (published in 6sense ABM Platform for APIs). |
Lead Enrichment & Scoring API | Lead Enrichment and Scoring API (previously known as Real Time Scoring API or RTS) is a combo API for Lead enrichment and Lead scoring in a single response. This API returns firmographs, segments (published in 6sense ABM Platform for APIs) and scores from email id of your customers. You can store these details in your CRM or any other system to have more information about your Lead. In order to consume this API, you would need 6sense Essential + Advance Package. |
Let’s start with the First Step!
Get your API Token
An API Token is an alphanumeric 40 character long key phrase randomly generated by 6sense, which will allow your organization to access 6sense APIs and the information we provide through them. API tokens are specific to a given API. An API token will work for the APIs for which it was created and provide information as per your Current 6sense Package for/on that API. Package information is mentioned in each APIs.
This is the most important step to connect to any of the 6sense APIs and without this none of the API works.
- You can go to the API Token Management page in the 6sense ABM Platform and find your API tokens.
- Example Token
- Copy your API token.
HTTP Response Codes
6sense uses standard HTTP response codes to indicate the success or failure of an API request. Codes in the 2xx
range indicate success; Codes in the 4xx
or 5xx
range indicate an error.
Code | Description |
---|---|
200 |
OK Successfully returned response. The response message varies, depending on the request method/endpoint and the requested data. |
201 |
Created The request has been fulfilled and has resulted in one or more new resources being created. |
204 |
No content The server has successfully fulfilled the request and that there is no additional content to send in the response payload body. |
400 |
Bad request Required fields cannot be blank. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |
401 |
Unauthorized Your API token is invalid or auth token is invalid or missing authorization header. |
402 |
Quota Exhausted Your allocated Quota is exhausted, please upgrade/top-up your API limit by reaching out to your CSM. |
403 |
Forbidden You do not have the appropriate user rights to access the request. Do not repeat the request. |
404 |
Not found The resource does not exist. |
422 |
Validation error A validation error occurred. |
429 |
Too Many Requests You have sent too many requests in a given amount of time ("rate limit"). Please try again later. |
50X |
Internal Server Error Something went wrong with the 6sense API. These errors are logged on our side. You can contact our team to resolve the issue. |
Error Responses
Type | Example |
---|---|
Required parameters are blank | {"status": "error", "message": "email and country are required fields and cannot be blank"} |
No data found | {"status": "error", "message": "No data found. Please contact 6sense support, if you think this is an unexpected error."} |
Versioning
Each API will show the list of Versions supported. You may receive timely notifications to upgrade the APIs on the latest stable version as we will deprecate the older versions which are no longer recommended to use.
API | Current stable Version |
---|---|
Company Details API | v3 |
Lead Scoring API | v2 |
Lead Enrichment API | v2 |
Lead Enrichment & Scoring API | v2 |
Company Details API
Company Details API (previously known as 6signal API) will help you get company informations from that IP of your user.
How Company Details API can help you?
- Integrating with your Chat Bot, can de-anonymize visitors in real time. We will help you to get company details associated with that IP of your user.
- Integrating with your Customer Support system to get more details about your customer.
- Any other use cases where you need to get company information from an IP address.
HTTP Request
Company Details API data at the account level can be retrieved from the following endpoint:
Headers
Sample Request
curl --location --request GET 'https://epsilon.6sense.com/v3/company/details' \
--header 'Authorization: Token {your_api_token}' \
--header 'X-6s-CustomID: {partner_name-partner_api_token}'
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("GET", "https://epsilon.6sense.com/v3/company/details");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.setRequestHeader("X-6s-CustomID", "{partner_name-partner_api_token}");
var request = require('request');
var options = {
'method': 'GET',
'url': 'https://epsilon.6sense.com/v3/company/details',
'headers': {
'Authorization': 'Token {your_api_token}',
'X-6s-CustomID': '{partner_name-partner_api_token}'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://epsilon.6sense.com/v3/company/details"
payload = {}
headers = {
"Authorization": "Token {your_api_token}",
"X-6s-CustomID": "{partner_name-partner_api_token}"
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "6signal",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://epsilon.6sense.com/v3/company/details",
"request": {
"method": "GET",
"header": [
{
"key": "Authorization",
"type": "text",
"value": "Token {your_api_token}"
},
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/x-www-form-urlencoded",
"disabled": true
},
{
"key": "EpsilonCookie",
"type": "text",
"value": "{optional cookie value}",
"disabled": true
},
{
"key": "X-6s-CustomID",
"type": "text",
"value": "{partner_name-partner_api_token}"
}
],
"url": {
"raw": "https://epsilon.6sense.com/v3/company/details",
"protocol": "https",
"host": [
"epsilon",
"6sense",
"com"
],
"path": [
"v3",
"company",
"details"
]
}
},
"response": []
}
]
}
Header | Value |
---|---|
Authorization | Token <api_token> |
EpsilonCookie(optional) |
If you are a Partner then, you must send this additional header for customer data identification.
Header | Value |
---|---|
X-6s-CustomID |
|
Response Data
Sample Response
{
"company": {
"company_match": "Match",
"additional_comment": "Company name or domain match was found",
"domain": "g.ucla.edu",
"name": "UCLA",
"region": "Northern America",
"country": "United States",
"state": "California",
"city": "Los Angeles",
"industry": "Education",
"country_iso_code": "US",
"address": "308 Charles E. Young Drive North A210 Fowler Building/Box 951510",
"zip": "90095",
"phone": "(310) 825-4321",
"employee_range": "10,000+",
"revenue_range": "$5B+",
"employee_count": "22000",
"annual_revenue": "7449000000",
"is_blacklisted": false,
"is_6qa": true,
"geoIP_country": "United States",
"geoIP_state": "California",
"geoIP_city": "San Jose",
"state_code": "CA",
"industry_v2": [
{
"industry": "Education",
"subindustry": "Colleges & Universities"
}
],
"sic_description": "",
"sic": "",
"naics": "6113",
"naics_description": "Colleges, Universities, and Professional Schools"
},
"scores": [
{
"is_6qa": true,
"product": "6sense",
"product_display_name": "6sense",
"intent_score": 63,
"buying_stage": "Consideration",
"profile_score": 9,
"profile_fit": "Weak"
}
],
"segments": {
"ids": [
4713,
28237,
218915,
53685
],
"names": [
"Net New Logo Website Engagement Last 30 Days",
"6s for 6s: Keyword_Sales Intelligence",
"Cvent: Researching Virtual Events",
"EY - Enterprise Accounts (DemandGen)"
],
"list": [
{
"name": "Net New Logo Website Engagement Last 30 Days",
"id": 4713
},
{
"name": "6s for 6s: Keyword_Sales Intelligence",
"id": 28237
},
{
"name": "Cvent: Researching Virtual Events",
"id": 218915
},
{
"name": "EY - Enterprise Accounts (DemandGen)",
"id": 53685
}
]
},
"confidence": "Very High"
}
Parameters | |
---|---|
Account/company Level Variables |
Below are the list of company variables that will be available in the API response.
Below are sample values for these parameters.
|
company_match |
String
This field will help you identify if an IP is a "Match" or "Non-actionable Match" or "No Match"
"Match" or "Non-actionable Match" or "No Match"
|
additional_comment |
String
This field is a supportive field for company_match and provides a reason for each values.
In case of "Match" it will return "Company name or domain match was found".
In case of "Non-actionable Match" it will return "There is no valid B2B use case as this was matched to something other than a company name/domain (i.e.: bot, host, noisy signal, etc.)". And In case of "No match" it will return "No company name or domain was found". |
name |
String
Name of the company
6sense
|
domain |
String
Website of the company
6sense .com
|
industry |
String
Industry of the company
Software and Technology
|
industry_v2 |
Object
Industry and Sub-Industry of the company
"industry": "Education","subindustry": "Colleges & Universities"
|
country |
String
Head office of the company
United States
|
address |
String
Address
450 Mission
|
state |
String
State
California
|
city |
String
City or Location
San Francisco
|
zip |
String
Zip code
94107
|
employee_count |
String
Total Employee count
201
|
employee_range |
String
Range for Employee count
100 - 249
|
annual_revenue |
String
Approx. Annual Revenue
$12,603,100
|
revenue_range |
String
Annual Revenue Range
$10M - $25M
|
sic |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
sic_description |
String
Additional details provided by SIC
Prepackaged Software
|
naics |
String
North American Industry Classification System (NAICS)
5112
|
naics_description |
String
Additional details provided by NAICS
Software Publishers
|
region |
String
Geographic Region of the Head Quarter
North America
|
country_iso_code |
String
Country ISO code
US
|
phone |
String
Available Contact number
(415) 212-9225
|
is_blacklisted |
True
|
is_6qa |
Boolean
Account level 6QA (true when this account is considered as hot account by 6sense)
True
|
geoIP_country |
String
geographical country of the visitor IP address
United States
|
geoIP_state |
String
geographical state of the visitor IP address
California
|
geoIP_city |
String
geographical city of the visitor IP address
San Jose
|
Score for each product |
If you have 6sense predictive package then we will also return our predictive scores at the product level. You will get Scores Information only if you have enabled it in the API Settings & Configurations. Read more
For example, if your company sells 2 products 'ace' and 'grace' you will have 2 product level predictive scores. You may have only one product or many products we will return the predictive scoring for each product you've configured. Below are the variables for each product score.
Below are sample values for these parameters.
|
is_6qa |
Boolean
Account level 6QA (true when account is considered as hot account by 6sense for this product)
True
|
product |
String
Name of your Product
ace
|
intent_score |
Number
Ranging from 0 to 100. Higher the score, better the conversion.
81
|
buying_stage |
String
Buying stage (Purchase or Decision or Consideration or Awareness) for this product for the above account. It might also return “Target” if the intent score is very low.
Purchase
|
profile_score |
Number
Ranging from 0 to 100. Higher the score, better the profile fitment.
73
|
profile_fit |
String
Strong or Moderate or Weak profile fit.
Strong
|
product_display_name |
String
Name of your product displayed externally.
ace
|
Segments |
Beyond firmographic identification, we also provide account level segments as configured within the 6sense ABM Platform. This will show segments that you've Published to APIs. Below are the segment information that you will receive in the API response.
Below are sample values for these parameters.
|
ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
names |
Array
Name of each corresponding segment
“Web Visitors Last 30 days”, “second”, “third”
|
list |
Array
Combined response for Name and id of segments
"name": "Web Visitors Last 30 days", "id": 123123
|
confidence |
String
The Confidence score (Very High or High or Moderate or Low) is a result returned in the Company Details API that represents 6sense 's confidence in the accuracy of the identity of the account.
Very High
|
Response Codes
Code | Definition |
---|---|
200 |
OK Successfully returned response. The response message varies, depending on the request method/endpoint and the requested data. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
In case of invalid IP Address, you will get blank data for each of these above mentioned variables.
If a field is not present, then we’ll return an empty list or null value for that field.
Lead Scoring API
Lead Scoring API help you to score your leads using email id on real time basis. In order to consume this API, you would need 6sense Advance Package. This API returns our predictive scores at the product level. API Token is auto-generated as per your Current 6sense Package. In case you want to create or delete these tokens, please reach out to support. Read more
HTTP Request
Headers
Header | Value |
---|---|
Authorization | Token <api_token> |
Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://scribe.6sense.com/v2/people/score' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'website=<website_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'leadsource=<leadsource_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'industry=<industry_value>'
var data = "email=<user_name>@<domain>.com &
country = < country_value >
&
company = < company_value >
&
website = < website_value >
&
title = < title_value >
&
leadsource = < leadsource_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
role = < role_value >
&
industry = < industry_value > ";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://scribe.6sense.com/v2/people/score");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://scribe.6sense.com/v2/people/score',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com\n',
'country': '<country_value>',
'company': '<company_value>',
'website': '<website_value>',
'title': '<title_value>',
'leadsource': '<leadsource_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'role': '<role_value>',
'industry': '<industry_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://scribe.6sense.com/v2/people/score"
payload=’email=<user_name>@<domain>.com
&country=<country_value>
&company=<company_value>
&website=<website_value>
&title=<title_value>
&leadsource=<leadsource_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&role=<role_value>
&industry=<industry_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://scribe.6sense.com/v2/people/score",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
{
"key": "X-Forwarded-For",
"value": "1.0.185.47",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "website",
"value": "<website_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://scribe.6sense.com/v2/people/score",
"protocol": "https",
"host": [
"scribe",
"6sense",
"com"
],
"path": [
"v2",
"people",
"score"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
Parameters | |
---|---|
Stringrequired
A Valid Email address for which you are requesting details.
xyz@acme.com
|
|
country |
Stringoptional
Base country of the company/account
US
|
website |
Stringoptional
Website of the company/account
acme.com
|
company |
Stringoptional
Name of the company/account
Dell
|
title |
Stringoptional
Designation of the Lead
Procurement Manager
|
leadsource |
Stringoptional
Source of the lead as per your database
Website form
|
firstname |
Stringoptional
First name of the Lead
ABC
|
lastname |
Stringoptional
Last name of the Lead
XYZ
|
role |
Stringoptional
Role of the Lead
Procurement Manager
|
industry |
Stringoptional
Industry of the company
Software and Technology
|
Response Data
Sample Response
{
"scores": [
{
"product": "6sense",
"company_intent_score": 0,
"company_buying_stage": "Target",
"company_profile_score": 81,
"company_profile_fit": "Strong",
"contact_intent_score": 0,
"contact_grade": "D",
"contact_profile_score": 58,
"contact_profile_fit": "Moderate"
}
]
}
Score for each product: If you have 6sense predictive package then we will also return our predictive scores at the product level. You will get Scores Information only if you have enabled it in the API Settings & Configurations. Read more
For example, if your company sells 2 products 'ace' and 'grace' you will have 2 product level predictive scores. You may have only one product or many products we will return the predictive scoring for each product you've configured. Below are the variables for each product score.
Parameters | |
---|---|
product |
String
Name of your Product
ace
|
company_intent_score |
Number
Ranging from 0 to 100. Higher the score, better the conversion.
81
|
company_buying_stage |
String
Buying stage (Purchase or Decision or Consideration or Awareness) for this product for the above account. It might also return “Target” if the intent score is very low.
Purchase
|
company_profile_score |
Number
Ranging from 0 to 100. Higher the score, better the profile fitment.
73
|
company_profile_fit |
String
Strong or Moderate or Weak profile fit.
Strong
|
contact_intent_score |
Number
Ranging from 0 to 100. Higher the score, better the buying intent.
0
|
contact_grade |
String
contact_grade (D or C or B or A) for this account.
D
|
contact_profile_score |
Number
Ranging from 0 to 100. Higher the score, better the profile fitment.
51
|
contact_profile_fit |
String
Strong or Moderate or Weak profile fit.
Moderate
|
Response Codes
Code | Definition |
---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
If a field is not present, then we’ll return an empty list or null value for that field.
Lead Enrichment API
Lead Enrichment API help you to enrich your lead using email id. In order to consume this API, you would need 6sense Essentials Package. This API returns firmographic and your Segments (published in 6sense ABM Platform for APIs). API Token is auto-generated as per your Current 6sense Package. In case you want to create or delete these tokens, please reach out to support. Read more
HTTP Request
Headers
Header | Value |
---|---|
Authorization | Token <api_token> |
Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://scribe.6sense.com/v2/people/enrichment' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'website=<website_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'leadsource=<leadsource_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'industry=<industry_value>'
var data = "email=<user_name>@<domain>.com &
country = < country_value >
&
company = < company_value >
&
website = < website_value >
&
title = < title_value >
&
leadsource = < leadsource_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
role = < role_value >
&
industry = < industry_value > ";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://scribe.6sense.com/v2/people/enrichment");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://scribe.6sense.com/v2/people/enrichment',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com\n',
'country': '<country_value>',
'company': '<company_value>',
'website': '<website_value>',
'title': '<title_value>',
'leadsource': '<leadsource_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'role': '<role_value>',
'industry': '<industry_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://scribe.6sense.com/v2/people/enrichment"
payload=’email=<user_name>@<domain>.com
&country=<country_value>
&company=<company_value>
&website=<website_value>
&title=<title_value>
&leadsource=<leadsource_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&role=<role_value>
&industry=<industry_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://scribe.6sense.com/v2/people/enrichment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
{
"key": "X-Forwarded-For",
"value": "1.0.185.47",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "website",
"value": "<website_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://scribe.6sense.com/v2/people/enrichment",
"protocol": "https",
"host": [
"scribe",
"6sense",
"com"
],
"path": [
"v2",
"people",
"enrichment"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
Parameters | |
---|---|
Stringrequired
A Valid Email address for which you are requesting details.
xyz@acme.com
|
|
country |
Stringoptional
Base country of the company/account
US
|
website |
Stringoptional
Website of the company/account
acme.com
|
company |
Stringoptional
Name of the company/account
Dell
|
title |
Stringoptional
Designation of the Lead
Procurement Manager
|
leadsource |
Stringoptional
Source of the lead as per your database
Website form
|
firstname |
Stringoptional
First name of the Lead
ABC
|
lastname |
Stringoptional
Last name of the Lead
XYZ
|
role |
Stringoptional
Role of the Lead
Procurement Manager
|
industry |
Stringoptional
Industry of the company
Software and Technology
|
Response Data
Sample Response
{
"company": {
"domain": "6sense.com",
"name": "6sense",
"region": "Northern America",
"country": "United States",
"countryISOCode": "US",
"state": "California",
"city": "San Francisco",
"streetAddress": "450 Mission St,",
"postalCode": "94105",
"companyPhone": "415-212-9225",
"industry": "Software and Technology",
"employeeRange": "1,000 - 4,999",
"revenueRange": "$100M - $250M",
"employeeCount": "1192",
"annualRevenue": "104000000",
"titleLevel": "staff",
"titleFunction": "engineering",
"sicdescription": "Prepackaged Software",
"siccode": "7372",
"naicscode": "511210",
"naicsdescription": "Software Publishers"
},
"segments": {
"ids": [],
"names": [],
"list": []
}
}
Account/company Level Variables: Below are the list of company variables that will be available in the API response.
Parameters | |
---|---|
name |
String
Name of the company
6sense
|
domain |
String
Website of the company
6sense.com
|
industry |
String
Industry of the company
Software and Technology
|
industry_v2 |
Object
Industry and Sub-Industry of the company
"industry": "Education","subindustry": "Colleges & Universities"
|
country |
String
Head office of the company
United States
|
address |
String
Address
450 Mission
|
state |
String
State
California
|
city |
String
City or Location
San Francisco
|
zip |
String
Zip code
94107
|
employee_count |
String
Total Employee count
201
|
employee_range |
String
Range for Employee count
100 - 249
|
annual_revenue |
String
Approx. Annual Revenue
$12,603,100
|
titleLevel |
String
Title of the Org-structure level
staff
|
titleFunction |
String
Function title
engineering
|
revenue_range |
String
Annual Revenue Range
$10M - $25M
|
sic |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
sic_description |
String
Additional details provided by SIC
Prepackaged Software
|
naics |
String
North American Industry Classification System (NAICS)
5112
|
naics_description |
String
Additional details provided by NAICS
Software Publishers
|
region |
String
Geographic Region of the Head Quarter
North America
|
country_iso_code |
String
Country ISO code
US
|
phone |
String
Available Contact number
(415) 212-9225
|
is_blacklisted |
Boolean
Excluded (True or False)
True
|
Segments |
Beyond firmographic identification, we also provide account level segments as configured within the 6sense ABM Platform. This will show segments that you've Published to APIs. Below are the segment information that you will receive in the API response.
Below are sample values for these parameters.
|
ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
names |
Array
Name of each corresponding segment
“Web Visitors Last 30 days”, “second”, “third”
|
list |
Array
Combined response for Name and id of segments
"name": "Web Visitors Last 30 days",
|
Response Codes
Code | Definition |
---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
If a field is not present, then we’ll return an empty list or null value for that field.
Lead Enrichment and Scoring API
Lead Enrichment and Scoring API (previously known as Real Time Scoring API or RTS) is a combo API for Lead enrichment and Lead scoring in a single response. This API returns firmographs, segments (published in 6sense ABM Platform for APIs) and scores from email id of your customers. You can store these details in your CRM or any other system to have more information about your Lead. API Token is auto-generated as per your Current 6sense Package. In case you want to create or delete these tokens, please reach out to support. Read more
HTTP Request
Headers
Header | Value |
---|---|
Authorization | Token <api_token> |
Content-Type | application/x-www-form-urlencoded |
Input Params
Sample Request
curl --location --request POST 'https://scribe.6sense.com/v2/people/full' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--header 'Authorization: Token {your_api_token}' \
--data-urlencode 'email=<user_name>@<domain>.com' \
--data-urlencode 'country=<country_value>' \
--data-urlencode 'company=<company_value>' \
--data-urlencode 'website=<website_value>' \
--data-urlencode 'title=<title_value>' \
--data-urlencode 'leadsource=<leadsource_value>' \
--data-urlencode 'firstname=<firstname_value>' \
--data-urlencode 'lastname=<lastname_value>' \
--data-urlencode 'role=<role_value>' \
--data-urlencode 'industry=<industry_value>'
var data = "email=<user_name>@<domain>.com &
country = < country_value >
&
company = < company_value >
&
website = < website_value >
&
title = < title_value >
&
leadsource = < leadsource_value >
&
firstname = < firstname_value >
&
lastname = < lastname_value >
&
role = < role_value >
&
industry = < industry_value > ";
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function() {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://scribe.6sense.com/v2/people/full");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Cache-Control", "no-cache");
xhr.setRequestHeader("Authorization", "Token {your_api_token}");
xhr.send(data);
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://scribe.6sense.com/v2/people/full',
'headers': {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
},
form: {
'email': '<user_name>@<domain>.com\n',
'country': '<country_value>',
'company': '<company_value>',
'website': '<website_value>',
'title': '<title_value>',
'leadsource': '<leadsource_value>',
'firstname': '<firstname_value>',
'lastname': '<lastname_value>',
'role': '<role_value>',
'industry': '<industry_value>'
}
};
request(options, function(error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "https://scribe.6sense.com/v2/people/full"
payload=’email=<user_name>@<domain>.com
&country=<country_value>
&company=<company_value>
&website=<website_value>
&title=<title_value>
&leadsource=<leadsource_value>
&firstname=<firstname_value>
&lastname=<lastname_value>
&role=<role_value>
&industry=<industry_value>’
headers = {
'Content-Type': 'application/x-www-form-urlencoded',
'Cache-Control': 'no-cache',
'Authorization': 'Token {your_api_token}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
{
"info": {
"name": "sample_scribe",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "https://scribe.6sense.com/v2/people/full",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"value": "application/x-www-form-urlencoded",
"type": "text"
},
{
"key": "Cache-Control",
"value": "no-cache",
"type": "text"
},
{
"key": "Authorization",
"value": "Token {your_api_token}",
"type": "text"
},
{
"key": "X-Forwarded-For",
"value": "1.0.185.47",
"type": "text",
"disabled": true
}
],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "email",
"value": "<user_name>@<domain>.com\n",
"type": "text"
},
{
"key": "country",
"value": "<country_value>",
"type": "text"
},
{
"key": "company",
"value": "<company_value>",
"type": "text"
},
{
"key": "website",
"value": "<website_value>",
"type": "text"
},
{
"key": "title",
"value": "<title_value>",
"type": "text"
},
{
"key": "leadsource",
"value": "<leadsource_value>",
"type": "text"
},
{
"key": "firstname",
"value": "<firstname_value>",
"type": "text"
},
{
"key": "lastname",
"value": "<lastname_value>",
"type": "text"
},
{
"key": "role",
"value": "<role_value>",
"type": "text"
},
{
"key": "industry",
"value": "<industry_value>",
"type": "text"
}
]
},
"url": {
"raw": "https://scribe.6sense.com/v2/people/full",
"protocol": "https",
"host": [
"scribe",
"6sense",
"com"
],
"path": [
"v2",
"people",
"full"
],
"query": [
{
"key": "country",
"value": "",
"disabled": true
}
]
}
},
"response": []
}
]
}
Parameters | |
---|---|
Stringrequired
A Valid Email address for which you are requesting details.
xyz@acme.com
|
|
country |
Stringoptional
Base country of the company/account
US
|
website |
Stringoptional
Website of the company/account
acme.com
|
company |
Stringoptional
Name of the company/account
Dell
|
title |
Stringoptional
Designation of the Lead
Procurement Manager
|
leadsource |
Stringoptional
Source of the lead as per your database
Website form
|
firstname |
Stringoptional
First name of the Lead
ABC
|
lastname |
Stringoptional
Last name of the Lead
XYZ
|
role |
Stringoptional
Role of the Lead
Procurement Manager
|
industry |
Stringoptional
Industry of the company
Software and Technology
|
Response Data
Sample Response
{
"company": {
"domain": "6sense.com",
"name": "6sense",
"region": "Northern America",
"country": "United States",
"countryISOCode": "US",
"state": "California",
"city": "San Francisco",
"streetAddress": "450 Mission St,",
"postalCode": "94105",
"companyPhone": "415-212-9225",
"industry": "Software and Technology",
"employeeRange": "1,000 - 4,999",
"revenueRange": "$100M - $250M",
"employeeCount": "1192",
"annualRevenue": "104000000",
"titleLevel": "staff",
"titleFunction": "engineering",
"sicdescription": "Prepackaged Software",
"siccode": "7372",
"naicscode": "511210",
"naicsdescription": "Software Publishers"
},
"scores": [
{
"product": "6sense",
"company_intent_score": 0,
"company_buying_stage": "Target",
"company_profile_score": 81,
"company_profile_fit": "Strong",
"contact_intent_score": 0,
"contact_grade": "D",
"contact_profile_score": 58,
"contact_profile_fit": "Moderate"
}
],
"segments": {
"ids": [
4713,
28237,
218915,
53685
],
"names": [
"Net New Logo Website Engagement Last 30 Days",
"6s for 6s: Keyword_Sales Intelligence",
"Cvent: Researching Virtual Events",
"EY - Enterprise Accounts (DemandGen)"
],
"list": [
{
"name": "Net New Logo Website Engagement Last 30 Days",
"id": 4713
},
{
"name": "6s for 6s: Keyword_Sales Intelligence",
"id": 28237
},
{
"name": "Cvent: Researching Virtual Events",
"id": 218915
},
{
"name": "EY - Enterprise Accounts (DemandGen)",
"id": 53685
}
]
},
}
Parameters | |
---|---|
Account/company Level Variables |
Below are the list of company variables that will be available in the API response.
Below are sample values for these parameters.
|
name |
String
Name of the company
6sense
|
domain |
String
Website of the company
6sense.com
|
industry |
String
Industry of the company
Software and Technology
|
country |
String
Country
United States
|
address |
String
Address
450 Mission
|
state |
String
State
California
|
city |
String
City or Location
San Francisco
|
zip |
String
Zip code
94107
|
employee_count |
String
Total Employee count
201
|
employee_range |
String
Range for Employee count
100 - 249
|
annual_revenue |
String
Approx. Annual Revenue
$12,603,100
|
titleLevel |
String
Title of the Org-structure level
staff
|
titleFunction |
String
Function title
engineering
|
revenue_range |
String
Annual Revenue Range
$10M - $25M
|
sic |
String
Standard Industrial Classification Codes (SIC Codes) of the company
7372
|
sic_description |
String
Additional details provided by SIC
Prepackaged Software
|
naics |
String
North American Industry Classification System (NAICS)
5112
|
naics_description |
String
Additional details provided by NAICS
Software Publishers
|
region |
String
Geographic Region of the Head Quarter
North America
|
country_iso_code |
String
Country ISO code
US
|
phone |
String
Available Contact number
(415) 212-9225
|
is_blacklisted |
Boolean
Excluded (True or False)
True
|
Score for each product |
If you have 6sense predictive package then we will also return our predictive scores at the product level. You will get Scores Information only if you have enabled it in the API Settings & Configurations. Read more
For example, if your company sells 2 products 'ace' and 'grace' you will have 2 product level predictive scores. You may have only one product or many products we will return the predictive scoring for each product you've configured. Below are the variables for each product score.
Below are sample values for these parameters.
|
product |
String
Name of your Product
ace
|
company_intent_score |
Number
Ranging from 0 to 100. Higher the score, better the conversion.
81
|
company_buying_stage |
String
Buying stage (Purchase or Decision or Consideration or Awareness) for this product for the above account. It might also return “Target” if the intent score is very low.
Purchase
|
company_profile_score |
Number
Ranging from 0 to 100. Higher the score, better the profile fitment.
73
|
company_profile_fit |
String
Strong or Moderate or Weak profile fit.
Strong
|
contact_intent_score |
Number
Ranging from 0 to 100. Higher the score, better the buying intent.
0
|
contact_grade |
String
contact_grade (D or C or B or A) for this account.
D
|
contact_profile_score |
String
Ranging from 0 to 100. Higher the score, better the profile fitment.
51
|
contact_profile_fit |
String
Strong or Moderate or Weak profile fit.
Moderate
|
Segments |
Beyond firmographic identification, we also provide account level segments as configured within the 6sense ABM Platform. This will show segments that you've Published to APIs. Below are the segment information that you will receive in the API response.
Below are sample values for these parameters.
|
ids |
Array
Id for single or multiple segments
12121 or 456456, 119900, 226688,
|
names |
Array
Name of each corresponding segment
“Web Visitors Last 30 days”, “second”, “third”
|
list |
Array
Combined response for Name and id of segments
"name": "Web Visitors Last 30 days",
"id": 123123 |
Response Codes
Code | Definition |
---|---|
200 |
OK Successfully returned response against an email address |
404 |
Not found Invalid email ID. Please make sure you have sent a valid email address in email field. |
OTHERS |
Other common HTTP response codes Please see HTTP Response Codes to know more codes. |
If a field is not present, then we’ll return an empty list or null value for that field.
FAQs
These FAQs should answer most of your queries but if you still have any other queries, please reach out to your Success Manager.
Q: What are Firmographics?
A: Firmographics are a collection of descriptive attributes used by B2B organizations to segment their target market and discover their ideal customers. Such data helps categorize companies according to geographic location, industry, customer base, type of organization, technologies used, etc. With this information at hand, you can build a more effective lead generation strategy and improve your marketing and sales campaigns. Know more about Firmographics.
Q: Will these API slow down my page load?
A: Not at all! The API is designed to load asynchronously in the background.
Q: How many API calls are made per visitor in Company Details API?
A: One API call per visitor browsing your website.
: How fast is the response time for the API?
A: Generally under 150ms depending on location, with under 50ms not uncommon in US. It is production ready and built to scale and has already been deployed on hundreds of pages without issue.
Q: Do you support both client-side and server-side implementations?
A: Yes! you can implement these APIs as per your Tech Stack requirement.
Q: I want to integrate with a solution outside 6sense Network. Can 6sense do it?
A: The answer is dependent on the solution and business constraints and sometimes requires development work but is most likely yes. Contact your 6sense Customer Success Manager for more details or an integration request.
Q: I’m on my mobile cellular network, will the API work?
A: Your cellular network will have an IP address that belongs to a cell company (like ATT). The API will most likely identify the mobile visitor as your mobile provider.
Q: I’m in my Company’s HQ, why is the data identifying me as a different company?
A: It’s likely that we are identifying the previous tenant/occupant of your HQ. It’s also likely that you share a block of IPs from another tenant in the building. It’s also likely that your ISP has made a recent change.
Q: What is your match rate?
A: 6sense delivers one of the highest match rate in the industry. The match rate depends on the type of traffic you are seeing. For example: If the website is primarily B2B, software and tech, and US based, it can be as high as 75%. However, we are constantly making improvements to our data to boost the match rate so please don't hesitate to give us feedback.
Q: Why is the data incorrect?
A: 6sense has the best in house data scientists, but we are only as good as our data that we receive. Furthermore, as we get our data from data vendors, we are at the mercy at how quickly the data vendors update them. Our machine learning algorithm is constantly getting better and will self-correct as we see more intent data on the B2B network.
Q: How often does the firmographic data update?
A: 6sense gets its data from data vendors generally monthly or quarterly.
Q: Do you have a static list of values that are populated in the Company Details API?
A: Yes! See the attachment below, or check out our Dojo for the list of static firmographic attributes. Available Data Values for Key Firmographic Properties. You would need 6sense account to access this.