Ontology

class Ontology(session_kwargs, client, return_type='raw')

Civis API /ontology endpoint:

import civis
client = civis.APIClient()
# Call client.ontology.<method>(<arguments>) to make a request, e.g.:
client.ontology.list(...)

Methods

list(*[, subset])

List the ontology of column names Civis uses

list(*, subset: str = None) → ListResponse

List the ontology of column names Civis uses

API URL: GET /ontology

Parameters:

subsetstr, optional

A subset of fields to return.

Returns:

civis.ListResponse

• key : str

• title : str

• descstr

  A description of this field.

• aliases : List[str]