Profile Table - Retab Docs

Table.Get Profile

curl --request GET \
  --url https://api.retab.com/v1/tables/{table_id}/profile \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.retab.com/v1/tables/{table_id}/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.retab.com/v1/tables/{table_id}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.retab.com/v1/tables/{table_id}/profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.retab.com/v1/tables/{table_id}/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "table_id": "<string>",
  "row_count": 123,
  "columns": []
}

{
  "detail": []
}

GET

tables

{table_id}

profile

Table.Get Profile

curl --request GET \
  --url https://api.retab.com/v1/tables/{table_id}/profile \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.retab.com/v1/tables/{table_id}/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.retab.com/v1/tables/{table_id}/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.retab.com/v1/tables/{table_id}/profile"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.retab.com/v1/tables/{table_id}/profile")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "table_id": "<string>",
  "row_count": 123,
  "columns": []
}

{
  "detail": []
}

Return column-level row counts, null counts, distinct counts, ranges, and sample values for a CSV-backed table.

Python

profile = client.tables.profile(table_id="tbl_123", select=["countrycode"])

TypeScript

const profile = await client.tables.profile("tbl_123", {
  select: ["countrycode"],
});

profile, err := client.Tables.Profile(ctx, "tbl_123", &retab.TablesProfileParams{
  Select: []string{"countrycode"},
})

Java

// Profile table columns with the Retab Java client.

cURL

curl "https://api.retab.com/v1/tables/tbl_123/profile?select=countrycode" \
  -H "Authorization: Bearer $RETAB_API_KEY"

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

table_id

string

required

Query Parameters

select

string[]

Response

Successful Response

table_id

string

required

row_count

integer

required

columns

WorkflowTableProfileColumn · object[]

Show child attributes