List Optimization Goals

GET

https://api.webflow.com/beta/optimize/:optimize_id/optimizations/:optimization_id/goals

GET

/beta/optimize/:optimize_id/optimizations/:optimization_id/goals

curl -G https://api.webflow.com/beta/optimize/117420042/optimizations/417200971/goals \
     -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",
  "goals": [
    {
      "goalId": "198042421",
      "name": "Towel purchase",
      "isPrimary": true,
      "metricType": "value",
      "scope": "session",
      "countingMethod": "unique"
    },
    {
      "goalId": "198042422",
      "name": "Newsletter signup",
      "isPrimary": false,
      "metricType": "conversion",
      "scope": "user",
      "countingMethod": "unique"
    },
    {
      "goalId": "198042423",
      "name": "Guide entries read",
      "isPrimary": false,
      "metricType": "conversion",
      "scope": "pageview",
      "countingMethod": "cumulative"
    }
  ]
}

Lists an optimization’s goals for the interval that contains the requested date range, and whether each is a target goal. Use a goalId from this list to choose the goal a report measures.

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

Lists an optimization's goals for the interval that contains the requested date range, and whether each is a target goal. Use a `goalId` from this list to choose the goal a report measures. <Warning title="Optimize required">This endpoint requires a Webflow site with the Optimize add-on, or a non-Webflow site that uses Optimize.</Warning> <Note title="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.</Note> 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. Unlike the report endpoints, this endpoint has no 18-month limit.

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](/data/v2.0.0-beta/reference/optimize/list-optimizations). Unlike the report endpoints, this endpoint has no 18-month limit.

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 optimization's goals for the interval that contains 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.

goalslist of objects

The goals configured for the interval.

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