Websitez.com - Turn Anonymous Website Traffic Into Valuable Leads

Documentation

The API is a powerful way to interact with our services. Use the API's to programmatically interact with everything you can do through our website.

Getting Started

Environments

Our production environment is available at:

https://api.websitez.com/

Versioning

This API uses versioning as identified in the URI. Newer versions MAY introduce breaking changes.

/v1/users

HTTP Methods

This API uses HTTP verbs (methods) as following:

GET - Read - used to read (or retrieve) a representation of a resource,
POST - Create - used to create new resources.
PUT - Update - used to update an existing resource identified by a URI.
DELETE - Delete - used to delete a resource identified by a URI.

Pagination

When next_page is present in the API response, this means the results are paginated. If the value is null, there are no more results. If it is a valid integer, there are more results and you must make additional requests to get them.

When a valid integer is present, it should be used to call the same API endpoint again with ?page=5 appended to the URL, where 5 is the value of next_page in the API response.

By default, the number of results returned is 20. This can be changed by passing a query string parameter called per_page with a valid integer such as ?per_page=50.

The minimum and maximum value for per_page is 1 and 100, respectively.

Media Type

Where applicable this API MUST use the JSON media-type. Requests with a message-body are using plain JSON to set or update resource states.

Content-type: application/json and Accept: application/json headers SHOULD be set on all requests if not stated otherwise.

Date and Time

All exchange of date and time-related data MUST be done according to ISO 8601 standard and stored in UTC.

When returning date and time-related data YYYY-MM-DDThh:mm:ss.SSSZ format MUST be used.

Status Codes and Errors

This API uses HTTP status codes to communicate with the API:

200 OK - Response to a successful GET, PUT, PATCH or DELETE.
201 Created - Response to a POST that results in a creation.
202 Accepted - Response to a request if an actioned will be queued for offline processing.
204 No Content - Response to a successful request that won't be returning a body (like a DELETE request).
400 Bad Request - Malformed request; form validation errors.
401 Unauthorized - When no or invalid authentication details are provided.
403 Forbidden - When authentication succeeded but authenticated user doesn't have access to the resource.
404 Not Found - When a non-existent resource is requested.
405 Method Not Allowed - Method not allowed.
406 Not Acceptable - Could not satisfy the request.
415 Unsupported Media Type - Unsupported media type in request.
422 Validation failed - Supplied data did not pass validation.
500 Internal server error - An uncaught exception occurred.
502 Bad Gateway - An error occurred in downstream service.

Authentication

Your API token is used to authenticate you with our API through the `Authorization` header.

$ curl -H "Authorization: Bearer 79bb63b4202735" https://api.websitez.com

Auto Assignments

Auto assignments allow leads to be assigned to a user automatically based on criteria of the lead. For example, if you wanted all company leads with revenue over $100 million to be assigned to Joe, and all company leads less than $100 million to be assigned to Anne, that can be done through this endpoint.

Create An Auto Assignment

Programmatically create an auto assignment. The concept of the "and" "or" is similar to how it is treated in SQL. If two items have an "and" condition between them, both must match. If the condition is "or", only one of the two has to match. If "and" condition is chained, all conditions must match.

POST/v1/auto_assignments

Field	Type	Description
assigned_user_ids	ARRAY of INTEGERS	The ID's of the users to assign the leads to.
employees_min	INTEGER	The minimum number of employees at the company.
employees_max	INTEGER	The maximum number of employees at the company.
revenue_min	INTEGER	The minimum revenue at the company.
revenue_max	INTEGER	The maximum revenue at the company.
company_name	STRING	The company name match pattern.
industries	STRING	The industries for the company to be included in. Acceptable values can be found here.
first_and_or	STRING	Whether the comparison between employees and revenue is an "and" or an "or".
second_and_or	STRING	Whether the comparison between revenue and company_name is an "and" or an "or".
third_and_or	STRING	Whether the comparison between company_name and industries is an "and" or an "or".

Request Sample

curl https://api.websitez.com/v1/auto_assignments
{
    "assigned_user_id": 1,
    "company_id": 1,
    "employees_min": 1,
    "employees_max": 100000,
    "revenue_min": 1,
    "revenue_max": 10000000,
    "company_name": "Google",
    "industries": "Internet & Telecom > Service Providers, Internet & Telecom > Service Providers > Cable & Satellite Providers",
    "first_and_or": "and",
    "second_and_or": "and",
    "third_and_or": "or"
}

