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)

Delete a Table Tag

Parameters:
idint
Returns:
None

Response code 204: success

get(id: int)

Get a Table Tag

Parameters:
idint
Returns:
civis.response.Response
  • idint

    Table Tag ID

  • namestr

    Table Tag Name

  • created_atstr (date-time)

    The date the tag was created.

  • updated_atstr (date-time)

    The date the tag was recently updated on.

  • table_countint

    The total number of tables associated with the tag.

  • userdict
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.

list(*, name: str = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None)

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 to iterate over all responses. Use when more results than the maximum allowed by limit are needed. When True, limit and page_num are ignored. Defaults to False.

Returns:
civis.response.PaginatedResponse
  • idint

    Table Tag ID

  • namestr

    Table Tag Name

  • table_countint

    The total number of tables associated with the tag.

  • userdict
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.

post(name: str)

Create a Table Tag

Parameters:
namestr

Table Tag Name

Returns:
civis.response.Response
  • idint

    Table Tag ID

  • namestr

    Table Tag Name

  • created_atstr (date-time)

    The date the tag was created.

  • updated_atstr (date-time)

    The date the tag was recently updated on.

  • table_countint

    The total number of tables associated with the tag.

  • userdict
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.