API: Measures

How to work with Measures through the Clear Impact Scorecard API.

Explanation of Measure Parameters

For a more complete summary of each property check out the Measure support page.

  • 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 admin --> object types.  Lowercase is preferred.
  • calculationType [int]* - The ID of the calculation type for the Measure. See table below. (available on create only)
  • calendarID [int]* - The ID of the reporting frequency (calendar) for this measure. See table below for default calendars. If a custom calendar is being used you will need to run a report to export the correct Calendar ID's using the custom reporting module. (available on create only)
  • colorBands [bool]* - Whether or not to enable color bands for this Measure.
  • dataSource [string] - A string of text that defines where the data for this Measure comes from. (i.e. CDC Monthly Report).
  • isBestPractice [bool]* - Whether or not to share this Measure in the best practices library. For most newly created Measures this should be false.
  • polarityType [int]* - The ID of the polarity type for the Measure. See table below.
  • primaryTag[string] - String between 1-15 characters. This is the Clear Impact Scorecard tag used for categorizing this object. You can enter a tag that already exists to be linked or enter a new tag that does not exist and it will be created.
  • scale [int]* - A value between 0-6 that denotes how many decimals this Measure will display.
  • unitOfMeasure [string] - The unit of measure for this Measure such as $, %, or #.
  • uoMisPrefix [bool]* - Whether or not the unit of measure should be displayed before or after the numerical value for this Measure. For Example, true 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 you can pass in the ID of a Container to retrieve just a list of Measures that are related to that Container.

Optional Graph Settings

  • graphType [short] - Determines the type of graph for the measure.  1 for line chart and 2 for bar chart.
  • graphComparison [boolean] - Whether to default the graph presentation to comparison mode or not.  Default is false.
  • displayTargetValues [boolean] - Determines whether target values display on the graph by default.  Default is true.
  • displayDataLabels [boolean] - Determines whether data labels display on the graph by default.  Default is true.
  • displayForecastValues [boolean] - Determines whether forecast values display on the graph by default.  Default is true.
  • displayTrendline [boolean] - Determines whether the trendline display on the graph by default.  Default is false.
  • previousTimePeriods [int] - Determines how many time periods into the past display on the graph when it loads.  Default is 7.

List of Available Calendars

  • 1 - Monthly
  • 2 - Quarterly
  • 3 - Annually
  • 4 - Half Year

List of Available Polarity Types

  • 1 - Higher is Better
  • 2 - Lower is Better
  • 3 - Target Range
  • 4 - Do Not Display
  • 5 - No Polarity

List of Available 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

XML Input

<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<containerID>555</containerID>
</Parameters>

XML Output

<ArrayOfMeasure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Measure>
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-10-11T00:00:00</createDate>
<createdBy>email@domain.org</createdBy>
<dataSource>data-source</dataSource>
<ID>1</ID>
<isBestPractice>true</isBestPractice>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-10-13T00:00:00</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>New Measure</title>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Measure>
</ArrayOfMeasure>

JSON Input

{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
containerID: 555
}

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

XML Input

<Measure>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<dataSource>data-source</dataSource>
<isBestPractice>true</isBestPractice>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>New Measure</title>
<measureType>indicator</measureType>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Measure>

XML Output

<Measure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-11-14T09:12:10.0777421-08:00</createDate>
<createdBy>email@domain.org</createdBy>
<dataSource>data-source</dataSource>
<ID>2</ID>
<isBestPractice>true</isBestPractice>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-14T09:12:10.0777421-08:00</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>New Measure</title>
<measureType>indicator</measureType>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Measure>

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

XML Input

<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<ID>2</ID>
</Parameters>

XML Output

<Measure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-11-14T09:12:10.077</createDate>
<createdBy>email@domain.org</createdBy>
<dataSource>data-source</dataSource>
<ID>2</ID>
<isBestPractice>true</isBestPractice>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-14T09:12:10.077</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>New Measure</title>
<measureType>indicator</measureType>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Measure>

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

XML Input

<Measure> 
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<aggregationTypeId>1</aggregationTypeId>
<colorBands>true</colorBands>
<dataSource>data-source</dataSource>
<ID>2</ID>
<isBestPractice>true</isBestPractice>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>Updated PM</title>
<measureType>indicator</measureType>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Measure>

XML Output

<Measure xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-11-14T09:12:10.077</createDate>
<createdBy>email@domain.org</createdBy>
<dataSource>data-source</dataSource>
<ID>2</ID>
<isBestPractice>true</isBestPractice>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-14T09:22:28.471954-08:00</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>Updated PM</title>
<measureType>indicator</measureType>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Measure>

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

XML Input

<?xml version="1.0"?>
<Measure>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<ID>1</ID>
</Measure>

XML Output

Successfully deleted measure [id].

JSON Input

{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:2
}

JSON Output

Successfully deleted measure [id].