API Documentation
The Hey Oliver API is organized around REST. Our API returns JSON-encoded responses, and uses standard HTTP response codes and authentication.
Obtain your API key
You can find your API key on Settings > Account, after you login within your Hey Oliver account.
API URL
All URLs in the reference documentation use the following base URL: https://www.heyoliver.com/rest/api?ho_key=
Defaults
| duration | The time-duration of the returned leads list | 24 hours |
| types | The returned type of the attributes | string |
Attributes
| Attribute | Description | Example |
|---|---|---|
| id | The ID of your lead. This is the universal identifier of the lead through the Hey Oliver platform. | hU7uQev4 |
| visitor_link | The direct link that connects you directly with the visitors' Hey Oliver profile. | heyoliver.com/profile/hU7uQev4 |
| lead_entry | The campaign or widget where the visitor used in order to share contact details or express interest. | 50% OFF - Black Friday |
| opt_in_time | The exact day and time that the lead was captured. | 2019-11-17T22:09:54+00:00 |
| full_name | The Full Name of the lead. If not given, this returns null. | John Doe |
| country | The visitor's country. Captured at the time of first entrance. | Australia |
| phone | Contains the phone number of the lead. If not given, this returns null. | 990974221 |
| The email address of the lead. If not given, this returns null. | john@doe.com | |
| first_visit | The exact day and time of the first website visit of the specific visitor. | 2019-11-18T00:07:27+00:00 |
How to connect Zapier with Hey Oliver
Zapier allows you to instantly connect Hey Oliver with thousands of popular apps to automate your processes and easily integrate the leads in your company workflow. The official Zapier...