Site takeout

GET

/api/sites/{id}/takeout

const url = 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/takeout?format=xlsx';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/takeout?format=xlsx' \
  --cookie hk_token=<hk_token>

Exports site data as xlsx/csv/parquet/json/ndjson.

Authorizations

cookieAuth

Parameters

Path Parameters

required

string format: uuid

Query Parameters

format

string

Allowed values: xlsx csv parquet json ndjson

Export format. Supported values: xlsx, csv, parquet, json, ndjson. Defaults: xlsx for takeout endpoints, csv for hits export endpoints.

Responses

200

Export file stream