The Wisepops API provides powerful capabilities for reporting and email/lead export. This documentation will guide you through the API's features, endpoints, and usage.
API overview
The Wisepops API is a web service that allows you to:
Retrieve information about your pop-ups
Access emails collected through opt-in forms
Manage webhooks
Automate data deletion requests for GDPR and CCPA compliance
Authentication
All API requests require authentication using an API key. Include the following header in your HTTP requests:
Authorization: WISEPOPS-API key="YOUR_API_KEY_HERE"
The API key is associated with a specific website. If you have multiple websites configured in Wisepops, you'll need to use the correct key for each website.
API endpoints
Retrieve collected contacts
Retrieve collected contacts with their fields.
Endpoint:
https://app.wisepops.com/api2/contactsMethod:
GET
Do you need to get your new leads as soon as they subscribe? Use our webhooks instead of periodically calling this endpoint. It's more efficient and not subject to API call limits.
Parameters
collected_after: Retrieve emails collected after the specified date (UTC)wisepop_id: Retrieve emails from a specific pop-uppage_size: Number of contacts to return per query (1-1000, default: 100)
Example request
curl -H 'Authorization: WISEPOPS-API key="YOUR_API_KEY_HERE"' 'https://app.wisepops.com/api2/contacts?collected_after=2017-03-01T01:00:00Z&wisepop_id=12345'
Example response
[
{
"collected_at": "2019-10-10T10:10:58.389Z",
"wisepop_id": 12345,
"ip": "127.0.0.1",
"country_code": "US",
"fields": {
"email": "example@example.com",
"Gender": "male",
"City": "New York"
}
},
{
"collected_at": "2019-10-10T10:10:59.010Z",
"wisepop_id": 12345,
"ip": "127.0.0.1",
"country_code": "US",
"fields": {
"email": "other.example@example.com",
"Gender": "female",
"City": "Seattle"
}
}
]
Get Wisepops performance data
Retrieve a list of your Wisepops with display & conversion metrics.
Endpoint:
https://app.wisepops.com/api2/wisepopsMethod:
GET
Example request
curl -H 'Authorization: WISEPOPS-API key="YOUR_API_KEY_HERE"' 'https://app.wisepops.com/api2/wisepops'
Example response
[
{
"id": 10000,
"label": "Optin Wisepop",
"created_at": "2017-02-25 19:10:00",
"activated": false,
"display_count": 0,
"click_count": 0,
"email_count": 0
},
{
"id": 12345,
"label": "Live Wisepop",
"created_at": "2017-02-27 15:29:43",
"activated": true,
"display_count": 100,
"click_count": 20,
"email_count": 20
}
]
Manage webhooks
Manage your webhooks for real-time data updates.
Endpoint:
https://app.wisepops.com/api2/hooksMethod: Various (
GET,POST,DELETE)
See this documentation.
Data privacy: Delete user data
Automatically delete and suppress data about end-users for GDPR and CCPA compliance.
Endpoint:
https://app.wisepops.com/api2/data-privacyMethod:
DELETE
Headers
Content-Type: application/jsonAuthorization: See the authentication section
Request body
{"email": "test@test.com", "phone": "+123456789"}At least email or phone must be provided. If both are provided, all records with either the email or the phone are deleted. The phone must be in international format with a leading + and no whitespace.
Example request
curl -X DELETE -H 'Content-Type: application/json' -H 'Authorization: WISEPOPS-API key="YOUR_API_KEY_HERE"' -d '{"email":"test@test.com"}' 'https://app.wisepops.com/api2/data-privacy'Example response
{"deleted": 1}
Usage Limits
Available in Pro plans and above
Standard usage: 1,500 API calls within 30 days
For increased limits, contact our Customer Success team
Integrations
To connect Wisepops to a third-party tool:
Ensure the third-party solution offers an API that accepts data input.
Develop a connector to move the emails and leads to the other solution.
For non-developers, use our Zapier integration to send emails to a wide range of third-party applications.
Support
For assistance or questions about the Wisepops API, please contact our support team.