Introduction
The ExactVisitor APIs provide programmatic access to visitor tracking on your websites, in real-time.
- The APIs conform to REST principles
- The JSON data format is used for responses and POST requests
- All resources require authentication
- Requests are rate-limited and metered
- Endpoints are HTTPS only # Authentication
To authorize, use this code:
Go to your settings page to find your API KEY
API = API KEY
Authentication is done via your account’s API key which is:
Found under your Settings Page
Requests are authenticated using HTTP Basic Auth. Provide your API key as the basic auth username. You do not need to provide a password.
Alternatively you can also pass your API key as a bearer token in an Authorization header.
Visitor by IP
Visitor by IP
CRUL: https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?ip={IP}
curl https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?ip={IP}
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 1,
"data": [
{
"visitors": [
{
"country": "Spain",
"sessions": [
{
"utm_term": null,
"referrer": "https://www.appypie.com/exact-visitor.html",
"pages": [
{
"time": 0,
"title": "",
"url": "https://www.appypie.com/exact-visitor.html"
}
],
"visited_from_hq": false,
"ip": "2.139.110.248",
"query": null,
"source_2": null,
"created_at": "2022-03-01 14:54:17",
"source_type": "Direct traffic",
"source": null,
"source_1": null,
"tracking_id": "ouhoj779dmd1eo2b"
}
],
"city": "Benahavis",
"internet_service_provider": null,
"time": 0,
"tracking_id": "c2d90d80a0205c1c2c6fbda136855c74",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
}
],
"company": {
"domain": "usedemand.com",
"name": "usedemand.com",
"id": "abed51a2-cbe3-5c05-8ab7-1bdb24d954b3"
},
"id": "ETz5RX8BbKvgQrb1kjdw",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?ip={IP}
Attributes
| Parameter | Type | Description |
|---|---|---|
| account_id | string | ID of your account |
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Persons Visited
Persons Visited
CRUL: https://api.exactvisitor.com/api/accounts/{account_id}/leads?start_date={date}&end_date={date}
curl https://api.exactvisitor.com/api/accounts/{account_id}/leads?start_date={date}&end_date={date}
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 2,
"data": [
{
"emails": [
{
"email": "jq@usedemand.com"
}
],
"company": {
"website": null,
"image_url": "https://s3.amazonaws.com/logo.usedemand/61afe730e11ce-61afe730e11d0-usedemand.com.png",
"domain": "usedemand.com",
"name": "usedemand.com",
"description": "",
"phones": [
{
"number": "=2147483647"
},
{
"number": "2147483647"
},
{
"number": "0.005000"
},
{
"number": "019-06-13"
},
{
"number": "021-02-27"
},
{
"number": "1 (650) 741-0510"
},
{
"number": "0) 741-0510"
}
],
"industry": "",
"locations": [],
"employees_range": ""
},
"id": "Ejz5RX8BbKvgQrb1lTeL",
"relations": []
},
{
"emails": [
{
"email": "jq@usedemand.com"
}
],
"company": {
"website": null,
"image_url": "https://s3.amazonaws.com/logo.usedemand/61afe730e11ce-61afe730e11d0-usedemand.com.png",
"domain": "usedemand.com",
"name": "usedemand.com",
"description": "",
"phones": [
{
"number": "=2147483647"
},
{
"number": "2147483647"
},
{
"number": "0.005000"
},
{
"number": "019-06-13"
},
{
"number": "021-02-27"
},
{
"number": "1 (650) 741-0510"
},
{
"number": "0) 741-0510"
}
],
"industry": "",
"locations": [],
"employees_range": ""
},
"id": "EDz5RX8BbKvgQrb1kTdV",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/{account_id}/leads?start_date={date}&end_date={date}
Attributes
| Parameter | Type | Description |
|---|---|---|
| account_id | string | ID of your account |
| start_date | string | (yyyy-mm-dd) |
| end_date | string | (yyyy-mm-dd) |
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Leads Visited
Leads Visited
CRUL: https://api.exactvisitor.com/api/accounts/{account_id}/leads-visits?start_date={date}&end_date={date}
curl https://api.exactvisitor.com/api/accounts/{account_id}/leads-visits?start_date={date}&end_date={date}
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 2,
"data": [
{
"emails": [
{
"email": "jq@usedemand.com"
}
],
"sessions": [
{
"visited_from_hq": false,
"ip": "2.139.110.248",
"query": null,
"created_at": "2022-03-01 14:54:17",
"source_type": "Direct traffic",
"source": null,
"utm_term": null,
"s_tracking_id": "ouhoj779dmd1eo2b",
"referrer": "https://www.appypie.com/exact-visitor.html",
"pages": [
{
"time": 0,
"title": "",
"url": "https://www.appypie.com/exact-visitor.html"
}
],
"source_2": null,
"source_1": null,
"tracking_id": "c2d90d80a0205c1c2c6fbda136855c74"
}
],
"id": "Ejz5RX8BbKvgQrb1lTeL",
"relations": []
},
{
"emails": [
{
"email": "jq@usedemand.com"
}
],
"sessions": [
{
"visited_from_hq": false,
"ip": "2.139.110.248",
"query": null,
"created_at": "2022-03-01 14:54:17",
"source_type": "Direct traffic",
"source": null,
"utm_term": null,
"s_tracking_id": "ouhoj779dmd1eo2b",
"referrer": "https://www.appypie.com/exact-visitor.html",
"pages": [
{
"time": 0,
"title": "",
"url": "https://www.appypie.com/exact-visitor.html"
}
],
"source_2": null,
"source_1": null,
"tracking_id": "c2d90d80a0205c1c2c6fbda136855c74"
}
],
"id": "EDz5RX8BbKvgQrb1kTdV",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/{account_id}/leads-visits?start_date={date}&end_date={date}
Attributes
| Parameter | Type | Description |
|---|---|---|
| account_id | string | ID of your account |
| start_date | string | (yyyy-mm-dd) |
| end_date | string | (yyyy-mm-dd) |
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Companies Visited
Companies Visited
CRUL: hhttps://api.exactvisitor.com/api/accounts/{account_id}/companies?start_date={date}&end_date={date}
curl https://api.exactvisitor.com/api/accounts/{account_id}/companies?start_date={date}&end_date={date}
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 1,
"data": [
{
"first_visit": "2022-03-01 14:54:17",
"last_visit": "2022-03-01 14:54:17",
"times_visited": 1,
"pages_viewed": 1,
"company": {
"image_url": "https://s3.amazonaws.com/logo.usedemand/61afe730e11ce-61afe730e11d0-usedemand.com.png",
"domain": "usedemand.com",
"name": "usedemand.com",
"industry": null,
"locations": [],
"id": "abed51a2-cbe3-5c05-8ab7-1bdb24d954b3",
"employees_range": null
},
"id": "ETz5RX8BbKvgQrb1kjdw",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/{account_id}/companies?start_date={date}&end_date={date}
Attributes
| Parameter | Type | Description |
|---|---|---|
| account_id | string | ID of your account |
| start_date | string | (yyyy-mm-dd) |
| end_date | string | (yyyy-mm-dd) |
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Visitor by their Email
Visitor by their Email
CRUL: https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?email={EMAIL}
curl https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?email={EMAIL}
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 1,
"data": [
{
"visitors": [
{
"country": "Spain",
"sessions": [
{
"utm_term": null,
"referrer": "https://www.appypie.com/exact-visitor.html",
"pages": [
{
"time": 0,
"title": "",
"url": "https://www.appypie.com/exact-visitor.html"
}
],
"visited_from_hq": false,
"ip": "2.139.110.248",
"query": null,
"source_2": null,
"created_at": "2022-03-01 14:54:17",
"source_type": "Direct traffic",
"source": null,
"source_1": null,
"tracking_id": "ouhoj779dmd1eo2b"
}
],
"city": "Benahavis",
"internet_service_provider": null,
"time": 0,
"tracking_id": "c2d90d80a0205c1c2c6fbda136855c74",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
}
],
"company": {
"domain": "usedemand.com",
"name": "usedemand.com",
"id": "abed51a2-cbe3-5c05-8ab7-1bdb24d954b3"
},
"id": "ETz5RX8BbKvgQrb1kjdw",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?email={EMAIL}
Attributes
| Parameter | Type | Description |
|---|---|---|
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Return all Companies
Return all Companies
CRUL: https://api.exactvisitor.com/api/accounts/{account_id}/companies-visits?start_date={date}&end_date={
date}&ip={ip}&email={email}
curl https://api.exactvisitor.com/api/accounts/{account_id}/companies-visits?start_date={date}&end_date={
date}&ip={ip}&email={email}
-
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 1,
"data": [
{
"first_visit": "2022-03-01 14:54:17",
"last_visit": "2022-03-01 14:54:17",
"times_visited": 1,
"pages_viewed": 1,
"company": {
"image_url": "https://s3.amazonaws.com/logo.usedemand/61afe730e11ce-61afe730e11d0-usedemand.com.png",
"domain": "usedemand.com",
"name": "usedemand.com",
"industry": null,
"locations": [],
"id": "abed51a2-cbe3-5c05-8ab7-1bdb24d954b3",
"employees_range": "11-50",
},
"id": "ETz5RX8BbKvgQrb1kjdw",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/{account_id}/companies-visits?start_date={date}&end_date={ date}&ip={ip}&email={email}
Attributes
| Parameter | Type | Description |
|---|---|---|
| account_id | string | ID of your account |
| start_date | string | (yyyy-mm-dd) |
| end_date | string | (yyyy-mm-dd) |
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Visitors by Date Range
Visitors by Date Range
CRUL: https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?start_date={YEAR-MONTH-DATE}&end_date={YEAR-MONTH-DATE}
curl https://api.exactvisitor.com/api/accounts/{ACCOUNT ID}/companies-visits?start_date={YEAR-MONTH-DATE}&end_date={YEAR-MONTH-DATE}
-
-XGET
-H "token:yourapitoken"
The above command returns JSON structured like this:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 1,
"data": [
{
"visitors": [
{
"country": "Spain",
"sessions": [
{
"utm_term": null,
"referrer": "https://www.appypie.com/exact-visitor.html",
"pages": [
{
"time": 0,
"title": "",
"url": "https://www.appypie.com/exact-visitor.html"
}
],
"visited_from_hq": false,
"ip": "2.139.110.248",
"query": null,
"source_2": null,
"created_at": "2022-03-01 14:54:17",
"source_type": "Direct traffic",
"source": null,
"source_1": null,
"tracking_id": "ouhoj779dmd1eo2b"
}
],
"city": "Benahavis",
"internet_service_provider": null,
"time": 0,
"tracking_id": "c2d90d80a0205c1c2c6fbda136855c74",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
}
],
"company": {
"domain": "usedemand.com",
"name": "usedemand.com",
"id": "abed51a2-cbe3-5c05-8ab7-1bdb24d954b3"
},
"id": "ETz5RX8BbKvgQrb1kjdw",
"relations": []
}
],
"aggs": []
}
}
]
Know the company visiting by real time converstion to company data.
HTTP Request
`GET https://api.exactvisitor.com/api/accounts/916/companies-visits?start_date={YEAR-MONTH-DATE}&end_date={YEAR-MONTH-DATE}
Attributes
| Parameter | Type | Description |
|---|---|---|
| country | string | Country of the company |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Visits of a Specific Company
Visits of a Specific Company
GET https://api.exactvisitor.com/api/accounts/{account_id}/companies/{company_id}/visits?start_date={YEAR-MONTH-DATE}&end_date={YEAR-MONTH-DATE}
The above command returns JSON structured like this the limit is number of companies returned and uses a credit for each domain:
[
{
"data": {
"limit": 10,
"offset": 0,
"total": 1,
"data": [
{
"visitors": [
{
"country": "Spain",
"sessions": [
{
"utm_term": null,
"referrer": "https://www.appypie.com/exact-visitor.html",
"pages": [
{
"time": 0,
"title": "",
"url": "https://www.appypie.com/exact-visitor.html"
}
],
"visited_from_hq": false,
"ip": "2.139.110.248",
"query": null,
"source_2": null,
"created_at": "2022-03-01 14:54:17",
"source_type": "Direct traffic",
"source": null,
"source_1": null,
"tracking_id": "ouhoj779dmd1eo2b"
}
],
"city": "Benahavis",
"internet_service_provider": null,
"time": 0,
"tracking_id": "c2d90d80a0205c1c2c6fbda136855c74",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36"
}
],
"company": {
"domain": "usedemand.com",
"name": "usedemand.com",
"id": "abed51a2-cbe3-5c05-8ab7-1bdb24d954b3"
},
"id": "ETz5RX8BbKvgQrb1kjdw",
"relations": []
}
],
"aggs": []
}
}
]
This API enables you to return the install by domain from any Technology - the limit is number of companies returned and uses a credit for each domain.
HTTP Request
GET https://api.exactvisitor.com/api/accounts/{account_id}/companies/{company_id}/visits?start_date={YEAR-MONTH-DATE}&end_date={YEAR-MONTH-DATE}
Attributes
| Parameter | Type | Description |
|---|---|---|
| account_id | string | ID of your account |
| company_id | string | ID of the company found in ExactVisitor |
| start_date | string | (yyyy-mm-dd) |
| end_date | string | (yyyy-mm-dd) |
| utm_term | string | UTM details if passed on from refferal link or ad. |
| referrer | string | Refferal page to your website. |
| pages | string | Pages they have visited and time etc. |
| visited_from_hq | string | If the visit took place from their Headquarter or some where else |
| domain | string | Domain of the Company |
| name | string | Company Name |
Errors
The ExactVisitor API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The domain requested is hidden for administrators only. |
| 404 | Not Found -- The specified domain could not be found. |
| 405 | Method Not Allowed -- You tried to access a domain with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The Data requested has been removed from our servers. |
| 418 | I am a Techtracker VIP. |
| 429 | Too Many Requests -- You're requesting too many domains! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |