Unbounce API Essential Guide

What type of API does Unbounce provide?

Based on the search results provided, Unbounce does not appear to have a specific API type mentioned. The search results do not contain any information about Unbounce's API. Therefore, I cannot definitively state what type of API Unbounce uses.

However, I can provide some general information about common API types:

Common API Types

1. REST (Representational State Transfer)

   • Currently the most popular and widely used API architecture
   • Uses standard HTTP methods (GET, POST, PUT, DELETE, etc.)
   • Stateless and resource-based
   • Good for web and mobile applications, microservices, and IoT systems

2. GraphQL

   • Developed by Facebook in 2012, released publicly in 2015
   • Allows clients to request specific data they need
   • Uses a single endpoint
   • Good for complex data structures and reducing over-fetching of data

3. SOAP (Simple Object Access Protocol)

   • XML-based messaging protocol
   • More rigid and standardized than REST
   • Can use different transport protocols (HTTP, SMTP, etc.)
   • Still used in some enterprise and legacy systems

4. gRPC

   • Developed by Google
   • Uses Protocol Buffers for serialization
   • High-performance and efficient for microservices

Key Points to Consider

• The choice of API type depends on specific use cases, performance requirements, and the nature of the data being transferred.
• REST APIs are still very common and widely supported.
• GraphQL has been gaining popularity, especially for applications with complex data requirements.
• Some companies maintain multiple API types to cater to different needs.

To determine what type of API Unbounce uses, you would need to check their official documentation or contact their support team directly.

Does the Unbounce API have webhooks?

Webhook Support

Yes, the official Unbounce API does support webhooks.

Event Types

The main event type you can subscribe to via webhooks is form submissions. Specifically:

• You can use webhooks to receive notifications when a form is submitted on an Unbounce landing page.
• The webhook will send lead data to a third-party server after a form is submitted.

Webhook Setup

To set up a webhook in Unbounce:

1. Log in to your Unbounce account
2. Select the landing page you want to configure the webhook for
3. In the webhook configuration, provide the URL of your server endpoint that will receive the webhook data
4. You can optionally configure field mapping to specify which form fields to include in the webhook payload

Key Considerations

• Webhooks are recommended over the "Post form data to URL" option, as webhook requests and responses are logged for easier troubleshooting.
• The webhook payload will include the form submission data.
• You cannot add server-side scripts to Unbounce pages, only frontend JavaScript and HTML.
• The webhook URL should follow this format: http://<your-server>/com.unbounce/v1

Best Practices

• Use webhooks for real-time notifications of form submissions
• Implement proper error handling and retry logic on your server to process webhook payloads reliably
• Secure your webhook endpoint to validate that requests are coming from Unbounce

In summary, while Unbounce's webhook support is somewhat limited compared to some other platforms, it does provide a useful way to get real-time notifications of form submissions, which is likely the most important event for most use cases.

Rate Limits and other limitations

Here are the key points about the API rate limits for the Unbounce API:

Rate Limit Details

• The Unbounce API has a rate limit of 500 requests per minute per user account and IP address.

• If you exceed this rate limit, you will receive a status code 429 (Too Many Requests) response.

Key Considerations

• The rate limit applies to both API key and OAuth token authentication methods.

• The limit is per user account and IP address, so requests from different IP addresses for the same account will count towards the same limit.

• There is no daily or monthly limit mentioned, only the per-minute limit.

Best Practices

• Monitor your API usage and implement backoff/retry logic if you hit rate limits.

• Spread out requests over time if possible to avoid hitting the limit.

• Consider caching responses where appropriate to reduce API calls.

• Contact Unbounce support if you need higher rate limits for your use case.

Summary

The Unbounce API has a relatively generous rate limit of 500 requests per minute. This should be sufficient for most use cases, but applications making very high volumes of requests may need to implement rate limiting on their end or request higher limits from Unbounce. The per-minute limit allows for bursts of activity while still protecting their API infrastructure.

Latest API Version

