List Dimensions

GET

https://api.webflow.com/v2/optimize/:optimize_id/optimizations/:optimization_id/dimensions

GET

/v2/optimize/:optimize_id/optimizations/:optimization_id/dimensions

curl -G https://api.webflow.com/v2/optimize/117420042/optimizations/417200971/dimensions \
     -H "Authorization: Bearer <token>" \
     --data-urlencode intervalStart=2026-09-01T00:00:00Z \
     --data-urlencode intervalEnd=2026-09-15T00:00:00Z

{
  "intervalStart": "2026-09-01T00:00:00.000Z",
  "intervalEnd": "2026-09-15T00:00:00.000Z",
  "dimensions": [
    {
      "id": "audienceIds",
      "name": "Audiences"
    },
    {
      "id": "country",
      "name": "Country"
    },
    {
      "id": "region",
      "name": "Region"
    },
    {
      "id": "city",
      "name": "City"
    },
    {
      "id": "dma",
      "name": "DMA"
    },
    {
      "id": "locale",
      "name": "Locale"
    },
    {
      "id": "timeOfDay",
      "name": "Time of Day"
    },
    {
      "id": "weekPart",
      "name": "Week Part"
    },
    {
      "id": "deviceType",
      "name": "Device"
    },
    {
      "id": "deviceBrand",
      "name": "Device Brand"
    },
    {
      "id": "operatingSystem",
      "name": "Operating System"
    },
    {
      "id": "browser",
      "name": "Browser"
    },
    {
      "id": "timeZone",
      "name": "Time Zone"
    },
    {
      "id": "trafficSource",
      "name": "Traffic Source"
    },
    {
      "id": "utmSource",
      "name": "Campaign Source"
    },
    {
      "id": "utmMedium",
      "name": "Campaign Medium"
    },
    {
      "id": "utmCampaign",
      "name": "Campaign Name"
    },
    {
      "id": "utmTerm",
      "name": "Campaign Term"
    },
    {
      "id": "utmContent",
      "name": "Campaign Content"
    },
    {
      "id": "userVisitStatus",
      "name": "New / Returning Visitor"
    },
    {
      "id": "urlParameter",
      "name": "URL Parameter"
    },
    {
      "id": "hostingPageDomain",
      "name": "Hosting Page Domain"
    },
    {
      "id": "pagePath",
      "name": "Page Path"
    }
  ]
}

Lists the dimensions you can group or filter an optimization’s reports by, for a date range within one interval. Use a dimension’s id in groupBy, in filter, or to list its values.

Optimize required

This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.

Concurrency limit: 1 request at a time

Each access token can have one Optimize request in flight at a time, across all Optimize endpoints. Additional concurrent requests return 429 Too Many Requests. Wait for your in-flight request to finish, or for the Retry-After interval, then retry.

Required scope | sites:read

Authentication

AuthorizationBearer

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

Path parameters

optimize_idstringRequired>=1 character

The Optimize ID, from List Optimize IDs.

optimization_idstringRequired1-128 characters

The optimization ID, from List Optimizations.

Query parameters

intervalStartstringRequiredformat: "date-time"

Start of the date range. Must be a UTC timestamp ending in Z, such as 2026-09-01T00:00:00Z. Offsets and date-only values aren’t accepted. Seconds and milliseconds are optional. The date range must fall within a single interval of the optimization. A range that crosses from one interval into the next is rejected. Use an interval’s start and end from List Optimizations. Can’t be earlier than 18 months ago.

intervalEndstringRequiredformat: "date-time"

End of the date range. Must be a UTC timestamp ending in Z, such as 2026-09-15T00:00:00Z, and later than intervalStart. Offsets and date-only values aren’t accepted. Seconds and milliseconds are optional.

Response

The dimensions available for the requested date range.

intervalStartstringformat: "date-time"

Start of the reported date range, in full form with milliseconds.

intervalEndstringformat: "date-time"

End of the reported date range, in full form with milliseconds.

dimensionslist of objects

The available dimensions.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error