search

External API

circle-exclamation

Our external API is currently in beta.

Have thoughts on how to make our API better? Email your feature suggestions to [email protected]envelope.

hashtag
What is the External API?

The Intelligems External API provides programmatic access to your Intelligems experiences and analytics data. This RESTful API allows you to integrate Intelligems functionality into your own applications, workflows, and data pipelines.

hashtag
What can you do with the External API?

The External API enables you to:

Retrieve & Analyze Data

  • List all tests and experiences in your account

  • Get detailed configuration for specific tests and experiences, including variations, targeting rules, offer details, and content modifications

  • Pull performance metrics for any test or experience, with results broken down by audience segments (device type, visitor type, traffic source, geography, etc.)

  • Fetch sitewide analytics including revenue per visitor, net revenue, and visitor counts for any date range

Manage Experiences

  • Create new experiences and experiments programmatically

  • Update existing experience configurations, variations, and targeting rules

  • Control experience lifecycles — start, pause, or end experiences via API

Automate Workflows

  • Integrate Intelligems data into your business intelligence tools

  • Build custom dashboards combining Intelligems metrics with other data sources

  • Automate reporting and alerting based on test performance

hashtag
Common Use Cases

  • Custom Reporting: Build internal dashboards that combine Intelligems test results with proprietary business metrics.

  • Automated Monitoring: Create alerts to notify you if there's an issue with a test or give you a daily summary.

  • Automated Reporting: Create automation engines that give you insights during key stages of a test (7 days live, 14 days live, test ended).

circle-info

Checkout our Automations & Guides sectionsarrow-up-right for how-tos of common use cases.

hashtag
Getting Started

To generate your API key, in your Intelligems account, navigate to Integrations > Intelligems External API > Select Enable. A pop-up will appear with your API key. You can also navigate back here at any time to grab that same API key again.

Once you have your API key, you can authenticate requests by including it in the intelligems-access-token header.

hashtag
Available Endpoints

  • GET /v25-10-beta/experiences-list — Retrieve a list of all experiences with optional filtering by category, status, and pagination

  • GET /v25-10-beta/experiences/{experienceId} — Get complete details for a specific experience

  • POST /v25-10-beta/experiences — Create a new experience or experiment

  • PUT /v25-10-beta/experiences/{experienceId} — Update an existing experience's configuration, variations, or targeting

  • POST /v25-10-beta/experiences/{experienceId}/actions/{action} — Perform a lifecycle action on an experience (start, pause, or end)

  • GET /v25-10-beta/analytics/resource/{experienceId} — Access analytics data for an experience with customizable date ranges and audience segmentation

  • POST /v25-10-beta/analytics/sitewide — Fetch sitewide analytics (revenue per visitor, net revenue, visitors) for a given date range

For detailed endpoint documentation including parameters, request examples, and response schemas, see the API Referencearrow-up-right.

Previouscampaigns.setHistoryStatus(params)NextIntelligems External API

Last updated