Get
/query/fields
Retrieve a list of currently available data source fields and custom fields
Security
HTTP
Type bearer
Bearer token authentication. Include the token in the Authorization header:
Authorization: Bearer <your-token>
Query parameters
json
Required
object
api_key
string
API key when not using an authorization header
ds_id
string Required
Data source ID
ds_accounts
List of data source account IDs to return custom fields for
OneOf
string
string
array
array
string
ds_users
List of data source usernames to limit to (required when ds_accounts is defined)
OneOf
string
string
array
array
string
Responses
200
Fields retrieved successfully
object
meta
object
request_id
string
API request ID
data
Array of object
object
@type
string
Type of the field
Valid values[
"ds_dimension",
"ds_metric"
]
field_id
string
Field ID (note that this value can change)
field_name
string
Field name
field_type
string
Field type
Valid values[
"dim",
"met"
]
data_type
string
Field data type
description
string
Field description
group_name
string
Field group name in product UIs (always in uppercase)
is_filterable
boolean
Whether field can be used in query filter string
is_non_aggregatable
boolean
Whether metric value is non-aggregatable (only for metrics)