Skip to main content
GET
/
data
/
facets
/
{table_name}
Get Custom Data Facets
curl --request GET \
  --url https://api.prod.usesimple.ai/api/v1/data/facets/{table_name} \
  --header 'Authorization: <api-key>'
{
  "tableName": "<string>",
  "tableLabel": "<string>",
  "totalRecords": 123,
  "facets": [
    {
      "columnName": "<string>",
      "columnDisplayName": "<string>",
      "values": [
        {
          "value": "<string>",
          "count": 123
        }
      ]
    }
  ]
}
Facets are available for indexed tables and include distinct values for facetable columns.

Authorizations

Authorization
string
header
required

Path Parameters

table_name
string
required

Custom data table name.

Pattern: ^[a-z0-9_]+$

Response

Successful Response

tableName
string
required
tableLabel
string
required
totalRecords
integer
required
facets
Custom Data Column Facet · object[]
required