HIhightouch

Get Model

Changed on

Retrieve models from model ID

get/models/{modelId}

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Path parameters

modelIdnumber double required

The id of the model

Response

Ok

idnumber double required

The id of the model

namestring required

The name of the model

slugstring required

The slug of the model

descriptionstring nullable required

The description of the model. Null when no description has been set.

workspaceIdnumber double required

The id of the workspace where the model belongs to

primaryKeystring required

The primary key will be null if the query doesn't get directly synced (e.g. a relationship table for visual querying)

createdAtstring date-time required

The timestamp when model was created

updatedAtstring date-time required

The timestamp when model was lastly updated

sourceIdnumber double required

The id of the source that model is connected to

queryTypestring required

The type of the query. Available options: custom, raw_sql, tabel, dbt and visual.

tagsobject required

The tags of the model

isSchemaboolean required

If is_schema is true, the model is just used to build other models. Either as part of visual querying, or as the root of a visual query.

isGeneralModelboolean required

If is_general_model is true, the model is not synced. It exposes warehouse data to Hightouch AI agents and is managed from the schema section.

syncsnumber[] required

The list of id of syncs that uses this model

folderIdstring
lastRunSizenumber double nullable required

The number of rows returned by the most recent successful sync run of this model. Null if the model has never been synced successfully.

spaceIdstring

The Space this audience belongs to. Applies only to workspaces with Spaces enabled; contact Hightouch to enable Spaces and to obtain Space ids. Only valid when queryType is "visual". Omitted for models that are not in a Space. An API key scoped to a Space must set it on create. Read-only after creation.

rowLevelAccessRuleIdsstring[]

Row-level access rules attached to this audience. Applies only to workspaces with Spaces enabled. Only valid when queryType is "visual"; always present on an audience. When creating an audience in a Space, include one rule from each required row-level access group on the parent model. Rule ids come from the Spaces governance API. Read-only after creation.

Changes

  • 5574262d4032Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d508533e9bbRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status