Uses for the ClearPoint API
The usual integrations, how to select an integration method, and the conditions you must know before you make an integration.
Most organizations use the ClearPoint API for one of two reasons. The data for their reports is in a different system. Or their reporting cycle has manual data entry that they want to remove. The API helps with both conditions.
The usual integrations
Automatic measure updates. Send actuals into ClearPoint at regular times from the system that holds the value. This system can be a data warehouse, a finance system, a CRM, an ERP, or an operational database. This is the most frequent integration. It removes the manual data entry step from your reporting cycle.
Data extracts for reports. Get the structure of a scorecard and its performance data from ClearPoint. Use this data in a data warehouse, a report tool, or a public web page.
New scorecards from a plan. Make scorecards, categories, objectives, and measures with software code from an approved strategic plan. This method is quicker than manual entry of each element. It is useful if you make a new scorecard for each department, program, or grant cycle.
The same project data in two systems. Your teams use a different system each day for their work. Keep the initiatives, the milestones, and the action items the same in both systems. Your teams then enter a status one time only.
Reports from more than one system. Send measures from different systems into one scorecard. Your leadership team then examines one report. They do not compare data from many extracts.
Questions about your data in an AI client. Let your staff ask questions about ClearPoint data in an AI client. They do not have to learn the API. Refer to Model Context Protocol (MCP) server.
How to select an integration method
| REST API | MCP server | Zapier | |
|---|---|---|---|
| Work to set up | A developer must write software code | Configuration only | Configuration only |
| Best for | Data loads at regular times, changes to data, custom rules, and large operations | Questions, analysis, and updates through an AI client | Automation between two applications after an event |
| Operates as | The account that you specify in the integration | The ClearPoint user who signs in | The ClearPoint account that you connect |
| Usual start condition | Your scheduler or your software | A request from a person in the client | An event in the other application |
The three methods operate together. A usual configuration has three parts. The API does a data load each night. Zapier sends messages between applications. Analysts use the MCP server for their work.
Conditions you must know
These conditions apply to all integrations. Examine them before you write software code.
Permissions apply to each user. The API uses the same permissions as the application. Select the account for your integration with care. Give this account the minimum access that it needs for the applicable scorecards. If a write operation gives the error 403, the usual cause is the permission level of the account.
Data applies to a period. All data that changes with time is part of a reporting period. Specify the period that your integration writes to. Do not use the default period. This is very important if you write data for periods in the past.
Element names are configurable. Your users can have a different name for an objective. The API always uses the default element names. Keep a list of your names and the related default names in your integration.
Links have a structure. Categories link to objectives. Objectives link to measures and initiatives. To find the measures in a focus area, read the links in this sequence. Do not try to read one field. An element can also have a link from more than one parent. The same element can then show two times in a report. Remove the double entries if necessary.
A delete operation is a soft delete. A delete operation removes the element from the application, but ClearPoint keeps the record. Do not use DELETE to erase data fully.
Use the endpoints for collections. If an endpoint gives all the applicable elements for a scorecard, use it. Do not send one request for each element. One request for a collection is quicker for you and for the ClearPoint API.
Security and permissions
- All data goes through HTTPS to
https://app.clearpointstrategy.com/api/v1. - Authentication uses OAuth 2.0 for applications that a person operates. An access token has a limited life.
- An integration that operates without a person uses ClearPoint API keys. You make the keys in the application and you can replace them there.
- A key pair belongs to one ClearPoint user and gets the permissions of that user. Make a user account for the integration.
- ClearPoint applies its permissions to each request. The API does not give more access than the user has in the application.
- The ClearPoint API also applies its data checks and its rules. An integration cannot make a record that the application does not accept.
For documentation about security reviews, speak to your ClearPoint account manager.
What to do next
- Start here — the data concepts and your first call
- REST, OAuth 2.0, and JSON — authentication and the JSON data format
Updated 4 days ago