Getting Data

Getting 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 make sure the user who the Auth token was created for is not restricted to certain data, and please also make sure they have been given access to that bloc.

Gets all data from a bloc (without search filters)

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

Request Body

Name	Type	Description
blocId*	integer	The ID of the bloc you want to get data from. This is the last number in the URL of the bloc, in this example it is 1234: https://example.mydomain.com/module/module-name/bloc/1234
resultLimit	integer	A limit on the number of results to receive back, This defaults to 10 if not provided.
currentPage	integer	If you have a 100 records with a result limit of 10, then currentPage 1 will get you records from 1 to 10, currentPage 2, will get you 11 to 20 and so on.
reverse	string	true or false - allows to determine whether you see oldest data first or newest data first, a true value gives you oldest data first.
fromDate	string	Date in the format of YYYY-MM-DD HH:MM:SS, e.g. 2022-05-22 22:04:23, only gets data after this date.
toDate	string	Date in the format of YYYY-MM-DD HH:MM:SS, e.g. 2022-05-22 22:10:23, only gets data before this date.

200 Data Response Object

{
	"data": {
		"0": {
			"created_at": "2022-05-22 22:05:01",
			"submitted_status": 1,
			"user_id": "johndoe",
			"field_1": "data",
			"field_2": "more data",
			"cartolytics_entry_row_id": 123456
		},
		"1": {
			"created_at": "2022-05-22 22:06:03",
			"submitted_status": 1,
			"user_id": "johndoe",
			"field_1": "another record",
			"field_2": "more data",
			"cartolytics_entry_row_id": 123457
		},
		"2": {
			"created_at": "2022-05-22 22:07:53",
			"submitted_status": 1,
			"user_id": "johndoe",
			"field_1": "another record",
			"field_2": "more data",
			"cartolytics_entry_row_id": 123458
		},
		"3": {
			"created_at": "2022-05-22 22:08:41",
			"submitted_status": 1,
			"user_id": "johndoe",
			"field_1": "another record",
			"field_2": "more data",
			"cartolytics_entry_row_id": 123458
		}
		"count": 4,
		"fieldCounts": {
			"field_1": {
				"another record": 2,
				"data": 1
			},
			"field_2": {
				"more data": 4
			},
		},
		"countLimitInfo": {
			"scan_limit": null,
			"scan_limit_time_logged": null,
			"scans_counted": 5,
			"limit_reached": 0
		},
		"fieldNames": {
			"field_1": "Field 1",
			"field_2": "Field 2"
		}
	}
}

401 Permission denied

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

400: Bad Request Bad Request

{
    "error": [ERROR MESSAGE HERE]
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://example.mydomain.com/api/get-data',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS =>'{
    "blocId": 1234,
    "reverse": "false",
    "fromDate" : "2022-05-23 00:23:33"
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer [AUTHTOKEN]',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

jQuery

var settings = {
  "url": "https://example.mydomain.com/api/get-data",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer [AUTHTOKEN]",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "blocId": 1234,
    "reverse": "false",
    "fromDate" : "2022-05-23 00:23:33"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Node JS

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'GET',
  'hostname': 'example.mydomain.com',
  'path': '/api/get-data',
  'headers': {
    'Authorization': 'Bearer [AUTHTOKEN]',
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "blocId": 1234,
  "reverse": "false",
  "fromDate" : "2022-05-23 00:23:33"
});

req.write(postData);

req.en

Python

import requests
import json

url = "https://example.mydomain.com/api/get-data"

payload = json.dumps({
  "blocId": 1234,
  "reverse": "false",
  "fromDate" : "2022-05-23 00:23:33"
})
headers = {
  'Authorization': 'Bearer [AUTHTOKEN]',
  'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)