Getting Started

👍

Whale puns are so not not my bag. Take me to the API Documentation

If you're a tech enthusiast who gets a kick out of integrating applications or just geek out over data sources, you're going to love the ClearPoint API. It's like having data integration superpowers. Of course, it's not for everyone. It's like a private club - only the Elite members on the Enterprise Plan get in.

Before you start your API integration adventure, don't forget to get familiar with our API documentation. It's like the Hitchhiker's Guide to the ClearPoint API - an essential companion that's full of all sorts of useful information to get you zipping along on your integration journey.

ClearPoint for Dummies

Edit vs. Update Fields: Let's clear up some lingo. ClearPoint is like your personal reporter, tracking progress over time - monthly, quarterly, like clockwork. Some things need to stay the same, like the "measure definition" or "owner" (these are the 'Edit' fields). Others need a regular update, like your latest score on Flappy Bird or your monthly expense report (these are the 'Update' fields).

Scorecards: Think of scorecards as the VIP section of your data night club. They're where Objectives and Measures hang out and party. Every element has at least one scorecard, but some might have access to more because of links between elements. And just like the best night clubs, you need to be on the list (or in this case, have access to the scorecard) to get in.

Default Element Names: ClearPoint is like a chameleon, able to change its colors to fit your reporting structure. Scorecard, Category, Objective, Measure, Initiative, Milestone, Action Item, and Risk - these are the terms you'll find throughout the API docs. If your organization uses different jargon, you'll need to match it with the default element in ClearPoint.

Logging into the ClearPoint Matrix

To dive into the ClearPoint API matrix, hit that Login button in the upper right. Once you're in (using your ClearPoint username and password), the developer documentation will seem like it's had a shot of espresso! Your personal token, protected by the mighty OAuth2 shield, gets you right into the ClearPoint Developer documentation. Now you can try things out right in your browser.

👍

Already logged in? Give Get My Profile a click and hit 'Try It!' You'll see your profile returned by the API. Mind-blowing, isn't it? If you hit a wall logging in, reach out to the ever-so-helpful ClearPoint Support team at [email protected].

ClearPoint API – The Blueprint

Click on the API Reference link and you'll see the Developer Portal organized by element, like an orderly tech conference. All the methods and endpoints are neatly grouped by element (or grouped logically like all the Admins huddling together).

ClearPoint’s API offers the four Musketeers of REST services: POST (the creator), GET (the reader), PUT (the updater/replacer), and DELETE (the terminator). GET requests can be used to either raid a collection or fetch a specific member. For example, GET /scorecards will nab all scorecards you have access to, while GET /scorecards/{scorecardId} will swipe info for a specific scorecard. Now, isn't that a data joyride?