Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
period integer

ID of the period.

id globally unique identifier

Body Parameters

None.

Response Information

Resource Description (Dashboard)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier ReadOnly

ID of the given dashboard.

SiteID globally unique identifier ReadOnly

ID of the site for the given dashboard.

RowType integer ReadOnly

Row type of the organization(4), department(56), or individual(39) for the given dashboard.

Name string ReadOnly

Name of the given dashboard.

FromDate date ReadOnly

Start date of the given dashboard.

ToDate date ReadOnly

End date of the given dashboard.

OrganizationCommitmentsCompleted integer ReadOnly

Sum of completed commitments for the given organization.

OrganizationCommitmentsTotal integer ReadOnly

Sum of the commitments for the given organization.

OrganizationCommitmentsColorValue integer ReadOnly

Color of the commitments for the given organization.

DepartmentCommitmentsCompleted integer ReadOnly

Sum of completed commitments for the given department.

DepartmentCommitmentsTotal integer ReadOnly

Sum of the commitments for the given department.

DepartmentCommitmentsColorValue integer ReadOnly

Color of the commitments for the given department.

IndividualCommitmentsCompleted integer ReadOnly

Sum of completed commitments for the given individual.

IndividualCommitmentsTotal integer ReadOnly

Sum of the commitments for the given individual.

IndividualCommitmentsColorValue integer ReadOnly

Color of the commitments for the given individual.

MetricsExceedsPercent decimal number ReadOnly

Percentage of metrics that exceed expectations

MetricsMeetsPercent decimal number ReadOnly

Percentage of metrics that meet expectations

MetricsMinimumPercent decimal number ReadOnly

Percentage of metrics that meet minimum expectations

MetricsBelowPercent decimal number ReadOnly

Percentage of metrics that are below expectations.

Metrics8020Percent decimal number ReadOnly

Percent of 80/20 metrics that meets excpectations.

Metrics8020CompositePercent decimal number ReadOnly

Rollup of the department 80/20 metric percentages.

ProjectsActive integer ReadOnly

Number of projects that are active.

ProjectsOnTime integer ReadOnly

Number of projects that are on time.

ProjectsCompleted integer ReadOnly

Number of projects that are completed.

ProjectsDateChanges integer ReadOnly

Number of times the date has changed for a project

DeptProjectsActive integer ReadOnly

Number of active projects for a given department.

DeptProjectsOnTime integer ReadOnly

Number of on time projects for a given department.

DeptProjectsCompleted integer ReadOnly

Number of completed projects for a department.

DeptProjectsDateChanges integer ReadOnly

Number of times the date has changed for projects in a department.

EvaluationCriteriaPercent decimal number ReadOnly

Percentage score for evaluation criteria.

LeaderAssessmentPercent decimal number ReadOnly

Percentage score for the leader assessment.

TeamAssessmentPercent decimal number ReadOnly

Percentage score for team assessment.

DialogsCompletedPercent decimal number ReadOnly

Percentage of dialogs completed.

FollowUpsCompletedPercent decimal number ReadOnly

Percentage of follow ups completed.

PersonalGoalsCompleted integer ReadOnly

Number of personal goals completed.

PersonalGoalsTotal integer ReadOnly

Total number of personal goals.

OrgDialogsExpected integer ReadOnly

Number of organization dialogs expected.

OrgDialogsOccurred integer ReadOnly

Number of organization dialogs that actually occurred.

DeptDialogsExpected integer ReadOnly

Number of department dialogs expected.

DeptDialogsOccurred integer ReadOnly

Number of department dialogs that actually occurred.

ProjDialogsExpected integer ReadOnly

Number of Project Dialogs Expected.

ProjDialogsOccurred integer ReadOnly

Number of Project Dialogs that actually Occurred.

IndDialogsExpected integer ReadOnly

Number of individual dialogs expected.

IndDialogsOccurred integer ReadOnly

Number of individual dialogs that actually occurred.

OrgFollowUpsCreated integer ReadOnly

Number of organization follow ups created.

OrgFollowUpsCompleted integer ReadOnly

Number of organization follow ups that were completed.

DeptFollowUpsCreated integer ReadOnly

Number of department follow ups created.

DeptFollowUpsCompleted integer ReadOnly

Number of department follow ups that were completed.

ProjFollowUpsCreated integer ReadOnly

Number of project follow ups created.

ProjFollowUpsCompleted integer ReadOnly

Number of project follow ups that were completed.

IndFollowUpsCreated integer ReadOnly

Number of individual follow ups created

IndFollowUpsCompleted integer ReadOnly

Number of individual follow ups that were completed.

IndividualPerformancePercent decimal number ReadOnly

Percent of performance indicators an individual has completed.

IndividualCoreValuesPercent decimal number ReadOnly

Percent of core values an individual has completed.

