Table Tags

class Table_Tags(session_kwargs, client, return_type='raw')

Methods

`delete`(id)	Delete a Table Tag
`get`(id)	Get a Table Tag
`list`(*[, name, limit, page_num, order, ...])	List Table Tags
`post`(name)	Create a Table Tag

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.table_tags.list(...)

delete(id: int) → Response

Delete a Table Tag

Parameters:

Returns:

get(id: int) → Response

Get a Table Tag

Parameters:

Returns:

civis.Response

list(*, name: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → list[Response] | PaginatedResponse

List Table Tags

Parameters:

namestr, optional: Name of the tag. If it is provided, the results will be filtered by name
limitint, optional: Number of results to return. Defaults to 50. Maximum allowed is 1000.
page_numint, optional: Page number of the results to return. Defaults to the first page, 1.
orderstr, optional: The field on which to order the result set. Defaults to name. Must be one of: name, user, table_count.
order_dirstr, optional: Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.
iteratorbool, optional: If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a list of civis.Response objects, whose size is determined by ‘limit’. Defaults to False.

Returns:

civis.PaginatedResponse

post(name: str) → Response

Create a Table Tag

Parameters:

Returns:

civis.Response