Response Sample

{
    "id": 1,
    "assigned_user_id": 1,
    "company_id": 1,
    "employees_min": 1,
    "employees_max": 100000,
    "revenue_min": 1,
    "revenue_max": 10000000,
    "company_name": "Google",
    "industries": "Internet & Telecom > Service Providers, Internet & Telecom > Service Providers > Cable & Satellite Providers",
    "first_and_or": "and",
    "second_and_or": "and",
    "third_and_or": "or",
    "active": true,
    "timestamp": "2003-04-12 04:05:06",
}

Field	Type	Description
id	INTEGER	The ID of the auto assignment entry.
assigned_user_ids	ARRAY of INTEGERS	The ID's of the users to assign the leads to.
employees_min	INTEGER	The minimum number of employees at the company.
employees_max	INTEGER	The maximum number of employees at the company.
revenue_min	INTEGER	The minimum revenue at the company.
revenue_max	INTEGER	The maximum revenue at the company.
company_name	STRING	The company name match pattern.
industries	STRING	The industries for the company to be included in. Acceptable values can be found here.
first_and_or	STRING	Whether the comparison between employees and revenue is an "and" or an "or".
second_and_or	STRING	Whether the comparison between revenue and company_name is an "and" or an "or".
third_and_or	STRING	Whether the comparison between company_name and industries is an "and" or an "or".
active	BOOLEAN	Determines whether the auto assignment is being applied or not.
timestamp	DATETIME	A date time of when the auto assignment entry was created.

View Auto Assignments

View all auto assignments created for an account.

GET/v1/auto_assignments

Request Sample

curl https://api.websitez.com/v1/auto_assignments

Response Sample

{"auto_assignments": [{
    "id": 1,
    "assigned_user_id": 1,
    "company_id": 1,
    "employees_min": 1,
    "employees_max": 100000,
    "revenue_min": 1,
    "revenue_max": 10000000,
    "company_name": "Google",
    "industries": "Internet & Telecom > Service Providers, Internet & Telecom > Service Providers > Cable & Satellite Providers",
    "first_and_or": "and",
    "second_and_or": "and",
    "third_and_or": "or",
    "active": true,
    "timestamp": "2003-04-12 04:05:06",
}], "next_page": null}

Field	Type	Description
id	INTEGER	The ID of the auto assignment entry.
assigned_user_id	INTEGER	The ID of the user to assign the leads to.
employees_min	INTEGER	The minimum number of employees at the company.
employees_max	INTEGER	The maximum number of employees at the company.
revenue_min	INTEGER	The minimum revenue at the company.
revenue_max	INTEGER	The maximum revenue at the company.
company_name	STRING	The company name match pattern.
industries	STRING	The industries for the company to be included in. Acceptable values can be found here.
first_and_or	STRING	Whether the comparison between employees and revenue is an "and" or an "or".
second_and_or	STRING	Whether the comparison between revenue and company_name is an "and" or an "or".
third_and_or	STRING	Whether the comparison between company_name and industries is an "and" or an "or".
active	BOOLEAN	Determines whether the auto assignment is being applied or not.
timestamp	DATETIME	A date time of when the auto assignment entry was created.

Assignments

Assignments represent the leads assigned to users. This can be done manually through the UI, the API, or through auto assignment functionality.

Create An Assignment

Programmatically create an assignment.

POST/v1/assignments

Field	Type	Description
assigned_user_id	INTEGER	The ID of the user to assign the lead to.
company_id	INTEGER	The id of the company to assign.

Request Sample

curl https://api.websitez.com/v1/assignments
{
    "assigned_user_id": 1,
    "company_id": 1
}

Response Sample

{
    "id": 1,
    "assigned_user_id": 1,
    "assigned_from_user_id": 2,
    "active": true,
    "viewed": true,
    "timestamp": "2003-04-12 04:05:06",
}

Field	Type	Description
id	INTEGER	The ID of the assignment entry.
assigned_user_id	INTEGER	The ID of the user to assign the lead to.
company_id	INTEGER	The id of the company to assign.
active	BOOLEAN	Determines whether the assignment is active for the assigned user.
viewed	BOOLEAN	Determines whether the assignment has been viewed yet.
timestamp	DATETIME	The date and time when the assignment was created.

