Properties & metrics
Overview
The columns
parameter defines which properties and metrics to include in your API response. You can reference available properties and metrics from your Data Model configuration.
Parameters
Parameter | Description | Values | Required |
---|---|---|---|
columns | Array of properties and metrics to retrieve | Array of strings (property/metric names) | Yes |
Column Format
- Properties: Use the property key directly (e.g.,
"device_type"
) - Metrics: Use the metric key directly (e.g.,
"m_visits"
) - Period-specific metrics: Prefix with period identifier (e.g.,
"p1.m_visits"
)
Data Model Reference
To find available properties and metrics, visit your Data Model and look for the property key.
Examples
Example 1: Single period query
Basic request with device type property and visits metric.
{
"columns": ["device_type", "m_visits"]
}
Example 2: Multiple periods comparison
Compare visits across different periods.
{
"columns": ["device_type", "p1.m_visits", "p2.m_visits"]
}
Example 3: Multiple properties and metrics
Comprehensive analysis with geography, device, and various metrics.
{
"columns": [
"geo_country",
"device_type",
"m_visits",
"m_users",
"m_bounce_rate"
]
}