Data Warehouse: Export File Formats

Export File Formats

Kickboard export files are CSV files, with the following characteristics:

  • Files contain a header row.

  • Each new record is indicated by a new line.

  • Each field is surrounded by double quotes and separated by a comma.

  • If the text of a field contains a double quote, it is escaped by another double quote (i.e. “This is a comment which contains a “”quote””, and that quote is escaped.”

 

The fields for each export file are detailed below.

Behavior Exports

The following fields are included for all behavior events in the current school year, with the fields appearing in the export file in the same order as below.

 

Field

Data Type

Description

student id

integer

Kickboard’s unique identifier for the student.

external id

string

The unique identifier that you have specified for the student, likely associated with your Student Information System.

last name

string

The student’s last name.

first name

string

The student’s first name.

group id

integer

Kickboard’s unique identifier for the student’s Default Group.

group name

string

The name of the student’s Default Group.

behavior id

integer

Kickboard’s unique id for the behavior.

behavior

string

The name of the behavior.

category

string

The category of the behavior.

comments

string

The comments entered with the behavior, if applicable.

merit points

float

The point value of the behavior, if applicable.

dollar points

float

The dollar value of the behavior, if applicable.

date

date

The date that the behavior event was entered, in mm/dd/yyyy format.


Note that if your configuration allows behavior entry for past dates, this date will be the date for which the behavior was logged, not necessarily the date that the logging occurred.

timestamp

datetime

The date and time that the behavior event was entered, in yyyy-mm-dd hh:mm:ss format.

staff id

integer

Kickboard’s unique identifier for the staff member who entered the behavior event.

staff last name

string

The last name of the staff who entered the behavior event.

staff first name

string

The first name of the staff who entered the behavior event.

school id

integer

Kickboard’s unique identifier for the school that the student was enrolled in when the behavior event was logged.

school name

string

The name of the school that the student was enrolled in when the behavior event was logged.

daily activity group id

integer

Kickboard’s unique identifier for the group that was being viewed in Daily Activity when the behavior event was logged.

daily activity group name

string

The name of the group that was being viewed in Daily Activity when the behavior event was logged.

bank purchase

integer

A flag for whether or not the behavior is a bank transaction.


Bank transaction = 1

Regular behavior = 0

incident id

integer

Kickboard’s unique identifier for the behavior event.

 

Consequence Roster Exports

The following fields are included for all students that were assigned to consequence rosters in the current school year, with the fields appearing in the export file in the same order as below.

 

Field

Data Type

Description

school name

string

The name of the school the student was enrolled in when they were assigned to the consequence roster.

student id

integer

Kickboard’s unique identifier for the student.

external id

string

The unique identifier that you have specified for the student, likely associated with your Student Information System.

last name

string

The student’s last name.

first name

string

The student’s first name.

grade

string

The grade level of the student.


PK, K, 1st, 2nd, 3rd, 4th, 5th, 6th, 7th, 8th, 9th, 10th, 11th, or 12th.

group id

integer

Kickboard’s unique identifier for the student’s Default Group.

group name

string

The name of the student’s Default Group.

phone

string

The student’s phone number.

consequence id

integer

Kickboard’s unique identifier for the consequence that was assigned.

consequence type

string

The type of consequence that was assigned.


Continuous, hourly, or fixed day.

consequence name

string

The name of the consequence that was assigned

assigned date

date

The date of the consequence, in yyyy-mm-dd format.

reasons

string

The reason entered, or generated by the system, for why the consequence was assigned.

hours assigned

integer

The number of hours assigned to the consequence event. (Only applicable to hourly consequences)

staff id

integer

Kickboard’s unique identifier for the staff member who assigned the consequence, or entered the behavior that triggered the consequence assignment.

staff name

string

The name of the staff member who assigned the consequence, or entered the behavior that triggered the consequence assignment, in FirstName LastName format.

school id

integer

Kickboard’s unique identifier for the school that the student was enrolled in at the time the consequence was assigned.

attendance

integer

A flag for whether or not the student was marked as Present for the consequence. (Only applicable to Fixed Day consequences)


Present = 1

Absent = 0

external school id

integer

The unique identifier that you have specified for the school, likely associated with your Student Information System.

 

Group Exports

The following fields are included for all students assigned to groups in the current school year, with the fields appearing in the export file in the same order as below. Each group that a student is assigned to will be listed in its own row.

 

Field

Data Type

Description

School Name

string

The name of the school that the student is currently assigned to.

External School ID

integer

The unique identifier that you have specified for the school, likely associated with your Student Information System.

KB School ID

integer

Kickboard’s unique identifier for the school that the student is currently enrolled in.

KB Student ID

integer

Kickboard’s unique identifier for the student.

Student External ID

string

The unique identifier that you have specified for the student, likely associated with your Student Information System.

Last Name

string

The student’s last name.

First Name

string

The student’s first name.

Student Grade

string

The grade level of the student.


PK, K, 1st, 2nd, 3rd, 4th, 5th, 6th, 7th, 8th, 9th, 10th, 11th, or 12th.

KB Group ID

integer

Kickboard’s unique identifier for the group to which the student is assigned.

External Group ID

integer

The unique identifier that you have specified for the group, likely associated with your Student Information System.

Group Name

string

The name of the group to which the student is assigned.

 

Growth Course Exports

The following fields are included for all student growth scores for all assessments in growth courses in the current school year, with the fields appearing in the export file in the same order as below.

 

Field

Data Type

Description

student id

integer

Kickboard’s unique identifier for the student.

external id

string

The unique identifier that you have specified for the student, likely associated with your Student Information System.

last name

string

The student’s last name.

first name

string

The student’s first name.

group id

integer

Kickboard’s unique identifier for the student’s Default Group.

group name

string

The name of the student’s Default Group.

course id

integer

Kickboard’s unique identifier for the course.

grade

string

The grade level of the course the assessment belongs to.


PK, K, 1st, 2nd, 3rd, 4th, 5th, 6th, 7th, 8th, 9th, 10th, 11th, or 12th.

subject

string

The subject of the course the assessment belongs to (i.e. Math, ELA, etc. -- dependent upon your configuration)

assessment id

integer

Kickboard’s unique identifier for the assessment.

assessment name

string

The name of the assessment.

active

integer

A flag for whether the assessment is active or inactive.


Active = 1

Inactive = 0

growth level

string

The student’s growth level (score) entered in the assessment.

growth level gle

integer

The student’s Grade Level Equivalency for the growth level entered in the assessment.

date

date

The date assigned to the assessment, in mm/dd/yyyy format.



Mastery Exports

The following fields are included for all standard mastery scores in all assessments in the current school year, with the fields appearing in the export file in the same order as below. If an assessment included multiple standards, each standard will be represented in its own row.

 

Field

Data Type

Description

student id

integer

Kickboard’s unique identifier for the student.

external id

string

The unique identifier that you have specified for the student, likely associated with your Student Information System.

last name

string

The student’s last name.

first name

string

The student’s first name.

group id

integer

Kickboard’s unique identifier for the student’s Default Group.

group name

string

The name of the student’s Default Group.

course id

integer

Kickboard’s unique identifier for the course the assessment belongs to.

grade

string

The grade level of the course the assessment belongs to.


PK, K, 1st, 2nd, 3rd, 4th, 5th, 6th, 7th, 8th, 9th, 10th, 11th, or 12th.

subject

string

The subject of the course the assessment belongs to (i.e. Math, ELA, etc. -- dependent upon your configuration)

assessment id

integer

Kickboard’s unique identifier for the assessment.

assessment name

string

The name of the assessment.

assessment type

string

The category of the assessment (i.e. Homework, Quiz, Exit Ticket, etc.)

active

integer

A flag for whether the assessment is active or inactive.


Active = 1

Inactive = 0

GLE

string

The skill that was assessed.

Aim

string

The subskill that was assessed (if applicable).

point possible

float

The number of points possible for the skill in the assessment.

points earned

float

The number of points the student earned for the skill in the assessment.

score

integer

The skill mastery for the student for the assessment, represented as a percentage.

date

date

The date assigned to the assessment, in mm/dd/yyyy format.

counts in final grade

integer

A flag for whether the assessment counts toward the student’s grade or does not count toward the student’s grade.


Counts = 1

Does not count = 0

 

Points Exports

The following fields are included for each week in the current school year, with the fields appearing in the export file in the same order as below. This export is most useful when gathered daily or weekly, on the last day of your culture period.

 

Field

Data Type

Description

student id

integer

Kickboard’s unique identifier for the student.

external id

string

The unique identifier that you have specified for the student, likely associated with your Student Information System.

last name

string

The student’s last name.

first name

string

The student’s first name.

school name

string

The name of the school the student was enrolled in during that week.

group name

string

The name of the student’s Default Group.

grade level

string

The grade level of the student.


PK, K, 1st, 2nd, 3rd, 4th, 5th, 6th, 7th, 8th, 9th, 10th, 11th, or 12th.

week of

date

The start date of the week that the totals are for, in mm-dd-yyyy format.

weekly dollar points

float

The dollar total for the week.

weekly merit points

float

The point total for the week.

yearly dollar points

float

The dollar total for the entire school year, up to the current date.

yearly merit points

float

The merit total for the entire school year, up to the current date.

 

Staff Exports

The following fields are included for staff member for the current school year, with the fields appearing in the export file in the same order as below.

 

Field

Data Type

Description

staff id

integer

Kickboard’s unique identifier for the staff member.

last name

string

The staff member’s last name.

first name

string

The staff member’s first name.

active

integer

A flag for whether or not the staff member’s Kickboard account is active.


Active = 1

Inactive = 0

role

string

The staff member’s account role in Kickboard.


Teacher, School Admin, or Kickboard Admin.

teaching assignments

string

A comma separated list of all courses the staff member is assigned to.

school ids

string

A comma separated list of the Kickboard unique identifiers for all schools that the staff member is assigned to.

schools

string

A comma separated list of all schools that the staff member is assigned to.

 

Student Exports

The following fields are included for all students for the current school year, with the fields appearing in the export file in the same order as below.

 

Field

Data Type

Description

student id

integer

Kickboard’s unique identifier for the student.

external id

string

The unique identifier you have specified for the student likely associated with your Student Information System (SIS).

last name

string

The student’s last name.

first name

string

The student’s first name.

active

integer

A flag for whether or not the student record is active in Kickboard.


Active = 1

Inactive = 0

grade

string

The grade level of the student:


PK, K, 1st, 2nd, 3rd, 4th, 5th, 6th, 7th, 8th, 9th, 10th, 11th or 12th.

school name

string

The name of the school the student attends

group id

integer

Kickboard’s unique identifier for the student’s Default Group.

group name

string

The name of the student’s Default Group.

parent access

string

The access code for the student’s Parent Student Portal account.

birth date

date

The student’s birth date in yyyy-mm-dd format.

custom fields

 

Any active custom fields are added, one column per field, to the file.  


Note that activating a custom field on any school on your Kickboard site causes that field to be added to this export file.

 

Have more questions? Submit a request
Powered by Zendesk