Pearl Diver REST API FAQ

What the Pearl Diver API does, how to get access, and the rate limits, response times, and support you can expect.

What is an API?

An API, or Application Programming Interface, lets different software programs communicate. It takes a request from one program, tells another program what to do, and brings back the result, much like a waiter taking your order to the kitchen and returning with your food. Programs can use each other's functionality without needing to know how everything works behind the scenes.

What does the Pearl Diver API do?

The Pearl Diver API lets you interact with your Pearl Diver data on any platform of your choosing. Connect it to other systems to enrich your existing data and automate routine tasks around your identified data. The API follows REST principles, and every response, including error messages, comes back in JSON. It gives you access to customizable audience data and insights into your website visitors, directly from the Pearl Diver application.

How can I use the API?

The API can connect to virtually any system. If your CRM, website, or other business platform accepts API input, you can bring your Pearl Diver data into your whole infrastructure. Setting it up needs a web developer or development agency with experience building API calls. Consider using it to:

Streamline your sales team's workflows and enrich your CRM with detailed website visit data.
Feed identified website visitor information into your marketing campaigns.
Build custom reporting tailored to your specific needs.

How do I get access?

Enable the API from your Pearl Diver dashboard, and you'll receive the credentials you need to connect. Log in to Pearl Diver at pearldiver.blackpearl.com/dashboard using your authorized Microsoft or Google-hosted email.

Note: Can't log in? Confirm our customer success team has granted you access, and check our troubleshooting guide. If you're still stuck, email [email protected] with your account or business name, and confirm you've been authorized by an existing Pearl Diver admin.

Acceptable use policy

Using the API and the Pearl Diver application is subject to the Terms of Service and the terms in your Pearl Diver contract. Review the policy before you start using the API.

Rate limiting

To keep the system stable, the API allows a maximum of 250 requests per IP address in any 60-second window.

How fast is the API?

Typical response times range from 0.1 to 1 second.

Can Pearl Diver help me integrate with the API?

Support can point you to technical documentation and pass questions to the technical team, but direct integration support isn't included on standard subscriptions. API configuration, setup, and ongoing management are your responsibility, though support can offer basic direction and escalate to the technical team when needed. You'll need to engage a web developer or development agency directly to build the integration.

Do you support client-side and server-side implementations?

Yes. The API uses OAuth 2.0 Authorization Code authentication. Initial authorization needs user interaction, but using the token afterward in a server-side implementation doesn't. Client-side implementations work for users within your company's Pearl Diver account.

Need help? Email us at [email protected]. Please include your account details and a brief description of your issue.

Did this answer your question?