--- title: "API: Measures" description: How to work with Measures through the Clear Impact Scorecard API. --- [Skip to content](https://support.clearimpact.com/en/2023-api-measures#main-content) English Show submenu for translations [Contact Support](https://support.clearimpact.com/en/kb-tickets/new?hsLang=en) [![Clear-Impact-Logo-Wide-Tagline-RGB.png\]](https://support.clearimpact.com/hs-fs/hubfs/images/Clear-Impact-Logo-Wide-Tagline-RGB.png?height=40&name=Clear-Impact-Logo-Wide-Tagline-RGB.png)](https://support.clearimpact.com/?hsLang=en) Open main navigation Close main navigation - English Show submenu for translations - [Contact Support](https://support.clearimpact.com/en/kb-tickets/new) - [Help Desk](https://support.clearimpact.com/en/kb-tickets/new) [Help Desk](https://support.clearimpact.com/en/kb-tickets/new?hsLang=en) Hi, how can we help you? - There are no suggestions because the search field is empty. 1. [Help Center](https://support.clearimpact.com/en?hsLang=en) 2. [Scorecard Documentation](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en) 3. [API](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#api) # API: Measures The API enables the following interactions with measures: - [Get list of measures](https://support.clearimpact.com/en/2023-api-measures#GetList) - [Add a measure](https://support.clearimpact.com/en/2023-api-measures#Add) - [Get measure details](https://support.clearimpact.com/en/2023-api-measures#GetDeets) - [Update a measure](https://support.clearimpact.com/en/2023-api-measures#udpate) - [Delete a measure](https://support.clearimpact.com/en/2023-api-measures#delete) - [Assign a measure to a container](https://support.clearimpact.com/en/2023-api-measures#Connect-Measure-to-Container) - [Add measure and assign to container](https://support.clearimpact.com/en/2023-api-measures#Add-Measure-Assign-Measure-to-Container) ### Explanation of Measure Parameters - title \[string\]\* - The name of the measure - measureType \[string\]\* - The name of the measure type.  Available measure types for your instance can be found in **Object Types**. Lowercase is preferred. - calculationType \[int\]\* - The ID of the [calculation type](https://support.clearimpact.com/en/2023-api-measures#CalcTypes) (available on create only) - calendarID \[int\]\* - The ID of the [reporting frequency](https://support.clearimpact.com/en/2023-api-measures#Calendars) (available on create only). When using a [custom frequency](https://support.clearimpact.com/en/2023-reporting-frequencies?hsLang=en), you will need to run a [report](https://support.clearimpact.com/en/2023-what-are-reports?hsLang=en) to export the correct calendar ID's. - colorBands \[bool\]\* - Whether or not to enable color bands - dataSource \[string\] - A text string that defines the indicator data source, such as "CDC Monthly Report" - isBestPractice \[bool\]\* - Whether or not to share this indicator in the best practices library (should be false for most newly created indicators) - polarityType \[int\]\* - The ID of the [polarity type](https://support.clearimpact.com/en/2023-api-measures#Polarity) - primaryTag\[string\] - The [tag](https://support.clearimpact.com/en/2023-tags?hsLang=en) used for categorizing this object, between 1-15 characters. You can enter a tag that already exists, or enter a new tag and it will be created. - scale \[int\]\* - A value between 0-6 specifying how many decimals this indicator will include - unitOfMeasure \[string\] - Unit of measure, such as $, %, or # - uoMisPrefix \[bool\]\* - Whether or not the unit of measure should be displayed before or after the numerical value. For example, a TRUE value will place a dollar symbol before the number, while FALSE will place a % symbol after the number. - containerID \[int\] (optional - parent value) - When retrieving a list of measures, including a container ID narrows the list of measures to only those related to that container. #### Optional Graph Settings - graphType \[short\] - Type of graph: 1 for line chart, 2 for bar chart - graphComparison \[boolean\] - Whether or not to display the graph in presentation mode by default (default: FALSE) - displayTargetValues \[boolean\] - Whether or not target values display on the graph by default (default: TRUE) - displayDataLabels \[boolean\] - Whether or not data labels display on the graph by default (default: TRUE) - displayForecastValues \[boolean\] - Whether or not forecast values display on the graph by default (default: TRUE) - displayTrendline \[boolean\] - Whether or not the trendline displays on the graph by default (default: FALSE) - previousTimePeriods \[int\] - Determines how many past time periods display on the graph when it loads (default: 7) **Available Calendars** - 1 - Monthly - 2 - Quarterly - 3 - Annually - 4 - Half Year **Polarity Types** - 1 - Higher is Better - 2 - Lower is Better - 3 - Target Range - 4 - Do Not Display - 5 - No Polarity **Calculation Types** - 1 - Not Calculated - 2 - Sum - 3 - Average - 4 - Ratio - 5 - Ratio x 100 - 6 - Custom Equation - 7 - Accumulate Total Sum - 8 - Accumulate Year-To-Date Sum - 9 - Accumulate Total Average - 10 - Accumulate Year-To-Date Average - 11 - Sub-Annual Child Year-To-Date Sum - 12 - Sub-Annual Child Year-To-Date Average ### Get List of Measures **URL** ``` https://api.resultsscorecard.com/api/measures/list ```   **JSON Input** **Example of input showing all measures within a specific container** ``` {siteCode: "abc",apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",containerID: 555} ```   **Example of input showing all measures within a specific container of a specific measure type** ``` {siteCode: "abc",apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",containerID: 555,measureType: [Measure Type] } ```   **Example of input including the parameter of measureType that will return all measures of that measure type within an instance**    ``` {siteCode: "abc",apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",measureType: [Measure Type] } ```   **JSON Output** ``` [{"ID": 1,"calendarId": 1,"polarityId": 1,"calculationTypeId": 1,"aggregationTypeId": 1,"title": "New Measure","unitOfMeasure": "1","uoMisPrefix": true,"scale": 1,"colorBands": true,"isBestPractice": true,"primaryTag": "ThisIsATag","dataSource": "data-source","createDate": "2013-10-11T00:00:00","createdBy": "email@domain.org","modifyDate": "2013-10-13T00:00:00","modifiedBy": "email@domain.org"}] ``` ### Add a Measure **URL** ``` https://api.resultsscorecard.com/api/measures/add ``` **JSON Input** ``` {"siteCode": "abc","apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO","aggregationTypeId": 1,"calculationTypeId": 1,"calendarId": 1,"colorBands": true,"dataSource": "data-source","isBestPractice": true,"polarityId": 1,"primaryTag": "ThisIsATag","scale": 1,"title": "New Measure","measureType": "indicator","unitOfMeasure": "1","uoMisPrefix": true} ``` **JSON Output** ``` {"ID": 3,"calendarId": 1,"polarityId": 1,"calculationTypeId": 1,"aggregationTypeId": 1,"title": "New Measure","measureType": "indicator","unitOfMeasure": "1","uoMisPrefix": true,"scale": 1,"colorBands": true,"isBestPractice": true,"primaryTag": "ThisIsATag","dataSource": "data-source","createDate": "2013-11-14T09:13:47.7496297-08:00","createdBy": "email@domain.org","modifyDate": "2013-11-14T09:13:47.7496297-08:00","modifiedBy": "email@domain.org"} ``` ### **Get Measure Details** **URL** ``` https://api.resultsscorecard.com/api/measures/details ``` **JSON Input** ``` {siteCode: "abc",apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",id:1} ``` **JSON Output** ``` {"ID": 1,"calendarId": 1,"polarityId": 1,"calculationTypeId": 1,"aggregationTypeId": 1,"title": "New Measure","measureType": "indicator","unitOfMeasure": "1","uoMisPrefix": true,"scale": 1,"colorBands": true,"isBestPractice": true,"primaryTag": "ThisIsATag","dataSource": "data-source","createDate": "2013-10-11T00:00:00","createdBy": "email@domain.org","modifyDate": "2013-10-13T00:00:00","modifiedBy": "email@domain.org"} ``` ### Update a Measure Note - calendarId and calculationId cannot be updated after a measure is created. These can only be updated through the UI. **URL** ``` https://api.resultsscorecard.com/api/measures/update ``` **JSON Input** ``` {"siteCode": "abc","apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO","aggregationTypeId": 1,"colorBands": true,"dataSource": "data-source","ID": 71436,"isBestPractice": true,"polarityId": 1,"primaryTag": "ThisIsATag","scale": 1,"title": "Updated Measure","measureType": "indicator","unitOfMeasure": "1","uoMisPrefix": true} ``` **JSON Output** ``` {"ID": 1,"calendarId": 1,"polarityId": 1,"calculationTypeId": 1,"aggregationTypeId": 1,"title": "Updated Measure","measureType": "indicator","unitOfMeasure": "1","uoMisPrefix": true,"scale": 1,"colorBands": true,"isBestPractice": true,"primaryTag": "ThisIsATag","dataSource": "data-source","createDate": "2013-10-11T00:00:00","createdBy": "email@domain.org","modifyDate": "2013-11-14T09:26:21.7183618-08:00","modifiedBy": "email@domain.org"} ``` ### Delete a Measure **URL** ``` https://api.resultsscorecard.com/api/measures/delete ``` **JSON Input** ``` {siteCode: "abc",apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",id:2} ``` **JSON Output** ``` Successfully deleted measure [id]. ``` ### Assign a Measure to a Container   **JSON Input** ``` {    sitecode : "sitecode",     apiKey: "intsance api key",    MeasureIDs: [2192,2193,2194],    ContainerId: 228} ``` ### Add a Measure and Assign Measure to Container   **JSON Input** ``` {    sitecode : "siteCode",     apiKey: "intsance api key",    title: "Measure add through API",    calendarId: 481,     calculationType: 1,     measureType: "Performance Measure",    polarityType: 1,     scale:1,    ContainerId: 2460}   ```   - [Scorecard Documentation](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#main-content) - [Getting Started](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#getting-started) - [Scorecards](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#scorecards) - [Scorecard Objects](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#scorecard-objects) - [Entering Scorecard Data and Notes](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#entering-scorecard-data-and-notes) - [Viewing or Editing Scorecard Objects and Data](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#viewing-or-editing-scorecard-objects-and-data) - [Actions](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#actions) - [Reports](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#reports) - [Tools](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#tools) - [Site-Level Settings](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#site-level-settings) - [API](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#api) - [Upgrade Notes](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#upgrade-notes) - [FAQ (Scorecard)](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#faq-scorecard) - [Scorecard Video Tutorials](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#main-content) - [Upgrade Videos](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#upgrade-videos) - [Training Videos](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#training-videos) - [Customer Success Stories](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#customer-success-stories) - [Compyle Documentation](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#main-content) - [Compyle Overview](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#compyle-overview) - [Participants, Households, and Organizations](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#participants-households-and-organizations) - [Data Collection](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#data-collection) - [Analytics](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#analytics) - [Administration](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#administration) - [Administration - Forms and Fields](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#administration-forms-and-fields) - [Scorecard Feeds](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#scorecard-feeds) - [Compyle Release Notes](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#compyle-release-notes) - [FAQ (Compyle)](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#faq-compyle) - [Referral Network (Compyle-to-Compyle Referrals)](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#referral-network-compyle-to-compyle-referrals) - [Compyle Video Tutorials](https://support.clearimpact.com/en/compyle-video-tutorials?hsLang=en#main-content) - [Compyle Overview Videos](https://support.clearimpact.com/en/compyle-video-tutorials?hsLang=en#compyle-overview-videos) - [Upgrade Webinars](https://support.clearimpact.com/en/compyle-video-tutorials?hsLang=en#upgrade-webinars) - [Control Documentation](https://support.clearimpact.com/en/control-documentation?hsLang=en#main-content) - [Control Overview](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-overview) - [Control for Users](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-for-users) - [Control for Administrators](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-for-administrators) - [Control FAQ](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-faq) - [Clear Impact Suite Overview](https://support.clearimpact.com/en/control-documentation?hsLang=en#clear-impact-suite-overview) - [Suite Release Notes](https://support.clearimpact.com/en/control-documentation?hsLang=en#suite-release-notes) - [Showcase Documentation](https://support.clearimpact.com/en/showcase-documentation?hsLang=en) - [Unlimited Suite Documentation](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#main-content) - [Suite Implementation Materials](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#suite-implementation-materials) - [Managing Partner/Child Sites](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#managing-partner-child-sites) - [Rolling Up Data Across the Unlimited Suite Network](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#rolling-up-data-across-the-unlimited-suite-network) - [Clear Impact Live Training](https://support.clearimpact.com/en/clear-impact-live-training?hsLang=en#main-content) - [Free and Customized Training](https://support.clearimpact.com/en/clear-impact-live-training?hsLang=en#free-and-customized-training) - [Software Courses](https://support.clearimpact.com/en/clear-impact-live-training?hsLang=en#software-courses) - [Collaborate with Clear Impact](https://support.clearimpact.com/en/collaborate-with-clear-impact?hsLang=en#main-content) - [Coming Attractions & Sneak Peeks](https://support.clearimpact.com/en/collaborate-with-clear-impact?hsLang=en#coming-attractions-sneak-peeks) - [Resources & Results](https://support.clearimpact.com/en/collaborate-with-clear-impact?hsLang=en#resources-results) [![Logo\_ClearImpact\_White](https://support.clearimpact.com/hs-fs/hubfs/Logo_ClearImpact_White.png?width=341&height=80&name=Logo_ClearImpact_White.png "Logo_ClearImpact_White")](http://www.clearimpact.com) Clear Impact Help Center | support@clearimpact.com Copyright © 2025, Clear Impact, Inc. LLC.