Skip to main content
GET
Retrieve all metadata fields for an analysis model

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

model_id
integer
required

The analysis model ID

Response

Successful Response

id
integer
required

Unique identifier

Example:

1

client_prompt_template_id
integer
required

Parent model ID

Example:

1

key
string
required

Metadata key

Example:

"campaign"

readable_name
string
required

Human-readable display name

Example:

"Campaign Name"

type
enum<string>
required

Data type

Available options:
STRING,
INTEGER,
DECIMAL,
BOOLEAN,
DATE,
TIME,
DATETIME
grouping_field
boolean
required

Whether used for dashboard grouping

Example:

false

enabled
boolean
required

Whether the metadata is active

created_at
string<date-time>
required

Creation timestamp

created_by
string
required

Creator identifier

updated_at
string<date-time>

Last update timestamp

updated_by
string

Last updater identifier