IndividualBasicRolePercent decimal number ReadOnly

Percent of basic roles an individual has completed.

Threshold1 integer Required

Minimum threshold for metrics.

Threshold2 integer Required

Meets threshold for metrics.

Threshold3 integer Required

Exceeds threshold for metrics.

ShowMetrics boolean Required

Setting to show metric data for the given site.

ShowDialogs boolean Required

Setting to show dialog data for the given site.

ShowFollowUps boolean Required

Setting to show follow up data for the given site.

ShowProjectLoad boolean Required

Setting to show project load data for the given site.

ShowEvaluationCriteria boolean Required

Setting to show evaluation criteria data for the given site.

ShowLeaderAssessment boolean Required

Setting to show leader assessment data for the given site.

ShowTeamAssessment boolean Required

Setting to show team assessment data for the given site.

ShowGoals boolean Required

Setting to show goals data for the given site.

ShowOrgCommitments boolean Required

Setting to show organization commitments data for the given site.

ShowDeptCommitments boolean Required

Setting to show department commitments data for the given site.

ShowIndCommitments boolean Required

Setting to show individual commitments data for the given site.

Show8020Metrics boolean Required

Setting to show 8020 metric data for the given site.

Response Formats

application/xml, text/xml

Sample
<Dashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <Threshold1>1</Threshold1>
  <Threshold2>1</Threshold2>
  <Threshold3>1</Threshold3>
  <ShowMetrics>true</ShowMetrics>
  <ShowDialogs>true</ShowDialogs>
  <ShowFollowUps>true</ShowFollowUps>
  <ShowProjectLoad>true</ShowProjectLoad>
  <ShowEvaluationCriteria>true</ShowEvaluationCriteria>
  <ShowLeaderAssessment>true</ShowLeaderAssessment>
  <ShowTeamAssessment>true</ShowTeamAssessment>
  <ShowGoals>true</ShowGoals>
  <ShowOrgCommitments>true</ShowOrgCommitments>
  <ShowDeptCommitments>true</ShowDeptCommitments>
  <ShowIndCommitments>true</ShowIndCommitments>
  <Show8020Metrics>true</Show8020Metrics>
  <DepartmentCommitmentsColorValue>1</DepartmentCommitmentsColorValue>
  <DepartmentCommitmentsCompleted>1</DepartmentCommitmentsCompleted>
  <DepartmentCommitmentsTotal>1</DepartmentCommitmentsTotal>
  <DeptDialogsExpected>1</DeptDialogsExpected>
  <DeptDialogsOccurred>1</DeptDialogsOccurred>
  <DeptFollowUpsCompleted>1</DeptFollowUpsCompleted>
  <DeptFollowUpsCreated>1</DeptFollowUpsCreated>
  <DeptProjectsActive>1</DeptProjectsActive>
  <DeptProjectsCompleted>1</DeptProjectsCompleted>
  <DeptProjectsDateChanges>1</DeptProjectsDateChanges>
  <DeptProjectsOnTime>1</DeptProjectsOnTime>
  <DialogsCompletedPercent>1</DialogsCompletedPercent>
  <EvaluationCriteriaPercent>1</EvaluationCriteriaPercent>
  <FollowUpsCompletedPercent>1</FollowUpsCompletedPercent>
  <FromDate>2021-11-03T18:48:30.4634573+00:00</FromDate>
  <ID>4ee9a116-1b46-4677-8751-13cde7faaea8</ID>
  <IndDialogsExpected>1</IndDialogsExpected>
  <IndDialogsOccurred>1</IndDialogsOccurred>
  <IndFollowUpsCompleted>1</IndFollowUpsCompleted>
  <IndFollowUpsCreated>1</IndFollowUpsCreated>
  <IndividualBasicRolePercent>1</IndividualBasicRolePercent>
  <IndividualCommitmentsColorValue>1</IndividualCommitmentsColorValue>
  <IndividualCommitmentsCompleted>1</IndividualCommitmentsCompleted>
  <IndividualCommitmentsTotal>1</IndividualCommitmentsTotal>
  <IndividualCoreValuesPercent>1</IndividualCoreValuesPercent>
  <IndividualPerformancePercent>1</IndividualPerformancePercent>
  <LeaderAssessmentPercent>1</LeaderAssessmentPercent>
  <Metrics8020CompositePercent>1</Metrics8020CompositePercent>
  <Metrics8020Percent>1</Metrics8020Percent>
  <MetricsBelowPercent>1</MetricsBelowPercent>
  <MetricsExceedsPercent>1</MetricsExceedsPercent>
  <MetricsMeetsPercent>1</MetricsMeetsPercent>
  <MetricsMinimumPercent>1</MetricsMinimumPercent>
  <Name>sample string 1</Name>
  <OrgDialogsExpected>1</OrgDialogsExpected>
  <OrgDialogsOccurred>1</OrgDialogsOccurred>
  <OrgFollowUpsCompleted>1</OrgFollowUpsCompleted>
  <OrgFollowUpsCreated>1</OrgFollowUpsCreated>
  <OrganizationCommitmentsColorValue>1</OrganizationCommitmentsColorValue>
  <OrganizationCommitmentsCompleted>1</OrganizationCommitmentsCompleted>
  <OrganizationCommitmentsTotal>1</OrganizationCommitmentsTotal>
  <PersonalGoalsCompleted>1</PersonalGoalsCompleted>
  <PersonalGoalsTotal>1</PersonalGoalsTotal>
  <ProjDialogsExpected>1</ProjDialogsExpected>
  <ProjDialogsOccurred>1</ProjDialogsOccurred>
  <ProjFollowUpsCompleted>1</ProjFollowUpsCompleted>
  <ProjFollowUpsCreated>1</ProjFollowUpsCreated>
  <ProjectsActive>1</ProjectsActive>
  <ProjectsCompleted>1</ProjectsCompleted>
  <ProjectsDateChanges>1</ProjectsDateChanges>
  <ProjectsOnTime>1</ProjectsOnTime>
  <RowType>1</RowType>
  <SiteID>87ca1758-b87c-4406-a45d-b7ccb0972206</SiteID>
  <TeamAssessmentPercent>1</TeamAssessmentPercent>
  <ToDate>2021-11-03T18:48:30.4634573+00:00</ToDate>
