DataTable

Create or retrieve a data table by name

Gets or creates a data table by name. (To create a data table with additional options such as solution_id, use project.createDataTable.)

post/v1/projects/{project_id}/tables

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/tables
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Request body

namestring required

Name of the data table

Example request

{
  "name": "Election Reports"
}

Response

Successful response

idstring

ID of the data table

namestring

Name of the data table

num_rowsinteger

Number of rows in the table. For performance reasons, this number may sometimes be out-of-date.

show_add_rowboolean

Whether to allow adding or importing rows via the web app

show_statsboolean

Whether to show summary charts (pie charts, bar charts, tables of top values) for this data table in the web app

show_contact_columnsboolean

Whether to show 'Contact Name' and 'Phone Number' columns in the web app

varsobject

Custom variables stored for this data table. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

solution_idstring nullable

ID of the solution that this data table belongs to, if any

project_idstring

ID of the project this data table belongs to

urlstring

URL to this data table in the Telerivet web app

Example response

{
  "id": "DTf9f77c9ba69cce50",
  "name": "Poll Responses",
  "num_rows": 1032,
  "show_stats": true,
  "show_contact_columns": true,
  "solution_id": "SO2ad0100821a98bea",
  "project_id": "PJ2ad0100821a98bea",
  "url": "https://telerivet.com/p/asdf/data/Poll_20Responses"
}

Changes

No recorded changes to this operation across all 1 revision of this API.