Getting Reports

Getting Report Data from a Bloc

Please note: All Bloc Data User Restrictions will apply in these requests. If you are not getting data back or cannot access the bloc, please ensure the user associated with the Auth token has access to the bloc and is not restricted.

Get Report Data

GET https://example.mydomain.com/api/get-data-report

⚠️ This endpoint expects a JSON request body even though it uses the GET method.

This endpoint can return:

• JSON report data

• an Excel .xlsx file export

---

Request Body

Name	Type	Description
stationID*	string	The bloc ID. This may be a UUID or numeric ID depending on your instance.
fieldsToReport*	string	Either "all" or a JSON-encoded string of field slugs to include, for example "{\"field_1\":true,\"field_2\":true}"
responseType	string	If set to "blob", returns an Excel .xlsx file instead of JSON
requestedReportData	string	JSON-encoded string containing report date options, for example "{\"reportFromDate\":\"2026-03-19 00:00:00\",\"reportToDate\":\"2026-03-19 23:59:59\"}"
dataFilteringData	string	JSON-encoded string containing filter options for example "{\"stationID\":\"...\",\"filterDataToQuery\":{\"field_1\":[\"Value\"]},\"currentPage\":1,\"reverse\":false}"

---

JSON Response Example

{
  "data": [
    {
      "created_at": "2026-03-19 13:41:06",
      "user_id": "exampleuser",
      "field_number_1": "10",
      "field_number_2": "12",
      "radio_name": "4",
      "my_dropdown_from_my_bloc": "4",
      "my_results_box": "Results Box Data",
      "time_stamp": "13:41:06",
      "date_stamp": "2026-03-19"
    }
  ]
}

---

Response Notes

• Response data is a flat array

• Default ordering is oldest first

• When fieldsToReport is "all", derived fields may be included:

  • time_stamp

  • date_stamp

• When fieldsToReport specifies selected fields, only those fields are returned

---

Excel Response

When responseType is set to "blob", the endpoint returns an Excel .xlsx file.

Example content type:

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Note: the current implementation may not return a Content-Disposition filename header, so some clients may need to save the file manually.

---

Error Responses

401 Unauthorized

{
  "error": "You are not authorized to access this bloc"
}

400 Bad Request

{
  "error": "Error message"
}

Depending on the error, additional debug fields may also be returned by the current implementation.

---

Example Requests

Get all report data as JSON

curl --request GET 'https://example.mydomain.com/api/get-data-report' \
  --header 'Authorization: Bearer [AUTHTOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
    "stationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "fieldsToReport": "all"
  }'

Get selected fields only

curl --request GET 'https://example.mydomain.com/api/get-data-report' \
  --header 'Authorization: Bearer [AUTHTOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
    "stationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "fieldsToReport": "{\"field_number_1\":true,\"radio_name\":true}"
  }'

Filter by report date range

curl --request GET 'https://example.mydomain.com/api/get-data-report' \
  --header 'Authorization: Bearer [AUTHTOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
    "stationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "fieldsToReport": "all",
    "requestedReportData": "{\"reportFromDate\":\"2026-03-19 00:00:00\",\"reportToDate\":\"2026-03-19 23:59:59\"}"
  }'

Filter by field values

curl --request GET 'https://example.mydomain.com/api/get-data-report' \
  --header 'Authorization: Bearer [AUTHTOKEN]' \
  --header 'Content-Type: application/json' \
  --data '{
    "stationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "fieldsToReport": "all",
    "dataFilteringData": "{\"stationID\":\"a1489634-4009-4cc0-8a65-9965f5a1bea7\",\"filterDataToQuery\":{\"radio_name\":[\"1\"]},\"currentPage\":1,\"reverse\":false}"
  }'

Download Excel file

curl --request GET 'https://example.mydomain.com/api/get-data-report' \
  --header 'Authorization: Bearer [AUTHTOKEN]' \
  --header 'Content-Type: application/json' \
  --output report.xlsx \
  --data '{
    "stationID": "a1489634-4009-4cc0-8a65-9965f5a1bea7",
    "fieldsToReport": "all",
    "responseType": "blob"
  }'