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:
|
||||||||||||||||
{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. |
Comments
0 comments
Article is closed for comments.