View Assignments

View all assignments created for an account.

GET/v1/assignments

Request Sample

curl https://api.websitez.com/v1/assignments

Response Sample

{"assignments": [{
    "id": 1,
    "assigned_user_id": 1,
    "assigned_from_user_id": 2,
    "active": true,
    "viewed": true,
    "timestamp": "2003-04-12 04:05:06",
}], "next_page": null}

Field	Type	Description
id	INTEGER	The ID of the assignment entry.
assigned_user_id	INTEGER	The ID of the user to assign the lead to.
company_id	INTEGER	The id of the company to assign.
active	BOOLEAN	Determines whether the assignment is active for the assigned user.
viewed	BOOLEAN	Determines whether the assignment has been viewed yet.
timestamp	DATETIME	The date and time when the assignment was created.

Users

Users are the basis of all actions through the API. An API Key is assigned to a user, thus everything done through the API is associated with a user.

Register A New User

Programmatically register a user and receive an API key in the response. Email verification is required before user can login or use the API.

This will create a new account for the user.

POST/v1/register

Field	Type	Description
email	STRING	This will be used as the username. An email verification will be sent here.
terms	STRING	This records that for each user the terms are explicitly agreed to.

Request Sample

curl https://api.websitez.com/v1/register
{
    "email": "test@test.com",
    "terms": "yes"
}

Response Sample

{
    "api_key": "123456789",
    "plan": "basic",
    "verified": false,
    "active": true
}

Create A User

Programmatically create a user and receive an API key in the response. Email verification is required before user can login or use the API.

This creates a user that is assigned to the requestors account. You must be the administrator of your account to use this method.

A welcome email will be sent to the user with their login credentials.

POST/v1/users

Field	Type	Description
email	STRING	This will be used as the username. An email verification will be sent here.

Request Sample

curl https://api.websitez.com/v1/users
{
    "email": "test@test.com"
}

Response Sample

{
    "email": "test@test.com",
    "api_key": "123456789",
    "verified": false,
    "active": true
}

Field	Type	Description
email	STRING	The contact email and username for the account.
api_key	STRING	An API key that can use the API with non-administrative permissions.
verified	BOOLEAN	Determines if the user has validated their email.
active	BOOLEAN	Determines if the user is active and can make use of their account.

Update A User

Programmatically update a user.

PUT/v1/users/1

Field	Type	Description
first_name	STRING	The first name of the user.
last_name	STRING	The last name of the user.
active	BOOLEAN	If the user is active in the system. Must be an administrator to edit this value.

Request Sample

curl --request PUT https://api.websitez.com/v1/users/1
{
    "first_name": "Joe",
    "last_name": "Smith",
    "active": true
}

Response Sample

{
    "first_name": "Joe",
    "last_name": "Smith",
    "email": "test@test.com",
    "api_key": "123456789",
    "verified": false,
    "active": true
}

Field	Type	Description
first_name	STRING	The first name for the account.
last_name	STRING	The last name for the account.
email	STRING	The contact email and username for the account.
api_key	STRING	An API key that can use the API with non-administrative permissions.
verified	BOOLEAN	Determines if the user has validated their email.
active	BOOLEAN	Determines if the user is active and can make use of their account.

View Users

View the users assigned to the requestors account. You must be an administrator to use this method.

GET/v1/users

Field	Type	Description
email	STRING	This will be used as the username. An email verification will be sent here.

Request Sample

curl https://api.websitez.com/v1/users

Response Sample

{"users": [{
    "email": "test@test.com",
    "api_key": "123456789",
    "verified": false,
    "active": true,
    "is_admin": true
}], "next_page": null}

Field	Type	Description
email	STRING	The contact email and username for the account.
api_key	STRING	An API key that can use the API with non-administrative permissions.
verified	BOOLEAN	Determines if the user has validated their email.
active	BOOLEAN	Determines if the user is active and can make use of their account.
is_admin	BOOLEAN	Determines if the user has administrative permissions.

Sites

Manage the websites that record visits for your account.

Create A Site

This endpoint allows one to create a website that can then record visits or personalize the website.

POST/v1/sites

Request Parameters

Field	Type	Description
name	STRING	The name of the website for reference.
website	STRING	A valid link to your website. This valid link will be used to validate that the JavaScript code has been placed on the website.

