table_tags_list: List Table Tags

In civis: R Client for the 'Civis Platform API'

List Table Tags

Description

List Table Tags

Usage

table_tags_list(
  name = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

name	string optional. Name of the tag. If it is provided, the results will be filtered by name
limit	integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000.
page_num	integer optional. Page number of the results to return. Defaults to the first page, 1.
order	string optional. The field on which to order the result set. Defaults to name. Must be one of: name, user, table_count.
order_dir	string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

id	integer, Table Tag ID
name	string, Table Tag Name
tableCount	integer, The total number of tables associated with the tag.
user	list, A list containing the following elements: id integer, The ID of this user. name string, This user's name. username string, This user's username. initials string, This user's initials. online boolean, Whether this user is online.

civis documentation built on April 1, 2023, 12:01 a.m.