Data sharing API
The Data Service API is shared for all services, the user can refer to API documentation to know the usage (request & response format).
Last updated
The Data Service API is shared for all services, the user can refer to API documentation to know the usage (request & response format).
Last updated
You can generate, manage, and perform actions on your API key to use the Data Service API.
Click How to call API? in the utility bar
The API Key is hidden by default. Click on Reveal the key to see its value, and you can quickly click to Copy.
Follow the API documentation below for API endpoints, request parameters and usage guidelines.
You can click Rotate to generate a new API key (replace the existing one).
The current key will immediately be disabled once rotated and requests made using the key will be rejected.
Authorization
Bearer {{ your_API_key }}
filters
array
Filter conditions list. Each filter contains:
field: The field name to filter on.
operator: The comparison operator.
Supported operators:
=, !=, >, <, <=, ~ (inclusive), !~ (exclusive),
time_between, time_relative (for special time ranges including today, yesterday, this_week, last_week, this_month, this_year, last_year).
value: The filter value.
If using time_between, the value must be an array in the format [start_time, end_time].
sorts
array
Sort conditions list. Each sort condition contains:
field: The field name to sort by.
order: The sorting order, either asc (ascending) or desc (descending).
page
int
The page number for pagination.
page_size
int
The number of records returned per page.
Allowed values: [100, 10000]. Default: 100.
curl --location --request POST 'https://api.recurve.cloud/api/data-service/open/services/{{ data_service_id }}/preview' \
--header 'Accept-Language: en-US,en;q=0.9,zh;q=0.8,zh-CN;q=0.7' \
--header 'Cache-Control: no-cache' \
--header 'Connection: keep-alive' \
--header 'DNT: 1' \
--header 'Origin: https://demo.recurve.cloud' \
--header 'Pragma: no-cache' \
--header 'Referer: https://demo.recurve.cloud/' \
--header 'Sec-Fetch-Dest: empty' \
--header 'Sec-Fetch-Mode: cors' \
--header 'Sec-Fetch-Site: same-site' \
--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/133.0.0.0 Safari/537.36' \
--header 'accept: application/json' \
--header 'sec-ch-ua: "Chromium";v="133", "Not(A:Brand";v="99"' \
--header 'sec-ch-ua-mobile: ?0' \
--header 'sec-ch-ua-platform: "macOS"' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer {{ your_api_key }}' \
--header 'Host: api.recurve.cloud' \
--data-raw '{
"filters": [
{
"field": "PaymentMethod",
"operator": "=",
"value": "Cash"
}
],
"filter_logic": "all",
"sorts": [],
"timezone": "Asia/Shanghai"
}'Please replace the following parameters with actual values:
{{ data_service_id }}: the actual ID of the data service.
{{ your_api_key }}: your personal API key.
Successful Response Example
{
"code": "0",
"msg": "success",
"data": {
"total": 304,
"items": [
{
"o_orderkey": {
"type": "bigint",
"name": "o_orderkey",
"normalized_type": "integer",
"value": "5997922"
},
"o_orderdate": {
"type": "date",
"name": "o_orderdate",
"normalized_type": "date",
"value": "1992-12-04"
},
"o_custkey": {
"type": "int",
"name": "o_custkey",
"normalized_type": "integer",
"value": "88970"
},
"o_orderstatus": {
"type": "varchar",
"name": "o_orderstatus",
"normalized_type": "string",
"value": "F"
},
"o_totalprice": {
"type": "decimal",
"name": "o_totalprice",
"normalized_type": "float",
"value": "91422.19"
},
"o_orderpriority": {
"type": "varchar",
"name": "o_orderpriority",
"normalized_type": "string",
"value": "4-NOT SPECIFIED"
},
"o_clerk": {
"type": "varchar",
"name": "o_clerk",
"normalized_type": "string",
"value": "Clerk#000000108"
},
"o_shippriority": {
"type": "int",
"name": "o_shippriority",
"normalized_type": "integer",
"value": "0"
},
"o_comment": {
"type": "varchar",
"name": "o_comment",
"normalized_type": "string",
"value": "oze blithely across the slyly bold packages. dolphin"
}
},
{
"o_orderkey": {
"type": "bigint",
"name": "o_orderkey",
"normalized_type": "integer",
"value": "5997921"
},
"o_orderdate": {
"type": "date",
"name": "o_orderdate",
"normalized_type": "date",
"value": "1997-03-16"
},
"o_custkey": {
"type": "int",
"name": "o_custkey",
"normalized_type": "integer",
"value": "117583"
},
"o_orderstatus": {
"type": "varchar",
"name": "o_orderstatus",
"normalized_type": "string",
"value": "O"
},
"o_totalprice": {
"type": "decimal",
"name": "o_totalprice",
"normalized_type": "float",
"value": "68401.33"
},
"o_orderpriority": {
"type": "varchar",
"name": "o_orderpriority",
"normalized_type": "string",
"value": "2-HIGH"
},
"o_clerk": {
"type": "varchar",
"name": "o_clerk",
"normalized_type": "string",
"value": "Clerk#000000101"
},
"o_shippriority": {
"type": "int",
"name": "o_shippriority",
"normalized_type": "integer",
"value": "0"
},
"o_comment": {
"type": "varchar",
"name": "o_comment",
"normalized_type": "string",
"value": "xcuses nag slyly. idle dolphins cajole ironically-- regular, bold ex"
}
},
{
"o_orderkey": {
"type": "bigint",
"name": "o_orderkey",
"normalized_type": "integer",
"value": "5997920"
},
"o_orderdate": {
"type": "date",
"name": "o_orderdate",
"normalized_type": "date",
"value": "1992-08-02"
},
"o_custkey": {
"type": "int",
"name": "o_custkey",
"normalized_type": "integer",
"value": "42044"
},
"o_orderstatus": {
"type": "varchar",
"name": "o_orderstatus",
"normalized_type": "string",
"value": "F"
},
"o_totalprice": {
"type": "decimal",
"name": "o_totalprice",
"normalized_type": "float",
"value": "36627.47"
},
"o_orderpriority": {
"type": "varchar",
"name": "o_orderpriority",
"normalized_type": "string",
"value": "1-URGENT"
},
"o_clerk": {
"type": "varchar",
"name": "o_clerk",
"normalized_type": "string",
"value": "Clerk#000000205"
},
"o_shippriority": {
"type": "int",
"name": "o_shippriority",
"normalized_type": "integer",
"value": "0"
},
"o_comment": {
"type": "varchar",
"name": "o_comment",
"normalized_type": "string",
"value": "al instructions nag carefully until the requests. fluffily re"
}
},
{
"o_orderkey": {
"type": "bigint",
"name": "o_orderkey",
"normalized_type": "integer",
"value": "5997895"
},
"o_orderdate": {
"type": "date",
"name": "o_orderdate",
"normalized_type": "date",
"value": "1996-01-15"
},
"o_custkey": {
"type": "int",
"name": "o_custkey",
"normalized_type": "integer",
"value": "91180"
},
"o_orderstatus": {
"type": "varchar",
"name": "o_orderstatus",
"normalized_type": "string",
"value": "O"
},
"o_totalprice": {
"type": "decimal",
"name": "o_totalprice",
"normalized_type": "float",
"value": "199978.64"
},
"o_orderpriority": {
"type": "varchar",
"name": "o_orderpriority",
"normalized_type": "string",
"value": "2-HIGH"
},
"o_clerk": {
"type": "varchar",
"name": "o_clerk",
"normalized_type": "string",
"value": "Clerk#000000075"
},
"o_shippriority": {
"type": "int",
"name": "o_shippriority",
"normalized_type": "integer",
"value": "0"
},
"o_comment": {
"type": "varchar",
"name": "o_comment",
"normalized_type": "string",
"value": "ly among the regular, even depend"
}
}
],
"error": null
}
}Failed Response Example
{
"code": "0",
"msg": "success",
"data": {
"total": 0,
"items": [],
"error": {
"code": "A1402",
"reason": "Preview data failed: (1105, \"errCode = 2, detailMessage = Unknown column 'o_orderke' in '_recurve_limit_subquery' in SORT clause\")",
"data": null
}
}
}Obtain your from the Data Service detail page.
