Export form element submissions
FormElementSubmission
Export form element submissions
Export form element submissions data to various formats for analysis and reporting.
Export Features:
- Bulk data export for multiple form elements and submissions
- Support for various export formats (CSV, Excel, etc.)
- Flexible filtering by date ranges, sites, and form criteria
- Structured data output suitable for external analysis tools
TIMESTAMP support:
- Includes a
recordedAtcolumn. For TIMESTAMP elements, one row is emitted per entry withrecordedAtset. For other elements,recordedAtis empty. - No placeholders are generated for TIMESTAMP elements, even when
includeEmptyRows=true.
Example request:
{
"formIds": ["form-123"],
"siteIds": ["site-1"],
"years": [2024],
"format": "csv",
"includeFormName": true
}
Example CSV rows (trimmed):
siteName,year,key,periodUnit,value,recordedAt
plant-a,2024,water_usage,3,120.5,2024-03-15T10:30:00Z
This endpoint is ideal for generating reports, conducting data analysis, or migrating data to external systems. The exported data maintains the hierarchical structure of forms, elements, and their submitted values.
POST
Export form element submissions
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Minimum array length:
1Available options:
csv, xlsx 
