The ClearPoint API allows clients to integrate their ClearPoint account with other applications and data sources. This can help you improve data accuracy, and consistency, and make better decisions.

In order to use the API, you’ll first need to create your personal API Keys. These are available for Enterprise plans and can be accessed from Admin Options. Check out this Help Center article on Getting and Using ClearPoint API Keys for more details on where to find them.

Edit vs. Update Fields:

ClearPoint is a reporting software. Clients use it to report on their progress over time, whether that be monthly, quarterly, or annually. Some fields need to remain consistent over time, like a measure definition or owner, while other fields need new data every reporting period, such as a status or monthly analysis.
​
Fields that stay the same over time are known as Edit fields whereas fields that are tied to reporting periods and can contain a new value every period are Update fields.

Scorecards:
​
Scorecards can be thought of as folders for the reporting structure. Other elements, such as Objectives and Measures, live inside the scorecard and can be linked together to show how they are related. Every element lives in at least one Scorecard, but may also exist in others due to links between elements. You must have access to a scorecard where the element lives in order to access that element over the API.

Default Element Names: ClearPoint can be customized to meet any reporting structure by customizing the names of the default reporting elements. The default element names are Scorecard, Category, Objective, Measure, Initiative, Milestone, Action Item, and Risk.
​

These are the element names you will see throughout the API documentation. It is important to familiarize yourself with the terminology used by your organization and match that to the corresponding default element in ClearPoint. Check out this help center article to match your strategic elements to their default names found in the API documentation.
​
It is important to note that not every element is used by every organization, so some may be hidden in your account.

ClearPoint’s API Documentation is organized by element, such as Objectives. All available methods and endpoints are grouped by element. The API documentation page is not intended to serve as your GUI for interacting with the API. Instead, use it as a guide for identifying the calls needed to perform a specific action. Another good resource is your browser’s developer tools.

When logged into ClearPoint you can make a change and then watch the network section of the developer tools for information on how the call should be structured.

​

ClearPoint’s API exposes the four standard methods for interacting with REST services:
​
​POST (create)
​GET (read)
​PUT (update/replace)
​DELETE (delete)
​
For example:
​
GET requests can be made to either read a collection or a specific member.

GET /scorecards will retrieve all scorecards for which you have access and
GET /scorecards/{scorecardId} will retrieve information for a specific scorecard

Requests should be configured using standard HTTPS protocol. All payloads should be formatted in JSON and all response payloads will be returned in JSON (wording, extra spaces, clarity).

For practicing or testing API calls, we recommend using a tool like Postman to make requests against the demo server. The demo database is overwritten every night at 1 AM by data in your production database, making it a great place to practice. When you are ready to use the real thing, this is the production URL.

Using your API Keys in the request headers, try out some of these common actions: