APIs are interfaces that allow two systems to automatically exchange information – similar to a waiter in a restaurant: you place an order (Request) and receive the desired information or action back (Response).
Technically, this means your browser or tool sends a request to the server, and the server delivers the appropriate data or performs the requested action (Response).
There are several HTTP methods used to communicate with APIs. Here are some of the most common ones:
GET – Retrieve data from a system. Example: You fetch a specific contact from the CRM.
POST – Add new data to a system. Example: You create a new contact in a campaign.
PUT – Update existing data. Example: You change the status of a lead (e.g., from new to qualified).
With the API App, you can export contacts, add new ones, or update existing entries – all automatically.
ℹ️ The API app connection feature is available from the Volume Plan (Legacy) / Scale Plan onwards.
Typical Use Cases
The API unlocks many ways to streamline your processes. Here are some examples:
🚀 Lead forwarding: Transfer leads directly from your funnel into your CRM or ATS (Applicant Tracking System) without manual copy pasting or exports.
🔄 Data syncing on demand: Retrieve or update your contact data whenever you need to — for example, to pull the latest campaign leads into your reporting tool or CRM with a simple request.
📊 Data analysis & reporting: Export contacts or historical data to use them in your own dashboards or BI tools.
🛠️ Custom integrations: Build your own connections to tools that don’t yet have a native Perspective integration.
✉️ API-driven messaging: By changing a lead’s status via a PUT request (e.g., from new to qualified), you can directly trigger messaging workflows in your external system. This way, you can automatically send follow-up emails or WhatsApp messages to leads – fully controlled via the API.
How to create your API Key
Go to your Account Settings (top right, click on the 🛠️ icon).
Scroll down to API Key.
Click on Create API Key.
Assign a name, choose the appropriate Data permissions, and select the desired Workspace access.
Important❗️: The API key will only be shown once. Copy it now and save it securely. After that, it will no longer be visible.
Example API key:
2b5390b22dc5c9b11769aee3a803cf3217a3bc1f595dd396b30a330b902t699c
Include your Perspective API key in the header of every request:
x-perspective-api-key: <your_api_key>
💡 Note: Only Perspective account admins can create API keys.
API Documentation & Authentication
You can find the technical documentation here: Perspective API Docs. There you can also test the API directly.
Click on the green Authorize button on the right.
Enter your API key.
Click on Authorize – and you’re connected.
Available CRM Endpoints
You can use the API to perform these actions in the CRM (Customer Relationship Management):
PUT – Update an existing contact (fields that can be updated:
firstName,lastName,email,phone,status).GET – Retrieve a single lead or contact by ID.
POST – Create a new contact in a campaign (email or phone required). Currently, created contacts can only include the following fields:
firstName,lastName,email, andphone.GET – Retrieve a list of contacts for a campaign (including pagination & sorting).
Available Metrics Endpoints
In addition to CRM data, the API also provides access to funnel performance metrics.
You can retrieve different types of analytics through these endpoints:
GET – KPI Metrics: Retrieve key performance indicators for your funnel, such as conversion rates or total submissions.
GET – Charts Metrics: Retrieve data visualizations (charts) for funnel performance, helping you analyze trends and identify optimization potential.
GET – Insights Metrics: Retrieve detailed insights based on user interactions, such as what visitors selected or answered within specific funnel blocks.
These endpoints allow you to fetch funnel performance data, visualize conversion rates, and analyze visitor behavior.
To connect to metrics endpoints, you’ll need the following identifiers:
Funnel ID: Required for KPI and Chart and Insight metrics. You can find it in the URL when you open your funnel in the editor.
Insight ID: Required only for Insights metrics. This is the Tracking ID of the block you want to analyze.
To find it, open your funnel in the editor, click on the block you want insights for, and check the Tracking ID field in the left sidebar.
Filtering & Time Range
You can filter metric results for a specific time period — for example, to view data from the last two weeks only.
Timezone Offset
Each request can optionally include a timezone offset (in minutes). This determines how the timestamps in the data are adjusted to your local timezone. If no value is set, the default is 0.
A/B Testing
A/B testing data is available only for page-to-page conversions.
For the subtype chart_page_to_page_conversion_rate, there is an A/B test filter option that lets you retrieve data for a specific test variant.