The Minitab Connect API

Overview of an API request

Each endpoint has a specific list of attributes that contain values, some shared and some unique, that may be searched against using the API version 3 search request. To receive the list of attributes for an endpoint, write a simple API version 3 request. An API version 3 request for endpoint attributes only requires three basic pieces of information: base url, endpoint, and API key.

Base URL

The base URL is the same regardless of the specific API request that is made. To determine what your base URL should be, simply copy the URL that you use to log into Minitab Connect. For example, if you use https://connect.minitab.com to access Minitab Connect, then the base URL for all your API requests is: https://connect.minitab.com/api/3/.

Endpoint

Represents the object or collection of objects that the request is intended to interact with. In the above example, the endpoint in the 'Example API Request' is 'Source'. This will limit what can be done with the API request to Actions that are specifically designed to manipulate 'Source' data objects.

For example, the endpoint in https: //connect.minitab.com/Source/?apikey=12478781287471824&action=search&arg=[{"name":"Campaigns"}] is 'Source'. This will limit what can be done with the API request to actions that are specifically designed to manipulate 'Source' data objects.

Endpoint GUID

The endpoint GUID is a unique identifier that represents a specific data object within Minitab Connect. The GUID consists of a unique string of characters and is sometimes referred to as a 'Key'. To find the GUID in Minitab Connect, open the Edit modal for the desired object. The endpoint GUID is not required for all API requests. For example, an API request that performs a search action omits the endpoint GUID.

API key

This part of the API Request informs the system that the request should be processed with the same permissions as the specified user. This will always be represented by a GUID. An API key is a unique string of characters that is associated with a specific user of Minitab Connect. To find your GUID, first log into the system. Next, open theUser Menu button in the top right and select Account Settings. A list of available API keys is listed with the ability to generate new ones. (In this example, a dummy API key is used for security purposes)

Authentication

Informs the system that the request should be processed with the same permissions as the specified user. Authentication is represented by an API Key. An API Key is a unique string of characters that is created to give access to a feature in the tool. To create an API key, open theUser Menu button in the top right and select Account Settings. For more information, go to Generate an API token.

Action

Specifies what actions to take for the specified endpoint. Actions are usually categorized as follows:

• Getters: Getter actions are used to extract data out of the system. Each endpoint has a unique set of getters. To use a getter, the correct format is: action=<nameOfGetter> where <nameOfGetter> is replaced by the name of the desired getter.
• Setters: Setter actions are used to import data into the system and to set or change properties of a data object. Each endpoint has a unique set of setters. To use a setter, the correct format is: action=<nameOfSetter>&arg=<valueToSet> where <nameOfSetter> is replaced by the name of the desired setter and <valueToSet> is the value to be set.
• Actions: Actions are used for processes, features, or commands of a data object that do not meet the characteristics of a getter. One example of an action is to add fields to a table. Each action has different requirements. For example, some actions do not require any arguments and are formatted in the same way as a getter. Other actions require that arguments are formatted like a setter.
• Searches: Searches are used to obtain data from an endpoint that meets a specific set of parameters. Searches can have an infinite number of search terms and are formatted as an array. For example: action=search&args=[{"fname":"John","lname":"Smith"}] would only return records where [ "fname" (first name) is "John" AND "lname" (last name) is "Smith". You can use any number of search terms as long as they fit the key:value structure and are separated by commas.

  Note

  When adding the values to the API search request, text strings must be inside quotes.

You can make an API request that contains multiple actions. To do so, separate each action with an ampersand ('&'). For example, you need to change the first name, middle name and last name of a user that has an ID of 15. The request looks like this:

https://connect.minitab.com/api/3/User/15?apikey=45a3d34982e&action0=setFName&arg0=John&action1=setMName&arg1=D&action2=setLName&arg2=Smith

This request sets the First Name equal to "John", the Middle Name equal to "D" and the Last Name equal to "Smith" on the User that has an ID of 15.

Note

When using multiple actions in a single API request, the action must be incremented. The first action and argument can be appended with a 0 or 1. Each additional action grouping must increment by a factor of 1.

API request to return all actions for an endpoint

At any point an API request can be made that will return a list of all actions available to a specific endpoint . The request is as follows:

https://connect.minitab.com/api/3/[endpoint]/?apikey=[apikey]

Replace the endpoint with the specific endpoint and apikey with an actual API key. A JSON object will be returned that contains all actions for the endpoint as well as all attributes.

Current endpoints and descriptions

At any point, you can make an API request that will return a list of all endpoints. The request is as follows:

https://connect.minitab.com/api/3/?apikey=[apikey]