Request Sample

curl https://api.websitez.com/v1/companies/sites/1045 {
    "name": "Furry Beast",
    "website": "https://websitez.com"
}

Response Sample

{
    "name": "Furry Beast",
    "domain": "websitez.com",
    "website": "https://websitez.com",
    "hash": "iowfeiio2930092nvowvmnoeiijoOJIFwoie290320fjIOPDFwkjfiowejqfJFOI",
    "validated": false,
    "record_visits_pixel": "FWJEOIJFWOEIJFOWIJEFOIWEJFCNOIEWOIFJWOIJFIOEJWOEJIDWOEIFJODJLVKXNXCVNNEOWEIFJODKNLVSKDNJFLIWJEFIHEFIUHWEOGINDOKNVOIDNLZKNVZKNVFSIEVNWEIOW",
    "real_time_detect": "FNEIOWHEJOFIHODKNFOIWEJFOWIENFOKNDVLKSNDOEHFOWIEHRJKNFDKJSFHSKJDGHIWEUHRWOIEHFDKLSHGKGHEWIOUHRWEOIHJDLKFNLSDHFOIWHGOWIHEOIGJLKCNVOIVNWOIGHWEOIGH"
}

Response Parameters

Field	Type	Description
name	STRING	The reference name for the website.
domain	STRING	The domain extracted from the given website.
website	STRING	A valid URL to the website.
hash	STRING	A hash calculated based on the website for reference.
validated	BOOLEAN	Determines whether the JavaScript pixel was correctly found on the website.
record_visits_pixel	STRING	A base64 encoded string that when decoded, gives the JavaScript code to place on a website for recording visits.
real_time_detect	STRING	A base64 encoded string that when decoded, gives the JavaScript code to place on a website for personalizing a website.

View Sites

This endpoint retrieves a list of websites.

GET/v1/sites

Request Sample

curl https://api.websitez.com/v1/sites

Response Sample

{"sites": [{
    "name": "Furry Beast",
    "domain": "websitez.com",
    "website": "https://websitez.com",
    "hash": "iowfeiio2930092nvowvmnoeiijoOJIFwoie290320fjIOPDFwkjfiowejqfJFOI",
    "validated": true
}], "next_page": null}

Response Parameters

Field	Type	Description
name	STRING	The reference name for the website.
domain	STRING	The domain extracted from the given website.
website	STRING	A valid URL to the website.
hash	STRING	A hash calculated based on the website for reference.
validated	BOOLEAN	Determines whether the JavaScript pixel was correctly found on the website.

View A Site

This endpoint retrieves details about a specific website.

GET/v1/sites/[site_id]

Request Parameters

Field	Type	Description
site_id	STRING	The id of the site that can be found in the `/v1/sites` endpoint.

Request Sample

curl https://api.websitez.com/v1/sites/1

Response Sample

{
    "name": "Furry Beast",
    "domain": "websitez.com",
    "website": "https://websitez.com",
    "hash": "iowfeiio2930092nvowvmnoeiijoOJIFwoie290320fjIOPDFwkjfiowejqfJFOI",
    "validated": true,
    "record_visits_pixel": "FWJEOIJFWOEIJFOWIJEFOIWEJFCNOIEWOIFJWOIJFIOEJWOEJIDWOEIFJODJLVKXNXCVNNEOWEIFJODKNLVSKDNJFLIWJEFIHEFIUHWEOGINDOKNVOIDNLZKNVZKNVFSIEVNWEIOW",
    "real_time_detect": "FNEIOWHEJOFIHODKNFOIWEJFOWIENFOKNDVLKSNDOEHFOWIEHRJKNFDKJSFHSKJDGHIWEUHRWOIEHFDKLSHGKGHEWIOUHRWEOIHJDLKFNLSDHFOIWHGOWIHEOIGJLKCNVOIVNWOIGHWEOIGH"
}

Response Parameters

Field	Type	Description
name	STRING	The reference name for the website.
domain	STRING	The domain extracted from the given website.
website	STRING	A valid URL to the website.
hash	STRING	A hash calculated based on the website for reference.
validated	BOOLEAN	Determines whether the JavaScript pixel was correctly found on the website.
record_visits_pixel	STRING	A base64 encoded string that when decoded, gives the JavaScript code to place on a website for recording visits.
real_time_detect	STRING	A base64 encoded string that when decoded, gives the JavaScript code to place on a website for personalizing a website.

