analytics_custom_dimensions_list
Read-only
Retrieve a list of custom dimensions for a website, optionally filtered by scope (session, event, or product).
Instructions
List custom dimensions, optionally filtered by scope.
Args:
website_id: Website/App UUID
scope: Optional scope filter:
- "session": Returns only session-scoped dimensions
- "event": Returns only event-scoped dimensions
- "product": Returns only product dimensions
- None (default): Returns both standard and product dimensions separately
limit: Maximum number of rows to return (default: 10, min: 1, max: 100000)
Note: Only applies to standard dimensions (session/event). Product dimensions
are not paginated by the API.
offset: Number of rows to skip (default: 0, min: 0)
Note: Only applies to standard dimensions (session/event).
Returns:
- If scope is "session" or "event": CustomDimensionsList (filtered by scope)
- If scope is "product": ProductCustomDimensionsList
- If scope is None: UnifiedCustomDimensionsList with both standard and product dimensions
Raises:
RuntimeError: If API request fails
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| website_id | Yes | ||
| scope | No | ||
| limit | No | ||
| offset | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |