Report to see who all has set pronouns

[rmurchshafer]

With the addition of personal pronouns I am curious to see how many people set them in our instance of Canvas.  Has anyone found a report or other method to see if pronouns have been selected for individuals?  I've tried the Provisioning and SIS Export report for Users but it's not contained in either. 

TIA,

Rick

[James]

 @rmurchshafer  

One way to get the list is to fetch a list of all of your users.

This can be done in batches by fetching course enrollments. If you're lucky enough to have all of your students enrolled in a single course (we have a student resource course like this), then you can get them all at once.

If the user has set the pronouns, then there will be a pronouns property in the object. If not, then pronouns will be missing.

There's a GraphQL query that could do this as well, but it timed out on me when I tried to do it for the entire account. (replace 12345 with your root account as "self" does not work). You'll still have to do processing on the back end to get the distinct count. Pronouns will come back as null if there are none.

query listAllEnrollments {
  account(id: "12345") {
    coursesConnection(first: 10) {
      nodes {
        _id
        name
        usersConnection {
          nodes {
            _id
            sortableName
            pronouns
          }
        }
      }
      pageInfo {
        endCursor
        hasNextPage
        hasPreviousPage
        startCursor
      }
    }
  }
}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

You will definitely need to use pagination. It timed out on me when I tried it without the pagination.

Even if you want to do it on a course-by-course basis, rather than all courses within an account, it's faster to use GraphQL.

query listAllEnrollments {
  course(id: "2687822") {
    _id
    usersConnection {
      nodes {
        _id
        sortableName
        pronouns
      }
    }
  }
}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

This GraphQL query for a single course took a 0.5 seconds for my 49 enrollments. The REST API call for the same course using a per_page=100 to make sure I got all of the students took 2.5 seconds (I was testing in beta in both cases).

[James]

Note that the account query won't work in production yet as those properties are only available in beta for right now. It appears from the https://community.canvaslms.com/docs/DOC-18145-graphql-api-change-log that it will be January 29, 2020, when it becomes available in production.

[mzimmerman]

Hi James,

We don't routinely use GraphQL for queries here, but it does look like the Users API is now returning pronoun information if the user has set it, in production as well as beta.  So you could use

GET /api/v1/accounts/:account_id/users

to grab all the users, though it looks like pagination is limiting us to only grabbing 100 at a time or so.  It might be necessary to iterate through them individually using

GET /api/v1/users/:id

Mike

[rmurchshafer]

Thanks James; this is useful.  

Rick