Companies

Retrieve the leads for your desired website.

View Companies

This endpoint allows one to retrieve company leads for a specific website.

GET/v1/companies/sites/[site_hash]

Request Parameters

Field	Type	Description
site_hash	STRING	The Site hash of the website that can be found in the `/v1/sites` endpoint.

Request Sample

curl https://api.websitez.com/v1/companies/sites/vnie90320soiwdijfkwiozkl29no2390dknowefw9209knfsoicwoidjwoeiOIJEOFIENfmim23

Response Sample

{"companies": [{
    "company_hash": "ieov9320nNVOWMIEIfjoi2390vjidiojWFJimkcmxnvwoi32920394",
    "company_name": "Google, LLC",
    "company_domain": "google.com",
    "last_visit": "3 hours ago",
    "activity": 8,
    "visits": 7,
    "unique_visits": 4,
    "sources": ["G", "D"]
}], "next_page": null}

Response Parameters

Field	Type	Description
company_hash	STRING	The hash id of the company.
company_name	STRING	The name of the company that the visitor works for.
company_domain	STRING	The top level domain for the company.
last_visit	STRING	The time delta from when the API request was made to when the last visit occurred.
activity	INTEGER	A number between 0-100 that represents the relative visitor activity compared to other company visits. Higher is better.
visits	INTEGER	A total count of visitors to the website from this company over the past 90 days.
unique_visits	INTEGER	A total count of unique visitors to the website from this company over the past 90 days.
sources	ARRAY OF STRINGS	G = google, D = direct, GA = google ads, GP = google ppc

View A Company

This endpoint retrieves details about a specific company.

GET/v1/companies/[company_hash]

Request Parameters

Field	Type	Description
company_hash	STRING	The hash of the company that can be found in the `/v1/companies/sites/[site_id]` endpoint.

Request Sample

curl https://api.websitez.com/v1/companies/ieov9320nNVOWMIEIfjoi2390vjidiojWFJimkcmxnvwoi32920394

Response Sample

{
    "company_name": "Google, LLC",
    "company_domain": "google.com",
    "page_title": "Home Page Title",
    "page_description": "Website meta description.",
    "categories": ["Business & Industrial"],
    "number_of_employees": "1,298,000",
    "company_revenue": "$386 Billion",
    "employees": [
        {"name": "Joe Smith", "title": "CEO"}
    ],
    "visits": 7,
    "unique_visits": 4,
    "linkedin_profile": "https://linkedin.com/company/google",
    "facebook_profile": "https://www.facebook.com/Google/",
    "twitter_profile": "https://twitter.com/google"
}

Response Parameters

Field	Type	Description
company_name	STRING	The name of the company that the visitor works for.
company_domain	STRING	The top level domain for the company.
page_title	STRING	The title of the home page for the company domain.
page_description	INTEGER	The meta description of the home page for the company domain.
categories	ARRAY of STRINGS	A list of categories that the business fits in. See categories/industries for a complete list.
number_of_employees	STRING	The approximate number of employees working at the company.
company_revenue	STRING	The approximate yearly revenue for the company.
employees	ARRAY OF ARRAYS	Each element contains a `name` and `title` attribute for employees found working at the company.
visits	INTEGER	A total count of visitors to the website from this company over the past 90 days.
unique_visits	INTEGER	A total count of unique visitors to the website from this company over the past 90 days.
linkedin_profile	STRING	The profile URL of the company on LinkedIn.com.
facebook_profile	STRING	The profile URL of the company on Facebook.com.
twitter_profile	STRING	The profile URL of the company on Twitter.com.

Reports

Manage the reports that can be sent programmatically.

Create A Report

This endpoint allows one to create a report that will summarize activity for a website.

POST/v1/reports

Request Parameters

Field	Type	Description
site_id	INTEGER	The id of the site that information for the report will be populated with.
name	STRING	A name for the report. Useful for reference.
description	STRING	A description for the report. Useful for reference.
recipients	STRING	A comma separated list of emails to receive the report. If the type choosen is `assigned`, only one recipient is allowed.
slack_webhook	STRING	A website url provided by slack for an incoming webhook.
frequency	STRING	The rate at which the report is generated. Acceptable values are `monthly`, `weekly`, and `daily`.
type	STRING	The type of report to send. One sends all leads, the other sends only those assigned to the recipient. Acceptable values are `leads` and `assigned`.
timezone	STRING	The timezone that the report will be received in. This helps deliver the report at 9am for the recipient. Available timezones are listed here.

