Table of Contents
Discover Insider, the world's first integrated Growth Management Platform, fueling growth across the sales funnel for digital marketers across the globe.
API Overview
Insider is a cloud-based customer engagement platform that empowers businesses to personalize and optimize their marketing campaigns across multiple channels. It offers a suite of tools for segmentation, targeting, personalization, and analytics, enabling marketers to deliver highly relevant and engaging experiences to their customers. Insider's intuitive drag-and-drop interface and pre-built templates make it easy for users to create and automate personalized campaigns, even without prior technical expertise. With advanced features such as predictive analytics, A/B testing, and real-time optimization, Insider helps businesses drive conversions, increase customer engagement, and maximize ROI.
Insider API provides a comprehensive set of REST APIs, webhooks, and documentation to enable developers to integrate Insider's functionality into their applications and systems. The API documentation provides detailed information on all available endpoints, request and response formats, and code samples in various programming languages. The REST APIs allow developers to programmatically access Insider's features, such as creating segments, sending campaigns, and retrieving analytics data. Webhooks enable real-time notifications for specific events, such as campaign performance updates or user behavior triggers. Insider also imposes rate limits to ensure the stability and performance of its API services. By leveraging the Insider API, developers can extend the capabilities of their applications, automate workflows, and seamlessly integrate Insider's personalization and engagement capabilities into their own systems.
API Request Limits
Free
1000 requests/day
Growth
10,000 requests/day
Business
100,000 requests/day
Enterprise
Custom rate limits
SDKs
APIs
Method: POST
Description: Creates a new data collector configuration..
Endpoint: /api/v2/data-collectors
Parameters: name, dataSourceType, properties
Method: GET
Description: Gets all data collector configurations..
Endpoint: /api/v2/data-collectors
Parameters:
Method: GET
Description: Gets the specified data collector configuration..
Endpoint: /api/v2/data-collectors/{dataCollectorId}
Parameters: dataCollectorId
Method: PUT
Description: Updates the specified data collector configuration..
Endpoint: /api/v2/data-collectors/{dataCollectorId}
Parameters: dataCollectorId, name, dataSourceType, properties
Method: DELETE
Description: Deletes the specified data collector configuration..
Endpoint: /api/v2/data-collectors/{dataCollectorId}
Parameters: dataCollectorId
Method: POST
Description: Creates a new segment..
Endpoint: /api/v2/segments
Parameters: name, code, description, rule, properties
Method: GET
Description: Gets all segments..
Endpoint: /api/v2/segments
Parameters:
Method: GET
Description: Gets the specified segment..
Endpoint: /api/v2/segments/{segmentId}
Parameters: segmentId
Method: PUT
Description: Updates the specified segment..
Endpoint: /api/v2/segments/{segmentId}
Parameters: segmentId, name, code, description, rule, properties
Method: DELETE
Description: Deletes the specified segment..
Endpoint: /api/v2/segments/{segmentId}
Parameters: segmentId
Method: POST
Description: Creates a new campaign..
Endpoint: /api/v2/campaigns
Parameters: name, type, settings, properties
Method: GET
Description: Gets all campaigns..
Endpoint: /api/v2/campaigns
Parameters:
Method: GET
Description: Gets the specified campaign..
Endpoint: /api/v2/campaigns/{campaignId}
Parameters: campaignId
Method: PUT
Description: Updates the specified campaign..
Endpoint: /api/v2/campaigns/{campaignId}
Parameters: campaignId, name, type, settings, properties
Method: DELETE
Description: Deletes the specified campaign..
Endpoint: /api/v2/campaigns/{campaignId}
Parameters: campaignId
Method: POST
Description: Creates a new notification..
Endpoint: /api/v2/notifications
Parameters: name, description, type, template, properties
Method: GET
Description: Gets all notifications..
Endpoint: /api/v2/notifications
Parameters:
Method: GET
Description: Gets the specified notification..
Endpoint: /api/v2/notifications/{notificationId}
Parameters: notificationId
Method: PUT
Description: Updates the specified notification..
Endpoint: /api/v2/notifications/{notificationId}
Parameters: notificationId, name, description, type, template, properties
Method: DELETE
Description: Deletes the specified notification..
Endpoint: /api/v2/notifications/{notificationId}
Parameters: notificationId
FAQ
How do I authenticate to the Insider APIs?
You can authenticate using an API key. You can create an API key in your Insider account settings.
What are the rate limits for the Insider APIs?
The rate limits are 100 requests per minute for the sandbox environment and 1000 requests per minute for the production environment.
How do I create a sandbox account?
You can create a sandbox account by signing up for a free trial at https://useinsider.com.
How do I get a developer account?
You can request a developer account by contacting Insider support at support@useinsider.com.
How do I use the Insider APIs to send a message?
You can use the <code>POST /messages</code> endpoint to send a message. The request body should include the message content and the recipient's email address.