Back to home

Help Center

Scorecard Documentation

API: Scorecards

The API enables the following interactions with scorecards:

Get list of scorecards
Add a scorecard
Get scorecard details
Update a scorecard
Delete a scorecard

Scorecard Parameter Definitions

title [string]* - Scorecard name
description [string] - Scorecard description
parentScorecardId [integer] - Integer ID of the scorecard's parent scorecard
isEmbed [bool]* - Whether or not this scorecard can be embedded
isShared [bool]* - Whether or not to share this scorecard on Partner Connect
IsScored [bool]* - Whether or not this scorecard has Accountability Score enabled
priorActualValue[bool]* - Whether or not to display the Prior Actual Value column
currentActualValue[bool]* - Whether or not to display the Current Actual Value column
nextTargetValue[bool]* - Whether or not to display the Next Target Value column
currentTargetValue[bool]* - Whether or not to display the Current Target Value column
varianceFromTarget[bool]* - Whether or not to display the Variance From Target column
baselineChange [bool]* - Whether or not to display the Baseline % Change column
currentTrend [bool]* - Whether or not to display the Current Trend column
forecastValue [bool]* - Whether or not to display the Forecast Value column
timePeriod [bool]* - Whether or not to display the Time Period column

Get List of Scorecards

URL

https://api.resultsscorecard.com/api/scorecards/list

XML Input

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

XML Output

<ArrayOfScorecard xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Scorecard>
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>Changed score card desc</description>
<forecastValue>true</forecastValue>
<ID>11</ID>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<title>New Scorecard 1</title>
<parentScorecardId>5</parentScorecardId>
<modifiedBy>0</modifiedBy>
<modifyDate>2013-11-15T16:45:23.2257191-08:00</modifyDate>
<createDate>2013-11-15T16:45:23.2257191-08:00</createDate>
<createdBy>email@domain.org</createdBy>
</Scorecard>
<Scorecard>
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>Changed score card desc</description>
<forecastValue>true</forecastValue>
<ID>12</ID>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<title>New Scorecard 2</title>
<parentScorecardId>17</parentScorecardId>
<modifiedBy>0</modifiedBy>
<modifyDate>2013-11-15T16:45:23.2257191-08:00</modifyDate>
<createDate>2013-11-15T16:45:23.2257191-08:00</createDate>
<createdBy>email@domain.org</createdBy>
</Scorecard>
</ArrayOfScorecard>

JSON Input

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

JSON Output

[
{
"id":11,
"title":"Scorecard Title",
"description":"This is the description",
"parentScorecardId":5,
"isEmbed":false,
"isScored":false,
"timePeriod":true,
"priorActualValue":false,
"currentActualValue":true,
"currentTargetValue":false,
"nextTargetValue":false,
"forecastValue":false,
"baselineChange":true,
"currentTrend":true,
"varianceFromTarget":false,
"createDate": "2013-10-11T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-15T16:53:42.3208927-08:00",
"modifiedBy": "email@domain.org"
}
]

Add a Scorecard

URL

https://api.resultsscorecard.com/api/scorecards/add

XML Input

<Scorecard>
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>New scorecard desc</description>
<forecastValue>true</forecastValue>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<title>New Scorecard</title>
<parentScorecardId>5</parentScorecardId>
</Scorecard>

XML Output

<Scorecard xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>Changed score card desc</description>
<forecastValue>true</forecastValue>
<ID>11</ID>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<title>New Scorecard</title>
<parentScorecardId>5</parentScorecardId>
<modifiedBy>0</modifiedBy>
<modifyDate>2013-11-15T16:45:23.2257191-08:00</modifyDate>
<createDate>2013-11-15T16:45:23.2257191-08:00</createDate>
<createdBy>email@domain.org</createdBy>
</Scorecard>

JSON Input

{
"siteCode": "abc",
"apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
"title":"Scorecard Title",
"description":"This is the description",
"parentScorecardId":5,
"isEmbed":false,
"isScored":false,
"timePeriod":true,
"priorActualValue":false,
"currentActualValue":true,
"currentTargetValue":false,
"nextTargetValue":false,
"forecastValue":false,
"baselineChange":true,
"currentTrend":true,
"varianceFromTarget":false
}

