Pearl Diver REST API

Pearl Diver REST API - FAQ

What is an API?

An API, or Application Programming Interface, is like a middleman between different software programs, helping them communicate with each other. It takes requests from one program, tells another program what to do, and brings back the results. Think of it like a waiter who takes your order, brings it to the kitchen, and then returns with your food. This allows programs to use functionalities of other programs without needing to know how everything works behind the scenes.

What does the Pearl Diver API do?

The Pearl Diver API empowers you to seamlessly interact with your Pearl Diver data across any platform of your choosing. By using the Pearl Diver API, you can connect your Pearl Diver with other systems to enrich your existing data sets and automate numerous routine tasks performed with your Pearl Diver identified data.
The Pearl Diver API adheres to REST principles, ensuring that all responses, including error messages, are returned in JSON format.

This API enables you to access insights into your website visitors in the form of customizable audience data, directly from the Pearl Diver application.

How can I use the API?

The versatility of the Pearl Diver API enables connection with virtually any system. If your CRM, website, or other business platforms support API input, you can seamlessly integrate your Pearl Diver data across your entire infrastructure. Configuration of the API will require a web developer or development agent with experience creating API calls.

Consider leveraging our API to:
  1. Streamline your sales team's workflows and enrich your CRM with detailed website visit data.
  2. Incorporate your identified website visitor information into your marketing campaigns.
  3. Enhance your reporting capabilities with custom reporting suites tailored to your specific needs.

How do I get access?

To begin utilizing the API, you must enable it from your Pearl Diver App dashboard. Once enabled, you'll receive the necessary credentials to establish a connection.
To login to your Pearl Diver App, visit https://pearldiver.blackpearl.com/dashboard and login using your authorized Microsoft of Google hosted email
If you are unable to login to Pearl Diver, please confirm you have been granted access to the application by our customer success team or review our troubleshooting guide here. You can contact us at support@pearldiver.io. Please include your account/business name and ensure you have been authorized by an existing Pearl Diver admin

Acceptable Use Policy

Usage of the API and the Pearl Diver application is subject to the Terms of Service Policy for the API service and the terms outlined in your Pearl Diver contract. Please review the policy before initiating API usage.

Rate Limiting

To maintain system stability, the Pearl Diver API enforces rate limits, allowing a maximum of 250 requests per IP address within a 60-second renewal period.

How fast is the response time for the API?

Pearl Diver API responses typically exhibit an average response time ranging from 0.1 to one second.

I want to integrate with a solution using the Pearl Diver API. Can the Pearl Diver team assist with this?

While the Pearl Diver support team can provide guidance based on technical documentation and relay any inquiries or concerns to the technical team, direct technical integration support is not available on all standard Pearl Diver subscriptions. API configuration, setup and ongoing management will be the responsibility of the end user, however our support team are able to provide basic direction and escalation to our technical team where guidance is requested. Configuration of the API will require you to directly engage a web developer or development agent with experience creating API calls.

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

Yes, the Pearl Diver API utilizes OAuth2.0 Authorization Code authentication. Initial authorization necessitates user interaction, but subsequent token usage in server-side implementations requires no further interaction. Client-side implementations can be facilitated for users within your company's Pearl Diver account.

What to know  more about Pearl Diver in general? Check out our FAQs today!
    • Related Articles

    • Pearl Diver REST API - Getting started

      About This is the reference for the Blackpearl Group Pearl Diver REST API. This API is the primary way to get Pearl Diver data outside of the web application. Use it to integrate your Pearl Diver data with CRMs, marketing automation tools, analytics ...
    • Pearl Diver for our Partners - FAQ

      Thank you for choosing to partner with us! As part of our commitment to delivering exceptional support tailored to our partners, we'd like to introduce this specialized FAQ document. While our standard Pearl Diver FAQ addresses general queries, this ...
    • Why you need an Ideal Customer Profile (ICP) and how to get it with Pearl Diver

      Building an Ideal Customer Profile is an integral part of any successful sales strategy, but it’s also a great way to bring focus to your marketing efforts and understand who your best customers are. What is an Ideal Customer Profile (ICP) ICP, or ...
    • Understanding your Pearl Diver data

      Understanding your data Recent statistics reveal a stark reality: between 50-75% of site visits are bots. Consequently, the actual number of identified visitors amounts to only 20-25% of your Google Analytics report. *Google Analytics filters known ...
    • Pearl Diver - FAQ

      Is Pearl Diver a good fit for me? Pearl Diver is for businesses serving Business to Business (B2B) or Business to Customer (B2C) markets. It’s best suited for small-to-medium-sized businesses. Pearl Diver is most effective for businesses with a US ...