Skip to navigation
Optimize

List Optimizations

Lists the optimizations for an optimizeId, with each one’s type, status, intervals, and current goals. Returns live and draft optimizations unless you set status.

Each report covers a date range within a single interval of an optimization. Use an interval’s start and end to choose a report’s intervalStart and intervalEnd.

Each interval lists its goals as they were when it started. currentGoals lists the optimization’s goals as they’re set up now, and each goal’s source shows where it comes from. A report accepts a goalId from either list.

Results are sorted by optimizationId, and each optimization’s intervals are listed oldest first. To get the next page, pass nextCursor as cursor.

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.

Query parameters

statuslist of enumsOptionalDefaults to ["live","draft"]

The statuses to include. Defaults to live and draft. Pass repeated values (status=live&status=draft) or a comma-separated list (status=live,draft).

A cursor keeps the statuses it was created with. When you pass a cursor, omit status or send the same statuses.

Allowed values:
pageSizeintegerOptional1-200Defaults to 100

The maximum number of results to return. Defaults to 100, up to 200.

cursorstringOptional>=1 character

The nextCursor from a previous response, to get the next page.

Response

A page of optimizations.
optimizationslist of objects

The optimizations on this page, sorted by optimizationId.

statuslist of enums
The statuses this list includes.
Allowed values:
nextCursorstringOptional

Pass this value as cursor to get the next page. Omitted on the last page.

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