</Dashboard>

application/json, text/json

Sample
{
  "ID": "4ee9a116-1b46-4677-8751-13cde7faaea8",
  "SiteID": "87ca1758-b87c-4406-a45d-b7ccb0972206",
  "RowType": 1,
  "Name": "sample string 1",
  "FromDate": "2021-11-03T18:48:30.4634573+00:00",
  "ToDate": "2021-11-03T18:48:30.4634573+00:00",
  "OrganizationCommitmentsCompleted": 1,
  "OrganizationCommitmentsTotal": 1,
  "OrganizationCommitmentsColorValue": 1,
  "DepartmentCommitmentsCompleted": 1,
  "DepartmentCommitmentsTotal": 1,
  "DepartmentCommitmentsColorValue": 1,
  "IndividualCommitmentsCompleted": 1,
  "IndividualCommitmentsTotal": 1,
  "IndividualCommitmentsColorValue": 1,
  "MetricsExceedsPercent": 1.0,
  "MetricsMeetsPercent": 1.0,
  "MetricsMinimumPercent": 1.0,
  "MetricsBelowPercent": 1.0,
  "Metrics8020Percent": 1.0,
  "Metrics8020CompositePercent": 1.0,
  "ProjectsActive": 1,
  "ProjectsOnTime": 1,
  "ProjectsCompleted": 1,
  "ProjectsDateChanges": 1,
  "DeptProjectsActive": 1,
  "DeptProjectsOnTime": 1,
  "DeptProjectsCompleted": 1,
  "DeptProjectsDateChanges": 1,
  "EvaluationCriteriaPercent": 1.0,
  "LeaderAssessmentPercent": 1.0,
  "TeamAssessmentPercent": 1.0,
  "DialogsCompletedPercent": 1.0,
  "FollowUpsCompletedPercent": 1.0,
  "PersonalGoalsCompleted": 1,
  "PersonalGoalsTotal": 1,
  "OrgDialogsExpected": 1,
  "OrgDialogsOccurred": 1,
  "DeptDialogsExpected": 1,
  "DeptDialogsOccurred": 1,
  "ProjDialogsExpected": 1,
  "ProjDialogsOccurred": 1,
  "IndDialogsExpected": 1,
  "IndDialogsOccurred": 1,
  "OrgFollowUpsCreated": 1,
  "OrgFollowUpsCompleted": 1,
  "DeptFollowUpsCreated": 1,
  "DeptFollowUpsCompleted": 1,
  "ProjFollowUpsCreated": 1,
  "ProjFollowUpsCompleted": 1,
  "IndFollowUpsCreated": 1,
  "IndFollowUpsCompleted": 1,
  "IndividualPerformancePercent": 1.0,
  "IndividualCoreValuesPercent": 1.0,
  "IndividualBasicRolePercent": 1.0,
  "Threshold1": 1,
  "Threshold2": 1,
  "Threshold3": 1,
  "ShowMetrics": true,
  "ShowDialogs": true,
  "ShowFollowUps": true,
  "ShowProjectLoad": true,
  "ShowEvaluationCriteria": true,
  "ShowLeaderAssessment": true,
  "ShowTeamAssessment": true,
  "ShowGoals": true,
  "ShowOrgCommitments": true,
  "ShowDeptCommitments": true,
  "ShowIndCommitments": true,
  "Show8020Metrics": true
}