Introduction

This method returns the schema for a Factual table view. The schema includes:

Table view meta-data: Name, description, view id, list of fields schema version, and whether or not the table is geo and/or full-text searchable.
Field meta-data (for each field): name, optional aliase(s), datatype, whether the field is full-text-searchable.

Basic Syntax

Simply include the name of the table in the URI of the schema call.

Get the schema of the Global places table:

Run example

Get the schema of the US restaurants table:

Run example

There are no required parameters for the schema call.

Parameter Name	Description	Example
KEY	Your API Key. The KEY parameter is only required for non-OAuthenticated requests, which are supported purely as a debugging convenience. OAuth documentation is here.	KEY=Q3iBjOES4h1mZcNCZyBmQFcYREdjylIucvB3r2oI

NOTES:

During BETA, you need to request a key and secret directly from Factual.
Both the name of KEY parameter and the key passed into it are case-sensitive.
all examples are shown without URL Encoding for clarity.

object	description
version	Version of the API that generated this response.
response	Will contain your response data.
response.view	Will contain all meta-data for the view.
response.view.title	The title of the view.
response.view.description	An (optional) description of the view.
response.view. last_update_date	The date the schema was last updated, YYYY-mm-dd.
response.view.geo_enabled	true if this view supports geo-filters. false otherwise.
response.view.search_enabled	true if full-text-search is enabled across the table. false otherwise.
response.view.fields	A hash containing meta-data for all of the fields in this view.
response.view.fields.[field id].name	The programmatic reference to this field.
response.view.fields.[field id].label	The human readable label for a field.
response.view.fields.[field id].description	A description of the field.
response.view.fields.[field id].datatypes	The datatype for a field.
response.view.fields.[field id].aliases	Alternate ids for referencing this field programmatically.
response.view.fields.[field id].sortable	true if this field supports being sorted on. false otherwise.
response.view.fields.[field id].searchable	true if this field supports full-text search. false otherwise.
response.view.fields.[field id].faceted	true if this field supports facets. false otherwise.

In addition to general Factual API errors, the following errors may be returned in response to GET requests:

This method has no error messages specific to it.