Data Warehouse: On Demand Exports

On Demand Exports

This export type will pull data on demand and allows you to choose a custom date range for data from either current or previous school years.

To download the data set for a specific date range, use the following URL:

https://{yourSubDomain}.kickboardforschools.com/export/custom/file/{exportType}/key/{yourSecurityKey}/start_date/{startDate}/end_date/{endDate}/active_schools/{activeSchoolsFlag}

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 five export types that support the custom date range option. Replace the {exportType} parameter with one of the following values:

Value	Description
behavior	Export logged student behavior events for the specified date range.
conroster	Export consequence rosters  for the specified date range.
growth	Export student academic growth scores for all assessments in growth courses  for the specified date range.
mastery	Export mastery scores for all assessments in mastery courses for the specified date range.
points	Export weekly and yearly behavior point totals  for the specified date range.
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.

{startDate}

Enter the first date/time for which you want to export data, in the format yyyy-mm-dd%20hh:mm:ss. The resulting file will include all data from the specified date and time through the current time, or through the endDate (if specified).

{endDate}

(optional)

Enter the final date/time for which you want to export data, in the format yyyy-mm-dd%20hh:mm:ss. The resulting file will include all data from the specified start date and time through the end date and time.

{activeSchoolsFlag}

(optional)

The acceptable values for this parameter are 1 or 0. A value of 1 will limit the data exports to only currently active schools. A value of 0 will export all school data, regardless of the school's activity status.

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.