Skip to main content
All CollectionsIntegrationsWisepops API
Wisepops API Documentation
Wisepops API Documentation
Updated over a week ago

Introduction

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:

  1. Retrieve information about your pop-ups

  2. Access emails collected through opt-in forms

  3. Manage webhooks

  4. 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:

CopyAuthorization: WISEPOPS-API key="YOUR_API_KEY_HERE"

Note: 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

1. Retrieve Collected Contacts

  • Endpoint: https://app.wisepops.com/api2/contacts

  • Method: GET

  • Description: Retrieve collected emails with additional fields

Parameters:

  • collected_after: Retrieve emails collected after the specified date (UTC)

  • wisepop_id: Retrieve emails from a specific pop-up

  • page_size: Number of contacts to return per query (1-1000, default: 100)

  • page: Query for a specific set of results (default: 1)

Example Request:

Copycurl -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:

jsonCopy[ { "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" } } ]

2. Get Wisepops Performance Data

  • Endpoint: https://app.wisepops.com/api2/wisepops

  • Method: GET

  • Description: Retrieve a list of your Wisepops with display & conversion metrics

Example Request:

Copycurl -H 'Authorization: WISEPOPS-API key="YOUR_API_KEY_HERE"' 'https://app.wisepops.com/api2/wisepops'

Example Response:

jsonCopy[ { "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 } ]

3. Manage Webhooks

  • Endpoint: https://app.wisepops.com/api2/hooks

  • Method: Various (GET, POST, DELETE)

  • Description: Manage your webhooks for real-time data updates

4. Data Privacy - Delete User Data

  • Endpoint: https://app.wisepops.com/api2/data-privacy

  • Method: DELETE

  • Description: Automatically delete and suppress data about end-users for GDPR and CCPA compliance

Headers:

  • Content-Type: application/json

  • Authorization: WISEPOPS-API key="YOUR_API_KEY_HERE"

Request Body:

jsonCopy{ "email": "test@test.com", "phone": "+123456789" }

Example Request:

Copycurl -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:

jsonCopy{ "deleted": 1 }

Note: 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.

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

Best Practices

  1. Use webhooks instead of periodically polling the /api2/contacts endpoint for new leads. It's more efficient and not subject to API call limits.

  2. When paginating results, use the collected_after parameter with the collected_at value of the last retrieved contact instead of relying on the page parameter.

Integrations

To connect Wisepops to a third-party tool:

  1. Ensure the third-party solution offers an API that accepts data input.

  2. Develop a connector to move the emails and leads to the other solution.

  3. 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.

Did this answer your question?