CSV Data Export Specifications

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.

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
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.

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
Cancelled By - one of Tutor or Student if canceled. None if not canceled
Cancellation Reason
Created At - UTC datetime of Session creation