Getting Data

Getting Data from a Bloc

circle-exclamation

Get Data from a Bloc (No Filters)

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

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


Request Body

Name
Type
Description

blocId*

string

The ID of the bloc. This may be a UUID (e.g. a1489634-4009-4cc0-8a65-9965f5a1bea7) or numeric ID depending on your instance.

resultLimit

integer

Number of records to return per request. Defaults to 10 if not provided.

currentPage

integer

Pagination index (1-based). Used with resultLimit to retrieve subsequent pages.

reverse

boolean

Controls sort order:• false (default) → newest first• true → oldest first

fromDate

string

Filters records after this timestamp. Format: YYYY-MM-DD HH:MM:SS

toDate

string

Filters records before this timestamp. Format: YYYY-MM-DD HH:MM:SS


⚠️ Date Filtering Behavior (Important)

  • fromDate alone → accepts full datetime (YYYY-MM-DD HH:MM:SS)

  • toDate alone → accepts full datetime (YYYY-MM-DD HH:MM:SS)

  • fromDate + toDate together:

    • In some cases, it must be provided as a date-only format (YYYY-MM-DD)


Response Structure

The response returns a mixed object, not a pure array.

  • Numeric keys ("0", "1", etc.) → records

  • Additional keys provide metadata


200 Response Example


Notes on Response

  • count → total number of matching records (not just returned page)

  • fieldCounts → aggregated values across all matching records

  • countLimitInfo → scan tracking metadata

  • fieldNames → mapping of field slugs to display names


Error Responses

401 Unauthorized

400 Bad Request

⚠️ Some errors may return:

(Error response formats are not fully standardized.)


Example Requests

cURL


Node.js (Axios)


Python

Last updated