Request Sample

curl https://api.websitez.com/v1/reports {
    "site_id": 1,
    "name": "Test Report",
    "description": "This is a test description.",
    "recipients": "test@test.com, joe@joe.com",
    "slack_webhook": "https://hooks.slack.com/ifFIOWnvnidk2390/nVNioeiowfji2390349fmiojwe",
    "frequency": "monthly",
    "type": "leads",
    "timezone": "America/Los_Angeles"
}

Response Sample

{
    "user_id": 1,
    "site_id": 1,
    "name": "Test Report",
    "description": "This is a test description.",
    "recipients": "test@test.com, joe@joe.com",
    "slack_webhook": "https://hooks.slack.com/ifFIOWnvnidk2390/nVNioeiowfji2390349fmiojwe",
    "frequency": "monthly",
    "type": "leads",
    "timezone": "America/Los_Angeles",
    "active": true,
    "timestamp": "2003-04-12 04:05:06"
}

Response Parameters

Field	Type	Description
user_id	INTEGER	The id of the user that created the report.
site_id	INTEGER	The id of the site that information for the report will be populated with.
name	STRING	A name for the report. Useful for reference.
description	STRING	A description for the report. Useful for reference.
recipients	STRING	A comma separated list of emails to receive the report. If the type choosen is `assigned`, only one recipient is allowed.
slack_webhook	STRING	A website url provided by slack for an incoming webhook.
frequency	STRING	The rate at which the report is generated. Acceptable values are `monthly`, `weekly`, and `daily`.
type	STRING	The type of report to send. One sends all leads, the other sends only those assigned to the recipient. Acceptable values are `leads` and `assigned`.
timezone	STRING	The timezone that the report will be received in. This helps deliver the report at 9am for the recipient. Available timezones are listed here.
active	BOOLEAN	Whether the report is enabled or disabled.
timestamp	DATETIME	A timestamp of when the report was created.

View Reports

This endpoint retrieves a list of reports.

GET/v1/reports

Request Sample

curl https://api.websitez.com/v1/reports

Response Sample

{"reports": [{
    "user_id": 1,
    "site_id": 1,
    "name": "Test Report",
    "description": "This is a test description.",
    "recipients": "test@test.com, joe@joe.com",
    "slack_webhook": "https://hooks.slack.com/ifFIOWnvnidk2390/nVNioeiowfji2390349fmiojwe",
    "frequency": "monthly",
    "type": "leads",
    "timezone": "America/Los_Angeles",
    "active": true,
    "timestamp": "2003-04-12 04:05:06"
}], "next_page": null}

Response Parameters

Field	Type	Description
user_id	INTEGER	The id of the user that created the report.
site_id	INTEGER	The id of the site that information for the report will be populated with.
name	STRING	A name for the report. Useful for reference.
description	STRING	A description for the report. Useful for reference.
recipients	STRING	A comma separated list of emails to receive the report. If the type choosen is `assigned`, only one recipient is allowed.
slack_webhook	STRING	A website url provided by slack for an incoming webhook.
frequency	STRING	The rate at which the report is generated. Acceptable values are `monthly`, `weekly`, and `daily`.
type	STRING	The type of report to send. One sends all leads, the other sends only those assigned to the recipient. Acceptable values are `leads` and `assigned`.
timezone	STRING	The timezone that the report will be received in. This helps deliver the report at 9am for the recipient. Available timezones are listed here.
active	BOOLEAN	Whether the report is enabled or disabled.
timestamp	DATETIME	A timestamp of when the report was created.

View A Report

This endpoint retrieves details about a specific report.

GET/v1/reports/[report_id]

Request Parameters

Field	Type	Description
report_id	INTEGER	The id of the report that can be found in the `/v1/reports` endpoint.

Request Sample

curl https://api.websitez.com/v1/reports/1

Response Sample