JSON Output

{
"id":11,
"title":"Scorecard Title",
"description":"This is the description",
"parentScorecardId":5,
"isEmbed":false,
"isScored":false,
"timePeriod":true,
"priorActualValue":false,
"currentActualValue":true,
"currentTargetValue":false,
"nextTargetValue":false,
"forecastValue":false,
"baselineChange":true,
"currentTrend":true,
"varianceFromTarget":false,
"createDate": "2013-10-11T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-15T16:53:42.3208927-08:00",
"modifiedBy": "email@domain.org"
}

Get Scorecard Details

URL

https://api.resultsscorecard.com/api/scorecards/details

XML Input

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

XML Output

<Scorecard xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<apiKey>eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO</apiKey>
<siteCode>abc</siteCode>
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>Changed score card desc</description>
<forecastValue>true</forecastValue>
<ID>11</ID>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<title>Changed Scorecard</title>
<parentScorecardId>5</parentScorecardId>
</Scorecard>

JSON Input

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

JSON Output

{
"id":11,
"title":"Scorecard Title",
"description":"This is the description",
"parentScorecardId":5,
"isEmbed":false,
"isScored":false,
"timePeriod":true,
"priorActualValue":false,
"currentActualValue":true,
"currentTargetValue":false,
"nextTargetValue":false,
"forecastValue":false,
"baselineChange":true,
"currentTrend":true,
"varianceFromTarget":false,
"createDate": "2013-10-11T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-15T16:53:42.3208927-08:00",
"modifiedBy": "email@domain.org"
}

Update a Scorecard

URL

https://api.resultsscorecard.com/api/scorecards/update

XML Input

<Scorecard>
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>Changed score card desc</description>
<forecastValue>true</forecastValue>
<ID>16</ID>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<title>Changed Scorecard</title>
<parentScorecardId>5</parentScorecardId>
</Scorecard>

XML Output

<Scorecard xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<priorActualValue>true</priorActualValue>
<isScored>true</isScored>
<varianceFromTarget>true</varianceFromTarget>
<nextTargetValue>true</nextTargetValue>
<currentActualValue>true</currentActualValue>
<baselineChange>false</baselineChange>
<currentTrend>true</currentTrend>
<description>Changed score card desc</description>
<forecastValue>true</forecastValue>
<ID>16</ID>
<isEmbed>true</isEmbed>
<isShared>true</isShared>
<currentTargetValue>true</currentTargetValue>
<timePeriod>true</timePeriod>
<createDate>2013-11-15T16:47:07.14</createDate>
<createdBy>email@domain.org</createdBy>
<modifiedBy>0</modifiedBy>
<modifyDate>2013-11-15T16:52:04.370993-08:00</modifyDate>
<title>Changed Scorecard</title>
<parentScorecardId>5</parentScorecardId>
</Scorecard>

JSON Input

{
"siteCode": "abc",
"apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO",
"id":11,
"title":"Scorecard Title",
"description":"This is the description",
"parentScorecardId":5,
"isEmbed":false,
"isScored":false,
"timePeriod":true,
"priorActualValue":false,
"currentActualValue":true,
"currentTargetValue":false,
"nextTargetValue":false,
"forecastValue":false,
"baselineChange":true,
"currentTrend":true,
"varianceFromTarget":false
}

JSON Output

{
"id":11,
"title":"Scorecard Title",
"description":"This is the description",
"parentScorecardId":5,
"isEmbed":false,
"isScored":false,
"timePeriod":true,
"priorActualValue":false,
"currentActualValue":true,
"currentTargetValue":false,
"nextTargetValue":false,
"forecastValue":false,
"baselineChange":true,
"currentTrend":true,
"varianceFromTarget":false,
"createDate": "2013-10-11T00:00:00",
"createdBy": "email@domain.org",
"modifyDate": "2013-11-15T16:53:42.3208927-08:00",
"modifiedBy": "email@domain.org"
}

Delete a Scorecard

URL

https://api.resultsscorecard.com/api/scorecards/delete

XML Input

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

XML Output

Successfully deleted scorecard [id].

JSON Input

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

JSON Output

Successfully deleted scorecard [id].