POST api/v2.0/Mentoring/GetDemographicSummary

Returns, for each value in a configured MentorMatch demographic category, the count of active mentors or mentees who chose it. Can only be accessed by an Admin user.

Request Information

URI Parameters

None.

Body Parameters

DemographicTypeName: configured MentorMatch category name (case-insensitive), Role: "mentor" or "mentee".

MentoringDemographicSummaryRequest

Name	Description	Type	Additional information
DemographicTypeName	Configured MentorMatch demographic category name (case-insensitive). Free-form categories are not currently supported.	string	None.
Role	Participant role: "mentor" or "mentee".	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DemographicTypeName": "Industry",
  "Role": "mentor"
}

application/xml, text/xml

Sample:

<MentoringDemographicSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Mentoring">
  <DemographicTypeName>sample string 1</DemographicTypeName>
  <Role>sample string 2</Role>
</MentoringDemographicSummaryRequest>

Response Information

Resource Description

Demographic summary grouped by value within the requested MentorMatch category, each with its count. Use GetParticipantsByDemographicValue to page through the participant list for a specific value.

MentoringDemographicSummaryResponse

Name	Description	Type	Additional information
DemographicTypeKey	Resolved MentorMatch demographic category key.	globally unique identifier	None.
DemographicTypeName	Resolved MentorMatch demographic category name.	string	None.
Role	Role this summary applies to: "mentor" or "mentee".	string	None.
Values	Count by demographic value within the category, scoped to active mentor/mentee profiles. If the category allows multiple selections, a single participant can be counted under more than one value, so these counts will not sum to the number of participants who answered this category.	Collection of DemographicValueSummary	None.

Response Formats

application/json, text/json

Sample:

{
  "DemographicTypeKey": "b1e2c3d4-1234-5678-9abc-def012345678",
  "DemographicTypeName": "Industry",
  "Role": "mentor",
  "Values": [
    {
      "ValueName": "Technology",
      "Count": 2
    },
    {
      "ValueName": "Healthcare",
      "Count": 1
    }
  ]
}

application/xml, text/xml

Sample:

<MentoringDemographicSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Mentoring">
  <DemographicTypeKey>931f1395-4c70-4007-92c1-4d4e9ab6f11f</DemographicTypeKey>
  <DemographicTypeName>sample string 2</DemographicTypeName>
  <Role>sample string 3</Role>
  <Values>
    <DemographicValueSummary>
      <Count>2</Count>
      <ValueName>sample string 1</ValueName>
    </DemographicValueSummary>
    <DemographicValueSummary>
      <Count>2</Count>
      <ValueName>sample string 1</ValueName>
    </DemographicValueSummary>
  </Values>
</MentoringDemographicSummaryResponse>