{
    "user_id": 1,
    "site_id": 1,
    "name": "Test Report",
    "description": "This is a test description.",
    "recipients": "test@test.com, joe@joe.com",
    "slack_webhook": "https://hooks.slack.com/ifFIOWnvnidk2390/nVNioeiowfji2390349fmiojwe",
    "frequency": "monthly",
    "type": "leads",
    "timezone": "America/Los_Angeles",
    "active": true,
    "timestamp": "2003-04-12 04:05:06"
}

Response Parameters

Field	Type	Description
user_id	INTEGER	The id of the user that created the report.
site_id	INTEGER	The id of the site that information for the report will be populated with.
name	STRING	A name for the report. Useful for reference.
description	STRING	A description for the report. Useful for reference.
recipients	STRING	A comma separated list of emails to receive the report. If the type choosen is `assigned`, only one recipient is allowed.
slack_webhook	STRING	A website url provided by slack for an incoming webhook.
frequency	STRING	The rate at which the report is generated. Acceptable values are `monthly`, `weekly`, and `daily`.
type	STRING	The type of report to send. One sends all leads, the other sends only those assigned to the recipient. Acceptable values are `leads` and `assigned`.
timezone	STRING	The timezone that the report will be received in. This helps deliver the report at 9am for the recipient. Available timezones are listed here.
active	BOOLEAN	Whether the report is enabled or disabled.
timestamp	DATETIME	A timestamp of when the report was created.

Websitez.com WordPress Plugin

Easily integrate Websitez.com into your WordPress website with our plugin.

Introduction

Our WordPress plugin makes it incredibly easy to integrate Websitez.com into your website.

Additionally, see the most recent leads right from your WordPress dashboard.

Download

Search "Websitez.com" to find the plugin in the WordPress directory or click the download button below.

Download Plugin

Configuration

When installing from the WordPress plugin repository, the plugin attempts to register an account and setup the website automagically.

If you already have a Websitez.com account, you'll have to manually set this up in the settings page.

You'll have to do two things, the first is get your API key, which is found in your profile settings.

The next is to navigate to the Sites section and find the website this is installed on. If it doesn't exist, create it. Then copy the Site Hash value for the WordPress plugin settings.

That is it!

Zapier

Our Zapier integration allows you to use Zapier to integrate with dozens of other services like SalesForce, HubSpot, Pipedrive, and more!

Please contact us to get access to the Zap!

Categories/Industries

Here is a list of our categories/industries for use in our API.

Timezones

Here is a list of our timezones for use in our API.

[
    "Etc/GMT+12",
    "Pacific/Midway",
    "Pacific/Honolulu",
    "US/Alaska",
    "America/Los_Angeles",
    "America/Tijuana",
    "US/Arizona",
    "America/Chihuahua",
    "US/Mountain",
    "America/Managua",
    "US/Central",
    "America/Mexico_City",
    "Canada/Saskatchewan",
    "America/Bogota",
    "US/Eastern",
    "US/East-Indiana",
    "Canada/Atlantic",
    "America/Caracas",
    "America/Manaus",
    "America/Santiago",
    "Canada/Newfoundland",
    "America/Sao_Paulo",
    "America/Argentina/Buenos_Aires",
    "America/Godthab",
    "America/Montevideo",
    "America/Noronha",
    "Atlantic/Cape_Verde",
    "Atlantic/Azores",
    "Africa/Casablanca",
    "Etc/Greenwich",
    "Europe/Amsterdam",
    "Europe/Belgrade",
    "Europe/Brussels",
    "Europe/Sarajevo",
    "Africa/Lagos",
    "Asia/Amman",
    "Europe/Athens",
    "Asia/Beirut",
    "Africa/Cairo",
    "Africa/Harare",
    "Europe/Helsinki",
    "Asia/Jerusalem",
    "Europe/Minsk",
    "Africa/Windhoek",
    "Asia/Kuwait",
    "Europe/Moscow",
    "Africa/Nairobi",
    "Asia/Tbilisi",
    "Asia/Tehran",
    "Asia/Muscat",
    "Asia/Baku",
    "Asia/Yerevan",
    "Asia/Kabul",
    "Asia/Yekaterinburg",
    "Asia/Karachi",
    "Asia/Calcutta",
    "Asia/Calcutta",
    "Asia/Katmandu",
    "Asia/Almaty",
    "Asia/Dhaka",
    "Asia/Rangoon",
    "Asia/Bangkok",
    "Asia/Krasnoyarsk",
    "Asia/Hong_Kong",
    "Asia/Kuala_Lumpur",
    "Asia/Irkutsk",
    "Australia/Perth",
    "Asia/Taipei",
    "Asia/Tokyo",
    "Asia/Seoul",
    "Asia/Yakutsk",
    "Australia/Adelaide",
    "Australia/Darwin",
    "Australia/Brisbane",
    "Australia/Canberra",
    "Australia/Hobart",
    "Pacific/Guam",
    "Asia/Vladivostok",
    "Asia/Magadan",
    "Pacific/Auckland",
    "Pacific/Fiji",
    "Pacific/Tongatapu"
]

