Create a query

POST/datastore/{connection_id}/query

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Payload

table_idstring
database_idstring
queryobject
responseobject

Returns

Response fieldTypeRequiredDescription
table_idstringNo
database_idstringNo
queryobjectNo
query.sqlstringNoRaw SQL – when set, executed directly (table_id optional)
query.selectstring[]No
query.expandmap<DatastoreQueryExpand>No
query.expand{}.selectstring[]No
query.expand{}.filterDatastoreQueryExpand_filterNo
query.expand{}.filter.typeenumYesValues: FILTER, AND, OR
query.expand{}.filter.filtersDatastoreFilter[]No
query.expand{}.filter.filters[].fieldstringYes
query.expand{}.filter.filters[].conditionDatastoreFilter_conditionYes
query.expand{}.filter.filters[].condition.eqDatastoreFilter_condition_eqNo
query.expand{}.filter.filters[].condition.neqDatastoreFilter_condition_neqNo
query.expand{}.filter.filters[].condition.gtDatastoreFilter_condition_gtNo
query.expand{}.filter.filters[].condition.gteDatastoreFilter_condition_gteNo
query.expand{}.filter.filters[].condition.ltDatastoreFilter_condition_ltNo
query.expand{}.filter.filters[].condition.lteDatastoreFilter_condition_lteNo
query.expand{}.filter.filters[].condition.likeDatastoreFilter_condition_likeNo
query.expand{}.filter.filters[].condition.ilikeDatastoreFilter_condition_ilikeNo
query.expand{}.filter.filters[].condition.inDatastoreFieldValue[]No
query.expand{}.filter.filters[].condition.containsDatastoreFilter_condition_containsNo
query.expand{}.filter.filters[].condition.not_containsDatastoreFilter_condition_not_containsNo
query.expand{}.filter.filters[].condition.is_nullbooleanNo
query.expand{}.filter.filters[].condition.is_not_nullbooleanNo
query.expand{}.filter.andobjectNo
query.expand{}.filter.orobjectNo
query.expand{}.limitnumberNo
query.expand{}.expandmap<any>No
query.filterDatastoreQuery_query_filterNo
query.filter.typeenumYesValues: FILTER, AND, OR
query.filter.filtersDatastoreFilter[]No
query.filter.filters[].fieldstringYes
query.filter.filters[].conditionDatastoreFilter_conditionYes
query.filter.filters[].condition.eqDatastoreFilter_condition_eqNo
query.filter.filters[].condition.eq.stringstringNo
query.filter.filters[].condition.eq.numbernumberNo
query.filter.filters[].condition.eq.booleanbooleanNo
query.filter.filters[].condition.eq.datestringNo
query.filter.filters[].condition.eq.selectionstring[]No
query.filter.filters[].condition.eq.is_nullbooleanNo
query.filter.filters[].condition.neqDatastoreFilter_condition_neqNo
query.filter.filters[].condition.neq.stringstringNo
query.filter.filters[].condition.neq.numbernumberNo
query.filter.filters[].condition.neq.booleanbooleanNo
query.filter.filters[].condition.neq.datestringNo
query.filter.filters[].condition.neq.selectionstring[]No
query.filter.filters[].condition.neq.is_nullbooleanNo
query.filter.filters[].condition.gtDatastoreFilter_condition_gtNo
query.filter.filters[].condition.gt.stringstringNo
query.filter.filters[].condition.gt.numbernumberNo
query.filter.filters[].condition.gt.booleanbooleanNo
query.filter.filters[].condition.gt.datestringNo
query.filter.filters[].condition.gt.selectionstring[]No
query.filter.filters[].condition.gt.is_nullbooleanNo
query.filter.filters[].condition.gteDatastoreFilter_condition_gteNo
query.filter.filters[].condition.gte.stringstringNo
query.filter.filters[].condition.gte.numbernumberNo
query.filter.filters[].condition.gte.booleanbooleanNo
query.filter.filters[].condition.gte.datestringNo
query.filter.filters[].condition.gte.selectionstring[]No
query.filter.filters[].condition.gte.is_nullbooleanNo
query.filter.filters[].condition.ltDatastoreFilter_condition_ltNo
query.filter.filters[].condition.lt.stringstringNo
query.filter.filters[].condition.lt.numbernumberNo
query.filter.filters[].condition.lt.booleanbooleanNo
query.filter.filters[].condition.lt.datestringNo
query.filter.filters[].condition.lt.selectionstring[]No
query.filter.filters[].condition.lt.is_nullbooleanNo
query.filter.filters[].condition.lteDatastoreFilter_condition_lteNo
query.filter.filters[].condition.lte.stringstringNo
query.filter.filters[].condition.lte.numbernumberNo
query.filter.filters[].condition.lte.booleanbooleanNo
query.filter.filters[].condition.lte.datestringNo
query.filter.filters[].condition.lte.selectionstring[]No
query.filter.filters[].condition.lte.is_nullbooleanNo
query.filter.filters[].condition.likeDatastoreFilter_condition_likeNo
query.filter.filters[].condition.like.stringstringNo
query.filter.filters[].condition.like.numbernumberNo
query.filter.filters[].condition.like.booleanbooleanNo
query.filter.filters[].condition.like.datestringNo
query.filter.filters[].condition.like.selectionstring[]No
query.filter.filters[].condition.like.is_nullbooleanNo
query.filter.filters[].condition.ilikeDatastoreFilter_condition_ilikeNo
query.filter.filters[].condition.ilike.stringstringNo
query.filter.filters[].condition.ilike.numbernumberNo
query.filter.filters[].condition.ilike.booleanbooleanNo
query.filter.filters[].condition.ilike.datestringNo
query.filter.filters[].condition.ilike.selectionstring[]No
query.filter.filters[].condition.ilike.is_nullbooleanNo
query.filter.filters[].condition.inDatastoreFieldValue[]No
query.filter.filters[].condition.in[].stringstringNo
query.filter.filters[].condition.in[].numbernumberNo
query.filter.filters[].condition.in[].booleanbooleanNo
query.filter.filters[].condition.in[].datestringNo
query.filter.filters[].condition.in[].selectionstring[]No
query.filter.filters[].condition.in[].is_nullbooleanNo
query.filter.filters[].condition.containsDatastoreFilter_condition_containsNo
query.filter.filters[].condition.contains.stringstringNo
query.filter.filters[].condition.contains.numbernumberNo
query.filter.filters[].condition.contains.booleanbooleanNo
query.filter.filters[].condition.contains.datestringNo
query.filter.filters[].condition.contains.selectionstring[]No
query.filter.filters[].condition.contains.is_nullbooleanNo
query.filter.filters[].condition.not_containsDatastoreFilter_condition_not_containsNo
query.filter.filters[].condition.not_contains.stringstringNo
query.filter.filters[].condition.not_contains.numbernumberNo
query.filter.filters[].condition.not_contains.booleanbooleanNo
query.filter.filters[].condition.not_contains.datestringNo
query.filter.filters[].condition.not_contains.selectionstring[]No
query.filter.filters[].condition.not_contains.is_nullbooleanNo
query.filter.filters[].condition.is_nullbooleanNo
query.filter.filters[].condition.is_not_nullbooleanNo
query.filter.andobjectNo
query.filter.orobjectNo
query.sort_fieldsstring[]No
query.sort_orderenumNoValues: asc, desc
query.limitnumberNo
query.offsetnumberNo
query.aggregateDatastoreQuery_query_aggregateNo
query.aggregate.countbooleanNo
query.aggregate.sumDatastoreQuery_query_aggregate_sumNo
query.aggregate.sum.fieldstringYes
query.aggregate.sum.aliasstringNo
query.aggregate.avgDatastoreQuery_query_aggregate_avgNo
query.aggregate.avg.fieldstringYes
query.aggregate.avg.aliasstringNo
query.aggregate.minDatastoreQuery_query_aggregate_minNo
query.aggregate.min.fieldstringYes
query.aggregate.min.aliasstringNo
query.aggregate.maxDatastoreQuery_query_aggregate_maxNo
query.aggregate.max.fieldstringYes
query.aggregate.max.aliasstringNo
query.aggregate.group_bystring[]No
query.is_count_onlybooleanNo
responseobjectNo
response.itemsDatastoreRecord[]No
response.items[].idstringNo
response.items[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response.items[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
response.items[].database_idstringNosource Database ID
response.items[].table_idstringNosource Database Table ID
response.items[].fieldsobjectYes
response.items[].fields.stringstringNo
response.items[].fields.numbernumberNo
response.items[].fields.booleanbooleanNo
response.items[].fields.datestringNo
response.items[].fields.selectionstring[]No
response.items[].fields.is_nullbooleanNo
response.items[].row_numbernumberNo
response.aggregatesDatastoreQuery_response_aggregatesNo
response.aggregates.countnumberNo
response.aggregates.summap<number>No
response.aggregates.avgmap<number>No
response.aggregates.minmap<number>No
response.aggregates.maxmap<number>No
response.aggregates.groupsmap<DatastoreFieldValue>[]No
response.aggregates.groups[].stringstringNo
response.aggregates.groups[].numbernumberNo
response.aggregates.groups[].booleanbooleanNo
response.aggregates.groups[].datestringNo
response.aggregates.groups[].selectionstring[]No
response.aggregates.groups[].is_nullbooleanNo
response.total_countnumberNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'POST',
  url: 'https://api.unified.to/datastore/5de520f96e439b002043d8dc/query',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?