ClearPoint Strategy API

Elements
Personalization
Automation
Collaboration
Reporting
Schedules
- Delete scheduledel
Customization
Reports
Exports
Files
Administration
Account Transfer
- Queue a ClearPoint Portable Archive export of one scorecard, several, or the whole account.post
Element Fields
Announcements
Assets
- Get assetsget
- Create or update assetspost
DataLoader
Admin
- Run Bulk Opeerationpost
Email
- Get count of queued digest messagesget
- Process and send all queued digest emailspost
Account
- Get account entitlementsget
Insights
Jobs
- List async jobs for the district (okfExport, parse, ...). Optional 'status' and 'type' filters. The input/output blobs are omitted from the list; fetch a single job for those.get
- Get a job (status, progress, output). When the artifact is ready, a presigned downloadUrl is included.get
OKF
OKR Updates
One-on-Ones
Playbooks
- List playbook categoriesget
- Save all playbook categoriesput
Pulse Checks
Pulse Questions
- List pulse questions for the requesting districtget
- Bulk replace the pulse-question set for the requesting districtput
Resources
snapshots
- List archived accountsget
Zapier
Imports
- Import datapost
- Import dataget
Parsing Jobs
Widgets
AI
/activities
- Track activitypost
/count
- Count matching elementspost
/linkBuilderCheck
- Test-only: udf link-builder output (Next vs Classic)get
/mcp/add/{object}
- Add Element: Creates a new ClearPoint element (objective, measure, initiative, milestone, actionItem, risk, or scorecard). Provide the element type in {object} field in the path and element-specific fields in the request body as a JSON object. Most types require `name` and `scorecardId` fields.post
/mcp/bulkAdd
- Bulk Add Elements: Creates multiple ClearPoint elements in a single request. Accepts an array of items, each with an 'object' type and element-specific fields. Returns results for each item.post
/mcp/bulkEdit
- Bulk Edit Elements: Edits multiple ClearPoint elements in a single request. Accepts an array of items, each with 'object', 'objectId', and fields to update. Returns results for each item.post
/mcp/bulkEditLinks
- Bulk Edit Links: Edits link relationships for multiple elements in a single request. Each item supplies either a full 'links' array or a single add/remove link action. Returns results for each item.post
/mcp/delete/{object}/{objectId}
- Delete Element: Deletes a ClearPoint element (scorecard, category, objective, measure, measureSeries, chart, initiative, milestone, actionItem, or risk). Provide the element type in {object} field and the element id in {objectId} field in the path.del
/mcp/edit/{object}/{objectId}
- Edit Element: Edits a ClearPoint element (objective, measure, initiative, milestone, actionItem, risk, or scorecard). Edits are not period-specific (they apply to all reporting periods). To update an element for a reporting period, use the mcpUpdateElelemt endpoint. Provide the element type as {object} and the element ID as {objectId} in the path. Provide the element-specific fields to edit in the request body as an object in JSON format.post
/mcp/query
- Research: Takes a natural language question and uses structured tool calls to research and answer it. Uses safe stored procedures instead of SQL generation. Provide the required `question` field. Optional: `model` (LLM model), `fast` (true for single-tool fast mode, false for multi-turn with synthesis).get
/mcp/update/{object}/{objectId}
- Update Element: Updates a ClearPoint element (objective, measure, initiative, milestone, actionItem, risk, or scorecard) for a specific reporting period. To edit an element for all reporting periods, use the mcpEditElement endpoint. Provide the element type as 'object' and the element ID as 'objectId', and the reporting period ID as 'periodId' in the query string. Provide the fields to update in the request body as a JSON object.post
/mcp/update/{object}/{objectId}/data
- Update Element Data: Updates a ClearPoint element (objective, measure, initiative, milestone, actionItem, risk, or scorecard) series data. Provide the element type as 'object' and the element ID as 'objectId'. Provide the series data to update in the request body as a JSON object.post
/ping
- Ping for service aliveget
/preview
- List optionspost
/pusher
- Pusher authenticationpost
/sortOrder
- Sort elementspost
Categories
Scorecards
Measure Series
Measure Data
- Get series data with period data for specified periodsget
Initiatives
Milestones
Action Items
Risks
Goals
- Get goals linked to an elementget
Key Results
Favorites
- Toggle favoritepost
Workspaces
- Create Workspacepost
- Edit Workspaceput
Scorecard Reports
- List scorecard reportsget
Workflow Emails
REST Hooks
- Delete subscriptiondel
Images
- Upload imagepost
Setup
Authentication
- Clears the current user server session cache.del
- Sets or updates the current user session (locale, colors, scorecardId, etc.).post
Search
Utilities
- Aggregate log entry counts by week, user, and object typeget
- Send emailpost
Master Periods
- Update master periodspost
My ClearPoint

Edit Link: Adds or removes one linkage for an element. Provide the {object} and {objectId} for the element in the path, and the link action in the body.

post

https://app.clearpointstrategy.com/api/v1/mcp/edit/{object}/{objectId}/link

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

object

string

enum

required

Required element type

Allowed:

objectId

number

required

Required element ID

Body Params

action

string

enum

required

Whether to add or remove the link.

Allowed:

linkObject

string

enum

required

The element type of the linked element. Named linkObject rather than object because Taffy merges a struct request body into the arguments scope, where an 'object' key would overwrite the path parameter.

Allowed:

linkObjectId

integer

required

≥ 1

The element ID of the linked element.

Responses

Updated 20 days ago

Sets or updates the current user session (locale, colors, scorecardId, etc.).

Edit Links: Edit the linkages for an element. Provide the {object} and the {objectId} for the element in the path, and the array of links in the body. The existing links will be replaced by the links provided.

Did this page help you?

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 20 days ago

Sets or updates the current user session (locale, colors, scorecardId, etc.).

Did this page help you?

200OK

defaultError