Skip to content
  • There are no suggestions because the search field is empty.

Use the Convert API

Leverage the Convert REST API for Custom Integrations and Automated Workflows

🚀 This Article Will Help You:



📖 Introduction

The Full Stack REST API allows you to interface with Convert programmatically to build customized integrations and workflows. For example, you can create feature flags from an automated script, build custom dashboards of feature test results, or connect your experiments to other project management tools.

To explore the REST API, we recommend an API client called Postman. Using Postman, you can import an API collection with example requests for each Full Stack API method. See below for instructions on setting up Postman to explore the API. If you are interested in this, let support@convert.com know and will provide you with a sample collection file.

To integrate the API into your application, you'll need to generate an API token and use it to call the API directly from your code. For an overview of using the REST API, see the Integrate the REST API section below.

🔍 Explore the API

To explore the Full Stack REST API collection:

  1. Install Postman if you haven't already installed it on your machine.
  2. Click the Import button.
  3. Choose Import File.
  4. Select the Convert API.postman_collection.json file that support team will provide to you
  5. Click Collections in the left pane, then click a folder to see the available methods.

 

By default, this collection links to a sample project and you need to update Pre-request script with your own ApplicationID and ApplicationSecretKey and also to update project, experience, goal, audiences, reports IDs.

 

You can find your own keys here:

🔑 Integrate the API

For production use cases, you'll want to integrate these API calls directly into your own application. For a full guide to all our REST API endpoints, see the Convert V1 REST API reference. This reference describes each endpoint's methods and fields.