How to work with Indicators through the Clear Impact Scorecard API.
Explanation of Indicator Parameters
For a more complete summary of each property check out the Indicator support page.
- calculationType [int]* - The ID of the calculation type for the Indicator. 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 Indicator.
- dataSource [string] - A string of text that defines where the data for this Indicator comes from. (i.e. CDC Monthly Report).
- isBestPractice [bool]* - Whether or not to share this Indicator in the best practices library. For most newly created Indicators this should be false.
- polarityType [int]* - The ID of the polarity type for the Indicator. 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 Indicator will display.
- title [string]* - The name of the Indicator
- unitOfMeasure [string] - The unit of measure for this Indicator such as $, %, or #.
- uoMisPrefix [bool]* - Whether or not the unit of measure should be displayed before or after the numerical value for this Indicator. For Example, true will place a dollar symbol before the number while false will place a % symbol after the number.
- resultID [int] (optional - parent value) - When retrieving a list of Indicators you can pass in the ID of a Result to retrieve just a list of Indicators that are related to that Result.
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 Indicators
URL
https://api.resultsscorecard.com/api/indicators/list
XML Input
<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<resultID>555</resultID>
</Parameters>
XML Output
<ArrayOfIndicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Indicator>
<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>
<scale>1</scale>
<title>New Indicator</title>
<primaryTag>ThisIsATag</primaryTag>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Indicator>
</ArrayOfIndicator>
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
resultID: 555
}
JSON Output
[
{
"ID": 1,
"calendarId": 1,
"polarityId": 1,
"calculationTypeId": 1,
"aggregationTypeId": 1,
"title": "New 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"
}
]
Add an Indicator
URL
https://api.resultsscorecard.com/api/indicators/add
XML Input<Indicator>
<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>Newer Indicator</title>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Indicator>
XML Output
<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-11-15T09:23:37.6247886-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-15T09:23:37.6247886-08:00</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>Newer Indicator</title>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Indicator>
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 Indicator999",
"unitOfMeasure": "1",
"uoMisPrefix": true
}
JSON Output
{
"ID": 3,
"calendarId": 1,
"polarityId": 1,
"calculationTypeId": 1,
"aggregationTypeId": 1,
"title": "New Indicator",
"unitOfMeasure": "1",
"uoMisPrefix": true,
"scale": 1,
"colorBands": true,
"isBestPractice": true,
"primaryTag": "ThisIsATag",
"dataSource": "data-source",
"createDate": "2013-11-15T09:26:49.733983-08:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-15T09:26:49.733983-08:00",
"modifiedBy": "email@domain.org"
}
Get Indicator Details
URL
https://api.resultsscorecard.com/api/indicators/details
XML Input
<?xml version="1.0"?>
<Parameters>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<ID>2</ID>
</Parameters>
XML Output
<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-11-15T09:23:37.627</createDate>
<createdBy>email@domain.org</createdBy>
<dataSource>data-source</dataSource>
<ID>2</ID>
<isBestPractice>true</isBestPractice>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-15T09:23:37.627</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>Newer Indicator</title>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Indicator>
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:1
}
JSON Output
{
"ID": 1,
"calendarId": 1,
"polarityId": 1,
"calculationTypeId": 1,
"aggregationTypeId": 1,
"title": "New 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 an Indicator
Note - calendarId and calculationId cannot be updated after an Indicator is created. These can only be updated through the UI.
URL
https://api.resultsscorecard.com/api/indicators/update
XML Input
<Indicator>
<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 Indicator</title>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Indicator>
XML Output
<Indicator xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<aggregationTypeId>1</aggregationTypeId>
<calculationTypeId>1</calculationTypeId>
<calendarId>1</calendarId>
<colorBands>true</colorBands>
<createDate>2013-11-15T09:23:37.627</createDate>
<createdBy>email@domain.org</createdBy>
<dataSource>data-source</dataSource>
<ID>2</ID>
<isBestPractice>true</isBestPractice>
<modifiedBy>email@domain.org</modifiedBy>
<modifyDate>2013-11-15T09:32:28.3433527-08:00</modifyDate>
<polarityId>1</polarityId>
<primaryTag>ThisIsATag</primaryTag>
<scale>1</scale>
<title>Updated Indicator</title>
<unitOfMeasure>1</unitOfMeasure>
<uoMisPrefix>true</uoMisPrefix>
</Indicator>
JSON Input
{
"siteCode": "abc",
"apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
"aggregationTypeId": 1,
"colorBands": true,
"dataSource": "data-source",
"ID": 26052,
"isBestPractice": true,
"polarityId": 1,
"primaryTag": "ThisIsATag",
"scale": 1,
"title": "New Indicator",
"unitOfMeasure": "1",
"uoMisPrefix": true
}
JSON Output
{
"ID": 3,
"calendarId": 1,
"polarityId": 1,
"calculationTypeId": 1,
"aggregationTypeId": 1,
"title": "New Indicator",
"unitOfMeasure": "1",
"uoMisPrefix": true,
"scale": 1,
"colorBands": true,
"isBestPractice": true,
"primaryTag": "ThisIsATag",
"dataSource": "data-source",
"createDate": "2013-11-15T09:26:49.733",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-15T09:35:16.6089797-08:00",
"modifiedBy": "email@domain.org"
}
Delete an Indicator
URL
https://api.resultsscorecard.com/api/indicators/delete
XML Input
<Indicator>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<ID>2</ID>
</Indicator>
XML Output
Successfully deleted indicator [id].
JSON Input
{
siteCode: "abc",
apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
id:3
}
JSON Output
Successfully deleted indicator [id].