Data Warehouse: Pre-Generated Data Exports

Pre-Generated Data Exports

Pre-generated files include raw data for the past 30 days only. This applies to the behavior, conroster, attendance, mastery, and growth file types. The driving factor in limiting the data set in pre-generated files is to allow the files to generate quickly enough to be available for immediate download with no wait for preparation.

 

To download a pre-generated file the data set for the past 30 days, use the following URL:

 

https://{yourSubDomain}.kickboardforschools.com/export/download/file/{exportType}/key/{yourSecurityKey}

 

URL Parameter

Description

{yourSubDomain}

Enter the first part of your Kickboard site address here. For example, if your Kickboard site address is https://mySchool.kickboardforschools.com then your sub domain is “mySchool”.

{exportType}

Kickboard offers seven export types. Replace the {exportType} parameter with one of the following values:


Value

Description

behavior

Export logged student behavior events for the past 30 days of the current school year.

conroster

Export consequence rosters for the past 30 days of the current school year.

group

Export all student group assignments for the current school year.

growth

Export student academic growth scores for all assessments in growth courses for the past 30 days of the current school year.

mastery

Export mastery scores for all assessments in mastery courses for the past 30 days of the current school year.

points

Export weekly and yearly behavior point totals for the past 30 days of the current school year.

staff

Export staff for the current school year.

student

Export students for the current school year.

{yourSecurityKey}

Enter the unique security key provided to you by the Kickboard Product Support Team.



NOTE

The pre-generated export option will offer you the fastest download time, as export files are pre-built every two hours and your request will simply download the most recent export file.



CAUTION

Your security key is an all-access key to your data. Guard it with extreme care and keep it on a need-to-know basis within your organization, as anyone who has the key will be able to download your sensitive student data.


Our policy is to never give third parties your security key, so if you are working with a third party to integrate Kickboard data into another system, we will provide you with the security key and these instructions and you will be responsible for passing the key along to authorized personnel.

Have more questions? Submit a request
Powered by Zendesk