How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Optimizely Websites API

The Websites API from Optimizely — 41 operation(s) for websites.

Optimizely Websites API is one of 420 APIs that Optimizely publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Websites. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 45 operations across 41 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://dogfood.commerce.insitesandbox.com.

45 operations 41 paths 43 schemas 3 DELETE38 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://exp.mcp.opal.optimizely.com/mcp
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Optimizely Websites API declares 1 security scheme for authenticating requests. An API key is passed in the query as access_token (access_token).

  • access_token — Token used to access storefront API.

Paths & Operations 45

Across 41 paths, the API surfaces 45 operations — 3 DELETE, 38 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Websites 45
GET
/api/v1/admin/Websites
Returns the EntitySet Websites
Websites_Get 8 params → 200
POST
/api/v1/admin/Websites
Post a new entity to EntitySet Websites
Websites_Post body → 200
GET
/api/v1/admin/Websites({id})
Returns the entity with the key from Websites
Websites_GetById 3 params → 200
PUT
/api/v1/admin/Websites({id})
Replace entity in EntitySet Websites
Websites_PutById 1 param body → 200
DELETE
/api/v1/admin/Websites({id})
Delete entity in EntitySet Websites
Websites_DeleteById 2 params → 200
PATCH
/api/v1/admin/Websites({id})
Update entity in EntitySet Websites
Websites_PatchById 1 param body → 200
GET
/api/v1/admin/Websites/Default.Default()
Call operation Default
Websites_Default → 200
POST
/api/v1/admin/Websites/Default.archive
Call operation archive
Websites_Archive 1 param body → 200
GET
/api/v1/admin/Websites({id})/Default.userProfilesWithRolesFilter()
Call operation userProfilesWithRolesFilter
Websites_GetUserProfilesWithRolesFilterById 3 params → 200
GET
/api/v1/admin/websites({key})/userProfilesWithRolesFilter
Websites_GetUserProfilesWithRolesFilterByKey 3 params → 200
GET
/api/v1/admin/websites/IsMicrositeUrlInUseByContent
Websites_IsMicrositeUrlInUseByContent 3 params → 200
DELETE
/api/v1/admin/websites/archive
Websites_ArchiveRoute 1 param → 200
DELETE
/api/v1/admin/websites/delete
Websites_DeleteRoute 1 param → 200
GET
/api/v1/admin/websites({key})/adminuserprofiles({adminuserprofileKey})
Websites_GetAdminUserProfileByKeyAndAdminuserprofilekey 4 params → 200
GET
/api/v1/admin/websites({key})/applicationmessages({applicationmessageKey})
Websites_GetApplicationMessageByKeyAndApplicationmessagekey 4 params → 200
GET
/api/v1/admin/websites({key})/billtoaddressfields({billtoaddressfieldKey})
Websites_GetBillToAddressFieldByKeyAndBilltoaddressfieldkey 4 params → 200
GET
/api/v1/admin/websites({key})/carriers({carrierKey})
Websites_GetCarrierByKeyAndCarrierkey 4 params → 200
GET
/api/v1/admin/websites({key})/categories({categoryKey})
Websites_GetCategoryByKeyAndCategorykey 4 params → 200
GET
/api/v1/admin/websites({key})/countries({countryKey})
Websites_GetCountryByKeyAndCountrykey 4 params → 200
GET
/api/v1/admin/websites({key})/crosssells({productKey})
Websites_GetCrossSellByKeyAndProductkey 4 params → 200
GET
/api/v1/admin/websites({key})/customers({customerKey})
Websites_GetCustomerByKeyAndCustomerkey 4 params → 200
GET
/api/v1/admin/websites({key})/customproperties({custompropertyKey})
Websites_GetCustomPropertyByKeyAndCustompropertykey 4 params → 200
GET
/api/v1/admin/websites({key})/dealers({dealerKey})
Websites_GetDealerByKeyAndDealerkey 4 params → 200
GET
/api/v1/admin/websites({key})/experiments({experimentKey})
Websites_GetExperimentByKeyAndExperimentkey 4 params → 200
GET
/api/v1/admin/websites({key})/promotions({promotionKey})
Websites_GetPromotionByKeyAndPromotionkey 4 params → 200
GET
/api/v1/admin/websites({key})/restrictiongroups({restrictiongroupKey})
Websites_GetRestrictionGroupByKeyAndRestrictiongroupkey 4 params → 200
GET
/api/v1/admin/websites({key})/shiptoaddressfields({shiptoaddressfieldKey})
Websites_GetShipToAddressFieldByKeyAndShiptoaddressfieldkey 4 params → 200
GET
/api/v1/admin/websites({key})/states({stateKey})
Websites_GetStateByKeyAndStatekey 4 params → 200
GET
/api/v1/admin/websites({key})/systemsettings({systemsettingKey})
Websites_GetSystemSettingByKeyAndSystemsettingkey 4 params → 200
GET
/api/v1/admin/websites({key})/userprofiles({userprofileKey})
Websites_GetUserProfileByKeyAndUserprofilekey 4 params → 200
GET
/api/v1/admin/websites({key})/warehouses({warehouseKey})
Websites_GetWarehouseByKeyAndWarehousekey 4 params → 200
GET
/api/v1/admin/websites({key})/websitecurrencies({websitecurrencyKey})
Websites_GetWebsiteCurrencyByKeyAndWebsitecurrencykey 4 params → 200
GET
/api/v1/admin/websites({key})/websitelanguages({websitelanguageKey})
Websites_GetWebsiteLanguageByKeyAndWebsitelanguagekey 4 params → 200
GET
/api/v1/websites/current/countries
CountriesV1_GetCollectionAsync → 200
GET
/api/v1/websites/current/countries/{countryId}
CountriesV1_GetAsync 1 param → 200
GET
/api/v1/websites/current
WebsitesV1_GetAsync → 200
GET
/api/v1/websites/current/sitemessages
SiteMessagesV1_GetAsync 5 params → 200
GET
/api/v1/websites/current/states
StatesV1_GetCollectionAsync → 200
GET
/api/v1/websites/current/states/{stateId}
StatesV1_GetAsync 1 param → 200
GET
/api/v1/websites/current/languages
LanguagesV1_GetCollectionAsync → 200
GET
/api/v1/websites/current/languages/{languageId}
LanguagesV1_GetAsync 1 param → 200
GET
/api/v1/websites/current/addressfields
AddressFieldsV1_GetAsync → 200
GET
/api/v1/websites/current/currencies
CurrenciesV1_GetCollectionAsync → 200
GET
/api/v1/websites/current/currencies/{currencyId}
CurrenciesV1_GetAsync 1 param → 200
GET
/api/v1/websites/current/crosssells
ProductsV1_GetCrossSellsAsync → 200

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are Insite.Catalog.Services.Dtos.ProductDto (114 properties), Insite.Core.Plugins.Pricing.ProductPriceDto (43 properties), Insite.Catalog.Services.Dtos.StyledProductDto (38 properties), Insite.Data.Entities.Website (36 properties). Each schema is shown below with its type and property counts.

