GET api/v1/SustainabilityIndex/Teams/{teamID}

Gets the Sustainability Index for a team for the given date range. The default start date starts seven (7) weeks before the most recent Sunday and goes six (6) weeks from there.

Request Information

URI Parameters

Name	Description	Type	Additional information
teamID	The ID of the team you want	globally unique identifier	Required
startDate	The start date. If null it will use the default start date. The format needs to be YYYY-MM-DD	date	None.
endDate	The end date. If null it will use the default end date. The format needs to be YYYY-MM-DD	date	None.
fields	Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.	Collection of string	None.
suppressResponseCodes	Some applications do wonky things if error codes are used. Use this to force 200s to always return.	boolean	None.
APIKey	This is your unique key that identifies you as the developer of this app. Required for all calls.	string	None.
APIToken	This is the user's session token generated when you authenticate the user	string	None.

Body Parameters

None.

Response Information

Resource Description

TeamSustainabilityIndexModelInfo

Name	Description	Type	Additional information
TeamID	The ID of the Team this data belongs to	globally unique identifier	None.
IndividualScore	The score for just this team over the date range	SICalculationData	None.
ScoreWithChildren	The score of this team rolled up with any children teams over the date range	SICalculationData	None.

Response Formats

application/json, text/json

Sample:

{
  "TeamID": "9a4c9dcf-405e-4731-9672-6f17316e0b92",
  "IndividualScore": {
    "StartDate": "2024-05-19T11:02:05.4520394-04:00",
    "EndDate": "2024-05-19T11:02:05.4520394-04:00",
    "NumberOfUsersExecuting": 3.0,
    "NumberOfUsersThatShouldBeExecuting": 4.0,
    "NumberOfSessionsHeld": 5.0,
    "NumberOfSessionsThatCouldBeHeld": 6.0,
    "NumberOfCommitmentsKept": 7.0,
    "NumberOfCommitments": 8.0
  },
  "ScoreWithChildren": {
    "StartDate": "2024-05-19T11:02:05.4520394-04:00",
    "EndDate": "2024-05-19T11:02:05.4520394-04:00",
    "NumberOfUsersExecuting": 3.0,
    "NumberOfUsersThatShouldBeExecuting": 4.0,
    "NumberOfSessionsHeld": 5.0,
    "NumberOfSessionsThatCouldBeHeld": 6.0,
    "NumberOfCommitmentsKept": 7.0,
    "NumberOfCommitments": 8.0
  }
}