Skip to main content

CSV Data Export Specifications

Access CSV exports of all activity on Knack's SFTP server

Luke Stevens avatar
Written by Luke Stevens
Updated over 12 months ago

Knack can generate and deliver CSV files containing all platform activity. This export must be turned on for your institution. Please contact your Knack Partner Success Manager to have this enabled.

CSV files will be delivered nightly to the outbox/exports/ directory on Knack's SFTP server for your organization. Files should be available by 5 AM eastern time.

Users

SFTP file path: outbox/exports/all-users.csv

File contains data for all users associated with the school. Values are updated nightly.

  • ID - Knack unique user ID

  • Full Name

  • First Name

  • Last Name

  • Student ID - school-provided student ID if available

  • Email

  • Phone - E.164 formatted phone number

  • Birth Date - YYYY-MM-DD formatted date

  • Gender - semi-colon separated list along with free-form value option if entered by user. Specific options include:

    • Man

    • Woman

    • Transgender

    • Non-binary/Non-confirming

    • Not Listed

    • No Response

  • Ethnicity - semi-colon separated list along with free-form value if entered by user. Specific options include:

    • Asian

    • Black/African American

    • Hispanic/Latino/Spanish origin

    • Middle Eastern/North African

    • Native American/Alaska Native

    • Native Hawaiian/Other Pacific Islander

    • White/Caucasian

    • Not Listed

    • No Response

  • Student Classification - one of:

    • First-year

    • Second-year

    • Junior

    • Senior

    • Postgraduate

    • Non-degree seeking

    • Not Listed

  • Student Attributes - semi-colon separated list of attributes about a student. Options include:

    • Pell Grant recipient

    • First-generation student

    • Transfer student

    • Student Veteran

    • Adult/Non-traditional (age 24+)

    • Commuter student

    • International student

    • On-campus resident

    • Off-campus resident away from family

    • Off-campus resident with family

  • Tutoring Service Usage - Student-indicated list of types of tutoring services utilized before using Knack. Semi-colon separated list along with free-form value if entered by user. Options include:

    • Peer tutor

    • Professional staff tutor

    • Faculty tutor

    • Private tutor outside school

    • Not Listed

    • No Resource

  • Tutor Status - current system status as a tutor. One of:

    • None - student account only, never registered as a tutor

    • Onboarded - completed initial tutor sign up but has not completed training or verified any courses

    • Active - active tutor with courses listed and approved for tutoring on their account

    • Inactive - no active courses listed or approved for tutoring

  • Tutor Registration Date

  • Requires Work Approval - boolean value indicating if user self-identified as needing approval to work in the U.S.

  • Last Seen - UTC datetime of when the user was last seen accessing any Knack web or mobile application

Tutor Requests

SFTP file path: outbox/exports/all-tutor-requests.csv

File contains data for all time and grows incrementally each night. Tutor Requests progress through a series of statuses. Values will change until a terminal status of Resolved or Closed is reached.

  • ID - Knack unique Tutor Request ID

  • Status - one of Open, Resolved or Closed

  • User ID - Knack unique User ID

  • User Full Name

  • User Student ID - school-provided student ID if available

  • Course ID - Knack unique course ID

  • Course School ID - school-provided unique course ID if available

  • Course Name

  • Course Number

  • Modality - In Person, Online or Any

  • Description

  • Notified Count - number of tutors notified

  • Response Count - number of tutors that responded

  • Created At - UTC datetime of Tutor Request creation

Sessions

SFTP file path: outbox/exports/all-sessions.csv

File contains data for all time and grows incrementally each night. Sessions progress through a series of statuses. Values will change until a terminal status of Completed, Canceled, Declined or Missed is reached.

  • ID - Knack unique Session ID

  • Status - one of Requested, Awaiting Tutor, Awaiting Student, Scheduled, Completed, Canceled, Declined, Missed

  • Recurring - boolean value if Session is part of a recurring series of Sessions

  • Recurring Series ID - Knack unique ID of recurring series that Session belongs to if recurring

  • Type - Scheduled or On Demand

  • Tutor ID - Knack unique tutor ID

  • Tutor Full Name

  • Tutor Student ID - school-provided student ID if available

  • Course ID - Knack unique course ID

  • Course School ID - school-provided unique course ID if available

  • Course Name

  • Course Number

  • Timezone - Tutor timezone. E.g. America/New_York

  • Start Time - UTC datetime

  • End Time - UTC datetime

  • Duration - in minutes

  • Online - boolean indicator of Online vs. In Person Session

  • Location Description

  • Title - user-specified title

  • Description - user-specified description

  • Recap - tutor populated recap written at the end of Session

  • Confidence in Tutoring Ability - 1-5 rating of tutor's confidence in ability to tutor the course.

    • 1 - Very Unconfident

    • 2 - Unconfident

    • 3 - Neutral

    • 4 - Confident

    • 5 - Very Confident

  • Confidence in Course Content - 1-5 rating of tutor's confidence in course content they tutored.

    • 1 - Very Unconfident

    • 2 - Unconfident

    • 3 - Neutral

    • 4 - Confident

    • 5 - Very Confident

  • Student Count - number of students in the Session

  • Cancelled By - one of Tutor or Student if canceled. None if not canceled

  • Cancellation Reason

  • Created At - UTC datetime of Session creation

Users Sessions

SFTP file path: outbox/exports/all-users-sessions.csv

Tutoring sessions can be 1-1 or group sessions with more than 1 student. This file contains 1 row for each student in a Session. Distinct Sessions can be identified with the Session ID.

File contains data for all time and grows incrementally each night. Sessions progress through a series of statuses. Values will change until a terminal status of Completed, Canceled, Declined or Missed is reached.

  • ID - Knack unique session student ID

  • Session ID - Knack unique Session ID

  • Session Status - one of Requested, Awaiting Tutor, Awaiting Student, Scheduled, Completed, Canceled, Declined, Missed

  • Recurring - boolean value if Session is part of a recurring series of Sessions

  • Recurring Series ID - Knack unique ID of recurring series that Session belongs to if recurring

  • Type - Scheduled or On Demand

  • Tutor ID - Knack unique tutor ID

  • Tutor Full Name

  • Tutor Student ID - school-provided student ID if available

  • Course ID - Knack unique course ID

  • Course School ID - school-provided unique course ID if available

  • Course Name

  • Course Number

  • User ID - Knack unique User ID

  • User Full Name

  • User Student ID - school-provided student ID

  • User Status - one of Invited, Accepted, Declined. Accepted status indicates the user actually attended the session.

  • Timezone - Tutor timezone. E.g. America/New_York

  • Start Time - UTC datetime

  • End Time - UTC datetime

  • Duration - in minutes

  • Online - boolean

  • Location Description

  • Title - user-specified title

  • Description - user-specified description

  • Recap - tutor populated recap at end of session

  • Confidence in Course Before - 1-5 rating of student's confidence in course before the session.

    • 1 - Very Unconfident

    • 2 - Unconfident

    • 3 - Neutral

    • 4 - Confident

    • 5 - Very Confident

  • Confidence in Course After - 1-5 rating of student's confidence in course after the session.

    • 1 - Very Unconfident

    • 2 - Unconfident

    • 3 - Neutral

    • 4 - Confident

    • 5 - Very Confident

  • Cancelled By - one of Tutor or Student if canceled. None if not canceled

  • Cancellation Reason

  • Created At - UTC datetime of Session creation

Please click here for more information about accessing and using this data.

Did this answer your question?