Insite.Data.Entities.Website
object
36 properties 16 required
Insite.Websites.WebApi.V1.ApiModels.CountryModel
object
6 properties
Insite.Catalog.Services.Dtos.ConfigSectionOptionDto
object
11 properties
Insite.Core.WebApi.PaginationModel
object
12 properties
Insite.Websites.WebApi.V1.ApiModels.CurrencyModel
object
7 properties
Insite.Catalog.Services.Dtos.ConfigSectionDto
object
3 properties
Insite.Websites.WebApi.V1.ApiModels.StateCollectionModel
object
3 properties
Insite.Catalog.Services.Dtos.BadgeDto
object
19 properties
Insite.Catalog.Services.Dtos.BrandDto
object
7 properties
Insite.Catalog.Services.Dtos.RelatedProductDto
object
2 properties
Insite.Core.Plugins.Search.Dtos.ScoreExplanationDto
object
3 properties
Insite.Core.WebApi.SortOptionModel
object
2 properties
Insite.Catalog.WebApi.V1.ApiModels.CrossSellCollectionModel
object
3 properties
Insite.Catalog.Services.Dtos.StyleTraitDto
object
9 properties
Insite.Catalog.Services.Dtos.ProductSubscriptionDto
object
19 properties
Insite.Core.Plugins.Search.Dtos.FieldScoreDetailedDto
object
7 properties
Insite.Catalog.Services.Dtos.LegacyConfigurationDto
object
3 properties
Insite.Catalog.Services.Dtos.DocumentDto
object
9 properties
Insite.Core.Plugins.Pricing.ProductPriceDto
object
43 properties
Insite.Websites.WebApi.V1.ApiModels.CountryCollectionModel
object
3 properties
Insite.Catalog.Services.Dtos.StyledProductDto
object
38 properties
Insite.Catalog.Services.Dtos.AttributeTypeDto
object
10 properties
Insite.Catalog.Services.Dtos.StyleValueDto
object
10 properties
Insite.Websites.WebApi.V1.ApiModels.SiteMessageModel
object
4 properties
Insite.Websites.WebApi.V1.ApiModels.AddressFieldCollectionModel
object
4 properties
Insite.Catalog.Services.Dtos.WarehouseDto
object
7 properties
Insite.Websites.WebApi.V1.ApiModels.LanguageModel
object
11 properties
Insite.Catalog.Services.Dtos.AvailabilityDto
object
3 properties
Insite.Websites.WebApi.V1.ApiModels.SiteMessageCollectionModel
object
4 properties
Insite.Websites.WebApi.V1.ApiModels.WebsiteModel
object
31 properties
Insite.Core.Plugins.Pricing.BreakPriceDto
object
6 properties
Insite.Catalog.Services.Dtos.ProductDto
object
114 properties
Insite.Catalog.Services.Dtos.AttributeValueDto
object
5 properties
Insite.Websites.WebApi.V1.ApiModels.LanguageCollectionModel
object
3 properties
Insite.Websites.WebApi.V1.ApiModels.AddressFieldDisplayModel
object
4 properties
Insite.Catalog.Services.Dtos.ProductImageDto
object
8 properties
Insite.Catalog.Services.Dtos.ProductLineDto
object
2 properties
Insite.Websites.WebApi.V1.ApiModels.StateModel
object
5 properties
Insite.Core.Plugins.Search.Dtos.FieldScoreDto
object
2 properties
Insite.Catalog.Services.Dtos.SpecificationDto
object
10 properties
Insite.Websites.WebApi.V1.ApiModels.AddressFieldDisplayCollectionModel
object
18 properties
Insite.Catalog.Services.Dtos.ProductUnitOfMeasureDto
object
8 properties
Insite.Websites.WebApi.V1.ApiModels.CurrencyCollectionModel
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

optimizely-websites-api-openapi.yml Raw ↑

Other APIs Optimizely publishes across the network.

Optimizely Remote MCP Server — Experimentation
Optimizely Assets API
Optimizely Attributes API
Optimizely Audiences API
Optimizely Campaigns API
Optimizely Catalog Entries API
Optimizely Catalog Entry Relations API
Optimizely Catalog Nodes API
Optimizely Catalogs API
Optimizely Content API
Optimizely Content Types API
Optimizely Customers API
Where this information came from

This is an independent, third-party profile of Optimizely Websites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.