Based on the search results provided, here is the most up-to-date information about the Unbounce API version:

Current Version

The most recent version of the Unbounce API is v0.4. This is considered the latest version and is currently supported.

Key Points

• Version 0.3 of the API was retired in May 2018 and is no longer accessible.
• Users who were previously using v0.3 need to update their code to access the current v0.4 version.
• When making API requests, you can optionally specify the API version in the request header.

API Access

To use the Unbounce API:

1. Request API access through the API Request form using your Unbounce account email.
2. Once approved, you can create one or more API keys within the app.
3. Use your API key as the username for authentication, leaving the password blank.

Best Practices

• Always use HTTPS for API requests to ensure encryption.
• Include the API version in your request headers for clarity:

curl -u API_KEY: -H "Accept: application/vnd.unbounce.api.v0.4+json" -X GET https://api.unbounce.com

• Be aware of rate limiting and handle potential errors appropriately.

It's important to note that Unbounce is continuously working on improving their API. They mention that they have been working on releasing a new version of the API, referred to as the "Unbounce API (Beta)". However, the specific version number for this beta release is not provided in the search results.

How to get a Unbounce developer account and API Keys?

To get a developer account for Unbounce and create an API integration, you need to follow these steps:

1. Request API Access:

   • Use the email address associated with your Unbounce account to request API access.
   • Submit your request through the API Request form.

2. Wait for Confirmation:

   • The Unbounce Customer Support team will review your request and confirm your access within a couple of days.

3. Create API Keys:

   • Once you have access, you can create one or more API Keys within the Unbounce app.

Key Points to Consider:

• API keys act like Unbounce account administrators, allowing the client application to view every resource that an account administrator can access.
• There are two ways to authorize your application:
  1. OAuth 2.0 tokens: Used for accessing individual user's private data.
  2. API keys: Used for accessing data for a single account.
• All connections require encryption via SSL, so make sure to use the HTTPS protocol in your requests.

Best Practices:

1. Keep your API keys secure and do not share them publicly.
2. Use OAuth 2.0 for applications that require access to multiple user accounts.
3. Implement proper error handling based on the HTTP response codes provided by Unbounce.
4. Be aware of and respect the rate limiting implemented by Unbounce to avoid exceeding request limits.
5. Stay updated with the latest API version. As of now, v0.4 is the current version.

If you need technical support or have questions about the API, you can email [email protected]. Additionally, if you're interested in becoming an Unbounce Partner, you can reach out to [email protected] once your product is ready.

Remember that API access may be limited to certain Unbounce subscription plans. For subscriptions purchased before June 2020, access is limited to Essential, Premium, and Enterprise plans.

What can you do with the Unbounce API?

Based on the search results provided, here is a list of data models you can interact with using the Unbounce API, along with what is possible for each:

Users

• Get information about the authenticated user

Pages

• Retrieve a list of all pages (including landing pages, AMP pages, pop-ups, and sticky bars)
• Get information about a single page
• Fetch form submissions/leads for a specific page

Leads

• Get information about a single lead
• List all leads for a given page, pop-up, or sticky bar
• Submit new leads via POST (Note: Emojis are now stripped from lead submissions)

Accounts

• Retrieve account information

Sub-accounts

• Access sub-account data

Page Groups

• Retrieve page groups within a specified date range

Forms

• Receive notifications for new form submissions

Key points to consider:

• The API uses OAuth authentication for secure access
• API keys act like account administrators, allowing access to all resources an admin can view
• The API supports conventional HTTP response codes to indicate success or failure of requests
• All connections require encryption via SSL (HTTPS)

Best practices:

• Use the provided API Console to test and explore the API functionality
• Be aware of rate limiting to avoid exceeding request limits
• Handle errors appropriately based on the HTTP response codes
• Keep your API keys secure and do not share them publicly

It's important to note that the Unbounce API is still in beta, and new features or changes may be introduced over time. Always refer to the most up-to-date documentation for the latest information on available data models and endpoints.