Record Website Visits

Recording visits requires a JavaScript snippet to be placed on every page you wish to record visits.

The following snippet can be copied and pasted onto your website. Don't forget to replace the TOKEN value with your actual token, which can be retrieved on the /v1/sites/view/[site_id] endpoint or through the website. This same JavaScript snippet with the correct TOKEN value can also be found there.

<script type="text/javascript" async=1>
;
(function(p, l, o, w, i, n, g, s) {
    if (!p[i]) {
        p.GlobalSnowplowNamespace = p.GlobalSnowplowNamespace || [];
        p.GlobalSnowplowNamespace.push(i);
        p[i] = function() {
            (p[i].q = p[i].q || []).push(arguments)
        };
        p[i].q = p[i].q || [];
        g = l.createElement(o);
        s = l.getElementsByTagName(o)[0];
        g.setAttribute('splow-id', n);
        g.async = 1;
        g.src = w;
        s.parentNode.insertBefore(g, s)
    }
}(window, document, "script", "https://gcdn.websitez.com/js/viewer32.js", "splow_ip", "TOKEN"));
</script>

Website Personalization

Determine if the visitor is a company lead, then personalize your website however you wish to WOW your visitor.

It is important that the JavaScript code to listen for events is placed before the JavaScript code that triggers the event.

Listen For Event

<script type="text/javascript" async=1>
window.addEventListener('company.visit', function (e) {
    console.log('Welcome visitor from ' + e.detail.name + ' and domain ' + e.detail.domain)
});
</script>

As an example, if the visitor was from Google, LLC, it would print Welcome visitor from Google, LLC and domain google.com

Trigger Event

The following snippet can be copied and pasted onto your website. Don't forget to replace the TOKEN value with your actual token, which can be retrieved on the /v1/sites/view/[site_id] endpoint or through the website. This same JavaScript snippet with the correct TOKEN value can also be found there.

<script type="text/javascript" async=1>
;
(function(p, l, o, w, i, n, g) {
    n = l.createElement(o);
    g = l.getElementsByTagName(o)[0];
    n.setAttribute('splow-watch-id', i);
    n.async = 1;
    n.src = w;
    g.parentNode.insertBefore(n, g)
}(window, document, "script", "https://gcdn.websitez.com/js/watch54.js", "TOKEN"));
</script>

Bootstrap Example

The following is a full example for a website built with Bootstrap.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Bootstrap</title>
    <script type="text/javascript">
        window.addEventListener('company.visit', function (e) {
            document.getElementById('company_name').innerHTML = e.detail.name;
            var myToastEl = document.getElementById('liveToast')
            var myToast = bootstrap.Toast(toastEl).show()
        });
    </script>
</head>
<body>
    <div class="position-fixed bottom-0 end-0 p-3" style="z-index: 5">
      <div class="toast fade" id="liveToast" role="alert" aria-live="assertive" aria-atomic="true">
        <div class="toast-header bg-primary text-white"><strong class="me-auto">Welcome <span id="company_name"></span>!</strong><button class="btn-close btn-close-white" type="button" data-bs-dismiss="toast" aria-label="Close"></button></div>
        <div class="toast-body">Thank you for visiting. Please <a href="#">click here</a> to open a chat with us.</div>
      </div>
    </div>
    <script type="text/javascript" async=1>
    ;
    (function(p, l, o, w, i, n, g) {
        n = l.createElement(o);
        g = l.getElementsByTagName(o)[0];
        n.setAttribute('splow-watch-id', i);
        n.async = 1;
        n.src = w;
        g.parentNode.insertBefore(n, g)
    }(window, document, "script", "https://gcdn.websitez.com/js/watch54.js", "TOKEN"));
    </script>
</body>
</html>