Get table stats

curl --request GET \
  --url https://api.getoneprofile.ai/tables/{table_id}/stats/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.getoneprofile.ai/tables/{table_id}/stats/', 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.getoneprofile.ai/tables/{table_id}/stats/",
  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.getoneprofile.ai/tables/{table_id}/stats/"

	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.getoneprofile.ai/tables/{table_id}/stats/")

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

{
  "active_run": {
    "cells_done": 123,
    "cells_failed": 123,
    "cells_no_data": 123,
    "cells_skipped": 123,
    "cells_total": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "row_scope": {
      "kind": "all_rows",
      "record_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "rows": 123
    },
    "started_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger": "cell_edited",
    "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "export_retry_attempt": 0
  },
  "at_row_cap": true,
  "columns_by_kind": {},
  "failed_cells": 123,
  "failed_cells_by_column": {},
  "filled_cells_by_column": {},
  "row_count": 123,
  "cell_settlement_by_column": {},
  "last_run_at_by_column": {}
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

GET

tables

{table_id}

stats

Get table stats

curl --request GET \
  --url https://api.getoneprofile.ai/tables/{table_id}/stats/ \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.getoneprofile.ai/tables/{table_id}/stats/', 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.getoneprofile.ai/tables/{table_id}/stats/",
  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.getoneprofile.ai/tables/{table_id}/stats/"

	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.getoneprofile.ai/tables/{table_id}/stats/")

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

{
  "active_run": {
    "cells_done": 123,
    "cells_failed": 123,
    "cells_no_data": 123,
    "cells_skipped": 123,
    "cells_total": 123,
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "row_scope": {
      "kind": "all_rows",
      "record_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "rows": 123
    },
    "started_at": "2023-11-07T05:31:56Z",
    "status": "pending",
    "table_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger": "cell_edited",
    "column_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "export_retry_attempt": 0
  },
  "at_row_cap": true,
  "columns_by_kind": {},
  "failed_cells": 123,
  "failed_cells_by_column": {},
  "filled_cells_by_column": {},
  "row_count": 123,
  "cell_settlement_by_column": {},
  "last_run_at_by_column": {}
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

table_id

string<uuid>

required

Response

Successful Response

Aggregate stats for one table, composed from three downward reads.

active_run

TableRunReadSchema · object | null

required

The newest active run, when one exists.

Show child attributes

at_row_cap

boolean

required

Whether the table has reached its row cap.

columns_by_kind

Columns By Kind · object

required

Number of columns per column kind (manual/formula).

Show child attributes

failed_cells

integer

required

Cells currently carrying an evaluation error.

failed_cells_by_column

Failed Cells By Column · object

required

Errored cells per column ID. A column with no failures is absent — read absence as zero. What the column header's error badge shows.

Show child attributes

filled_cells_by_column

Filled Cells By Column · object

required

Cells holding a stored value, per column ID. A column with no filled cells is absent — read absence as zero. How much of the column has DATA in it, which is not how much of it is DONE — for that, and for the breakdown behind it, read cell_settlement_by_column.

Show child attributes

row_count

integer

required

cell_settlement_by_column

Cell Settlement By Column · object

How each column's cells ended, per column ID. A column with no cells is absent — read absence as zero across every figure.

The completeness read. filled_cells_by_column and failed_cells_by_column are both projections of this and are kept only so an existing API-key client does not break.

Show child attributes

last_run_at_by_column

Last Run At By Column · object

When each column last produced a value. Derived from its newest computed cell — a column absent here has never run. Not the column's updated_at, which moves when it is merely renamed.

Show child attributes

API reference

Endpoints

Get table stats

Authorizations

Path Parameters

Response