API
      Back to home
      1. Help Center
      2. Scorecard Documentation
      3. API

      API: Scorecards

      The API enables the following interactions with scorecards:

      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

      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

      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

      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

      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

      JSON Input

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

      JSON Output

      Successfully deleted scorecard [id].