Skip to content

Other apps

Connect Custom REST API to DataxLand

DataxLand's custom REST API connector reads JSON from the API of any software - POS, sales software, inventory, CRM or an in-house ERP - when there is no ready-made connector yet. For example, if the sales management software you use (Haravan, Sapo, KiotViet, Nhanh.vn or another) has a REST API, you declare the base URL, the authentication method and each endpoint to read; each endpoint becomes a table in the workspace warehouse. The connector only sends GET requests, and only to the host of the base URL, so it cannot write or delete anything in your systems.

Free plan with no time limit · No card required · Sample workspace ready in minutes

What you can do with Custom REST API

  • Bring orders, products and stock from sales software with an API into a multichannel profit and loss dashboard.
  • Combine in-house software data with marketplace data, ads and a cost price sheet in Google Sheets.
  • Quickly try out a new source before a dedicated connector exists for it.

What data you get

Each stream lands as its own table in the workspace warehouse, as is; personal-data columns are hashed on load.

Stream (table)Contents
<endpoint name>Each endpoint you declare (table name, path, parameters) becomes a table raw.<source name>__<endpoint name>.
record pathPoints to the list of records in the response, for example data.items; leave empty if the response is a list.
paginationBy page number, by limit/offset, by cursor or by next-page link (including the Link header).

Connection details

Sign-in methodConnection details (API key, account), encrypted at rest
Sync modesFull (reloaded each run)
Fields to fill inBase url, Endpoint
DeveloperDataxLand
LicenseMIT

Passwords and keys are encrypted at rest. Personal-data columns are hashed on load.

Metrics computed from this source

Real definitions from the analytics packs; dashboards and Si share them.

MetricDefinitionUnit
Net revenueLine value after line discounts and allocated order vouchers, minus refunds to buyers. Refunds are deducted only here.Currency
Valid ordersOrders that were not cancelled (standard status other than cancelled).Count
Average order valueLine revenue after discounts divided by valid orders.= line_net_total / Valid ordersCurrency
Units soldTotal quantity of products in the order lines of valid orders.Count
Cancellation rateCancelled orders divided by total orders.= cancelled_orders / all_ordersRatio (%)
Average inventory valueAverage end-of-day inventory value in the period = sum of snapshot values divided by the number of days with a snapshot.= ops_inventory_value_total / ops_snapshot_daysCurrency

Connect Custom REST API in 3 steps

  1. 1

    Set the URL and authentication

    In the workspace choose Add source → Custom REST API, paste the base URL (https://...), and choose authentication - none, API key, Bearer token, Basic or OAuth2 client credentials.

  2. 2

    Declare endpoints

    Add up to 20 endpoints, each with a table name, path, parameters ({{ start_date }} is supported), path to the record list, primary key and pagination type.

  3. 3

    Test and review

    Click Test connection and look at the data sample; Si proposes what each table is in the standard model, and you approve before the build.

Limits and caveats

  • Each refresh re-reads every endpoint in full; use a date parameter with {{ start_date }} to limit the data range.
  • Each endpoint is limited to 1,000 pages; the per-call timeout defaults to 30 seconds, up to 300 seconds.
  • Enter secrets only in the Authentication section (encrypted, never shown again); do not put keys in headers or parameters.
  • DataxLand has no dedicated connector for Haravan, Sapo, KiotViet or Nhanh.vn yet; this approach depends on the API your software vendor makes available to you.

Frequently asked questions

Does the connector write data to my systems?

No. The connector only sends GET requests, and only to the host of the base URL; private network addresses are blocked.

What if the API returns XML or CSV?

The connector reads JSON. For CSV, use Excel or Google Sheets, or load it into Postgres first.

Do I need to know how to code?

You need to understand your software's API documentation (endpoints, authentication, pagination); no coding is required.

Dashboard templates that use this source

Ask Si about your Custom REST API data →All data sources →

Connect Custom REST API and get verified dashboards

Free plan with no time limit · No card required · Sample workspace ready in minutes