Optimizely Graph API

{"openapi":"3.0.0","components":{"examples":{},"headers":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"BestBetCollectionResult":{"properties":{"title":{"type":"string"},"id":{"type":"string"}},"required":["title","id"],"type":"object","additionalProperties":false},"BestBetCollectionPayload":{"properties":{"title":{"type":"string"}},"required":["title"],"type":"object","additionalProperties":false},"CacheInvalidationConfig":{"properties":{"enabled":{"type":"boolean","default":true}},"type":"object","additionalProperties":false},"SourceInfo":{"properties":{"languages":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"label":{"type":"string"},"id":{"type":"string"}},"required":["languages","description","label","id"],"type":"object"},"SourceInfoMap":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/SourceInfo"},"type":"object","example":{"default":{"id":"default","label":"default","description":"","languages":["en"]}}},"Slot":{"enum":["new","old"],"type":"string"},"DeleteMode":{"enum":["types","data","reset"],"type":"string"},"SourceMetadata":{"properties":{"label":{"type":"string"},"description":{"type":"string"}},"required":["label","description"],"type":"object","additionalProperties":false},"LinkConfig":{"properties":{"to":{"type":"string"},"from":{"type":"string"}},"required":["to","from"],"type":"object"},"LinkMap":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/LinkConfig"},"type":"object"},"Optional_string_":{"type":"string","nullable":true},"Property_V2":{"properties":{"index":{"type":"boolean"},"searchable":{"type":"boolean"},"type":{"type":"string"},"name":{"type":"string"}},"required":["type","name"],"type":"object"},"ContentTypeProperty_V2":{"allOf":[{"$ref":"#/components/schemas/Property_V2"},{"properties":{"helpText":{"$ref":"#/components/schemas/Optional_string_"}},"type":"object"}]},"ContentType_V2":{"properties":{"properties":{"items":{"$ref":"#/components/schemas/ContentTypeProperty_V2"},"type":"array"},"abstract":{"type":"boolean"},"base":{"type":"string"},"description":{"$ref":"#/components/schemas/Optional_string_"},"sortOrder":{"type":"number","format":"double"},"displayName":{"$ref":"#/components/schemas/Optional_string_"},"contentType":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"}},"required":["properties","contentType","name"],"type":"object"},"PropertyType_V2":{"properties":{"properties":{"items":{"$ref":"#/components/schemas/Property_V2"},"type":"array"},"name":{"type":"string"}},"required":["name"],"type":"object"},"ContentSource_V2":{"properties":{"useTypedFieldNames":{"type":"boolean"},"languages":{"items":{"type":"string"},"type":"array","default":[]},"links":{"$ref":"#/components/schemas/LinkMap"},"contentTypes":{"items":{"$ref":"#/components/schemas/ContentType_V2"},"type":"array","default":[]},"propertyTypes":{"items":{"$ref":"#/components/schemas/PropertyType_V2"},"type":"array","default":[]}},"type":"object","additionalProperties":false,"example":{"languages":["en"],"links":{},"contentTypes":[{"name":"IContent","contentType":[],"properties":[{"name":"id","type":"string"},{"name":"Name","type":"string"}]},{"name":"StartPage","contentType":["IContent"],"properties":[{"name":"MainBody","type":"string"},{"name":"MainContentArea","type":"string"}]}],"propertyTypes":[]}},"FieldRef":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"type":"object"},"ContentTypeProperty_V3":{"properties":{"type":{"type":"string"},"searchable":{"type":"boolean"},"index":{"type":"boolean"},"ref":{"$ref":"#/components/schemas/FieldRef"},"helpText":{"$ref":"#/components/schemas/Optional_string_"}},"required":["type"],"type":"object","additionalProperties":false},"ContentType_V3":{"properties":{"contentType":{"items":{"type":"string"},"type":"array"},"properties":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/ContentTypeProperty_V3"},"type":"object"},"displayName":{"$ref":"#/components/schemas/Optional_string_"},"sortOrder":{"type":"number","format":"double"},"description":{"$ref":"#/components/schemas/Optional_string_"},"base":{"type":"string"},"abstract":{"type":"boolean"}},"required":["contentType"],"type":"object","additionalProperties":false},"ContentTypeMap_V3":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/ContentType_V3"},"type":"object"},"Property_V3":{"properties":{"type":{"type":"string"},"searchable":{"type":"boolean"},"index":{"type":"boolean"},"ref":{"$ref":"#/components/schemas/FieldRef"}},"required":["type"],"type":"object","additionalProperties":false},"PropertyType_V3":{"properties":{"base":{"type":"string"},"abstract":{"type":"boolean"},"properties":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/Property_V3"},"type":"object"}},"type":"object","additionalProperties":false},"PropertyTypeMap_V3":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/PropertyType_V3"},"type":"object"},"Preset":{"type":"string","enum":["legacy","next"]},"ContentSource_V3":{"properties":{"preset":{"$ref":"#/components/schemas/Preset"},"useTypedFieldNames":{"type":"boolean"},"description":{"$ref":"#/components/schemas/Optional_string_"},"label":{"$ref":"#/components/schemas/Optional_string_"},"links":{"$ref":"#/components/schemas/LinkMap"},"propertyTypes":{"$ref":"#/components/schemas/PropertyTypeMap_V3"},"contentTypes":{"$ref":"#/components/schemas/ContentTypeMap_V3"},"languages":{"items":{"type":"string"},"type":"array","default":[]}},"type":"object","additionalProperties":false,"example":{"label":"Weather Forecast","description":"The description of source","languages":["en"],"links":{},"contentTypes":{"Weather":{"contentType":[],"properties":{"Location":{"type":"Location"},"Description":{"type":"String"},"Temperature":{"type":"Int"}}}},"propertyTypes":{"Location":{"properties":{"Latitude":{"type":"Float"},"Longitude":{"type":"Float"}}}}}},"Response":{"description":"This Fetch API interface represents the response to a request.\n\n[MDN Reference](https://developer.mozilla.org/docs/Web/API/Response)","properties":{},"type":"object","additionalProperties":false},"Record_string.any_":{"properties":{},"additionalProperties":{},"type":"object","description":"Construct a type with a set of properties K of type T"},"GraphQLResponse":{"properties":{"data":{"$ref":"#/components/schemas/Record_string.any_"},"extensions":{"$ref":"#/components/schemas/Record_string.any_"}},"type":"object","additionalProperties":false},"GraphQLRequest":{"properties":{"query":{"type":"string"},"mutation":{"type":"string"},"operationName":{"type":"string"},"variables":{"anyOf":[{"properties":{},"additionalProperties":{"type":"string"},"type":"object"},{"type":"string"}]}},"type":"object","additionalProperties":false},"TokenClaims":{"properties":{"audience":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"issuer":{"type":"string"}},"required":["audience","issuer"],"type":"object","additionalProperties":false},"PinnedCollectionResult":{"properties":{"title":{"type":"string"},"key":{"type":"string"},"isActive":{"type":"boolean","default":false},"id":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["title","key","id","createdAt","updatedAt"],"type":"object","additionalProperties":false},"PinnedCollectionPayload":{"properties":{"title":{"type":"string"},"key":{"type":"string"},"isActive":{"type":"boolean","default":false}},"required":["title","key"],"type":"object","additionalProperties":false},"Partial_PinnedCollectionPayload_":{"properties":{"title":{"type":"string"},"key":{"type":"string"},"isActive":{"type":"boolean","default":false}},"type":"object","description":"Make all properties in T optional"},"PinnedItemResult":{"properties":{"phrases":{"type":"string","description":"Phrase or keyword to match"},"targetKey":{"type":"string","description":"Document id to pin"},"language":{"type":"string","nullable":true,"description":"Language code (e.g. `en`, `fr`, `de`, etc.)\n\n- `null` value means the pinned item is applicable to all languages\n\n- Empty string (`\"\"`) value is for NEUTRAL locale","default":null},"priority":{"type":"number","format":"double","description":"Priority of the pinned item (lower number means lower priority)\n\n- Default value is `1000`\n\n- Example: `1`, `10`, `100`, etc.","default":1000},"isActive":{"type":"boolean","default":true},"id":{"type":"string"},"collectionId":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["phrases","targetKey","id","collectionId","createdAt","updatedAt"],"type":"object","additionalProperties":false},"PinnedItemPayload":{"properties":{"phrases":{"type":"string","description":"Phrase or keyword to match"},"targetKey":{"type":"string","description":"Document id to pin"},"language":{"type":"string","nullable":true,"description":"Language code (e.g. `en`, `fr`, `de`, etc.)\n\n- `null` value means the pinned item is applicable to all languages\n\n- Empty string (`\"\"`) value is for NEUTRAL locale","default":null},"priority":{"type":"number","format":"double","description":"Priority of the pinned item (lower number means lower priority)\n\n- Default value is `1000`\n\n- Example: `1`, `10`, `100`, etc.","default":1000},"isActive":{"type":"boolean","default":true}},"required":["phrases","targetKey"],"type":"object","additionalProperties":false},"PinnedResultMatchParams":{"properties":{"phrase":{"type":"string"},"collectionIds":{"items":{"type":"string"},"type":"array"},"collectionKeys":{"items":{"type":"string"},"type":"array"},"languages":{"items":{"type":"string","nullable":true},"type":"array","nullable":true},"onlyActive":{"type":"boolean"},"limit":{"type":"number","format":"double"}},"required":["phrase"],"type":"object","additionalProperties":false},"RequestLog":{"properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"instanceId":{"type":"string"},"status":{"type":"string"},"method":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"operationType":{"type":"string"},"operationName":{"type":"string"},"message":{"type":"string"},"duration":{"type":"number","format":"double"},"user":{"type":"string"},"success":{"type":"boolean","default":true}},"required":["id","createdAt"],"type":"object","additionalProperties":false},"StopwordsBody":{"type":"string","example":"the\nSchwarzenegger\namy\nBob"},"SynonymsBody":{"type":"string","example":"H20 => water\nSiteseeker, Welcome, Episerver => Optimizely\nWilliam Henry Gates III => Bill Gates"},"Record_string.string_":{"properties":{},"additionalProperties":{"type":"string"},"type":"object","description":"Construct a type with a set of properties K of type T"},"Request":{"properties":{"url":{"type":"string"},"method":{"type":"string"},"headers":{"$ref":"#/components/schemas/Record_string.string_"}},"required":["url"],"type":"object","additionalProperties":false},"OperationMap":{"properties":{"in":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"eq":{"type":"string"}},"type":"object"},"Partial_Record_string.OperationMap__":{"properties":{},"additionalProperties":{"$ref":"#/components/schemas/OperationMap"},"type":"object","description":"Make all properties in T optional"},"FilterMap":{"$ref":"#/components/schemas/Partial_Record_string.OperationMap__"},"WebhookPayload":{"description":"The `WebhookPayload` type represents the payload of a webhook request, which includes information\nabout the request, filters, and whether the webhook is disabled.","properties":{"disabled":{"type":"boolean"},"request":{"$ref":"#/components/schemas/Request"},"topics":{"items":{"type":"string"},"type":"array"},"filters":{"anyOf":[{"items":{"$ref":"#/components/schemas/Partial_Record_string.OperationMap__"},"type":"array"},{"$ref":"#/components/schemas/Partial_Record_string.OperationMap__"}]}},"required":["request"],"type":"object","additionalProperties":false,"example":{"disabled":false,"request":{"url":"https://webhook.site/191a5568-31fe-49ac-bde5-ed2f7dad6918","method":"POST","headers":{"test-header-key":"test-header-value"}},"topics":["doc.*"],"filters":[{"status":{"in":["Published","Created"]}}]}},"Webhook":{"allOf":[{"$ref":"#/components/schemas/WebhookPayload"},{"properties":{"preset":{"$ref":"#/components/schemas/Preset"},"id":{"type":"string"}},"required":["preset","id"],"type":"object"}]}},"securitySchemes":{"epi-single":{"type":"apiKey","name":"auth","in":"query","description":"Single key authentication"},"epi-hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"HMAC authentication (`epi-hmac xxx`)"},"Basic":{"type":"http","scheme":"basic","description":"HMAC credentials"},"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token"}}},"info":{"title":"Optimizely Graph API","version":"3.24.0","description":"Optimizely Graph API definition","license":{"name":" "},"contact":{"name":"Documentation","url":"https://cg.optimizely.com/"}},"paths":{"/api/bestbets/collection":{"get":{"operationId":"get-BestBetCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BestBetCollectionResult"},"type":"array"}}}}},"description":"Get all bestbet collections or get by Id","summary":"Get bestbet collection(s)","tags":["🏆 BestBets"],"deprecated":true,"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"query","name":"id","required":false,"schema":{"type":"string"}},{"in":"query","name":"page","required":false,"schema":{"format":"double","type":"number"}}]},"post":{"operationId":"create-BestBetCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BestBetCollectionResult"}}}}},"description":"Register a bestbet collection","summary":"Register a bestbet collection","tags":["🏆 BestBets"],"deprecated":true,"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BestBetCollectionPayload"}}}}}},"/api/bestbets/collection/{id}":{"put":{"operationId":"update-BestBetCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BestBetCollectionResult"}}}}},"description":"Update bestbet collection by Id","summary":"Update a bestbet collection","tags":["🏆 BestBets"],"deprecated":true,"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BestBetCollectionPayload"}}}}},"delete":{"operationId":"delete-BestBetCollectionHandler","responses":{"204":{"description":"No content"}},"description":"Delete bestbet by Id","summary":"Delete a bestbet collection","tags":["🏆 BestBets"],"deprecated":true,"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"string"}}]}},"/api/content/v2/data":{"post":{"operationId":"post-ContentV2DataHandler","responses":{"200":{"description":"Index content successful"}},"description":"Synchronize data for given source","summary":"Sync content data","tags":["📖 Definition ( v2 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"query","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"string"}}}}},"delete":{"operationId":"delete-ContentV2DataHandler","responses":{"204":{"description":"Reset data successfully"}},"description":"Purge data for given source","summary":"Purge content data","tags":["📖 Definition ( v2 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"The language of the source","in":"query","name":"languages","required":false,"schema":{"type":"array","items":{"type":"string"}}}]}},"/api/content/v3/sources":{"get":{"operationId":"get-ContentV3SourceHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceInfoMap"}}}}},"description":"Get `id`, `label`, `description` and `languages` fields of the source","summary":"Get source metadata","tags":["📖 Definition ( v3 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source _(optional)_\n- _(empty): all sources_\n- _**default**: only default source_\n- _**src1**:  only src1_","in":"query","name":"id","required":false,"schema":{"type":"string"}},{"description":"The slot of the source _(optional)_\n- _(empty): old slot_\n- _**new**: new slot_","in":"query","name":"slot","required":false,"schema":{"$ref":"#/components/schemas/Slot"}}]},"delete":{"operationId":"delete-ContentV3SourceHandler","responses":{"200":{"description":"Source is deleted successfully"},"404":{"description":"Source is not found"}},"description":"Delete content _types / data_ of the source","summary":"Delete source","tags":["📖 Definition ( v3 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source\n- _(empty): all sources_\n- _**default**: only default source_\n- _**src1**:  only src1_","in":"query","name":"id","required":false,"schema":{"type":"string"}},{"description":"Delete mode\n\n| mode         | description             | types       | data        |\n| --           | --                      | --          | --          |\n| _(empty)_    | _delete types and data_ | _(delete)_  | _(delete)_  |\n| _**types**_  | _delete only types_     | _(delete)_  |             |\n| _**data**_   | _delete only data_      |             | _(delete)_  |\n| _**reset**_  | _reset data_            | _(delete)_  | _(reset)_   |","in":"query","name":"mode","required":false,"schema":{"$ref":"#/components/schemas/DeleteMode"}},{"description":"The slot of the source _(optional)_\n- _(empty): old slot_\n- _**new**: new slot_","in":"query","name":"slot","required":false,"schema":{"$ref":"#/components/schemas/Slot"}}]},"post":{"operationId":"post-ContentV3SourceHandler","responses":{"204":{"description":"No content"}},"description":"Update `label`, `description` fields of the source","summary":"Update source metadata","tags":["📖 Definition ( v3 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source","in":"query","name":"id","required":true,"schema":{"type":"string"}},{"description":"The slot of the source _(optional)_\n- _(empty): old slot_\n- _**new**: new slot_","in":"query","name":"slot","required":false,"schema":{"$ref":"#/components/schemas/Slot"}}],"requestBody":{"description":"The new metadata source","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SourceMetadata","description":"The new metadata source"}}}}}},"/api/content/v2/types":{"post":{"operationId":"post-ContentV2TypeHandler","responses":{"200":{"description":"Successfully updated content type"},"400":{"description":"Content type languages could not be updated"}},"description":"Synchronize content types from one source","summary":"Sync content types","tags":["📖 Definition ( v2 )"],"deprecated":true,"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSource_V2"}}}}}},"/api/content/v3/types":{"get":{"operationId":"get-ContentV3TypeHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSource_V3"}}}}},"description":"Get content types of the source","summary":"Get content types","tags":["📖 Definition ( v3 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source","in":"query","name":"id","required":false,"schema":{"default":"default","type":"string"}}]},"post":{"operationId":"post-ContentV3TypeHandler","responses":{"204":{"description":"No content"}},"description":"Update content types of the source partially","summary":"Partial content type update","tags":["📖 Definition ( v3 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source","in":"query","name":"id","required":false,"schema":{"default":"default","type":"string"}}],"requestBody":{"description":"Content type definitions","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSource_V3","description":"Content type definitions"}}}}},"put":{"operationId":"put-ContentV3TypeHandler","responses":{"204":{"description":"No content"}},"description":"Update content types of the source (overwrite all)","summary":"Full content type update","tags":["📖 Definition ( v3 )"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"The id of the source","in":"query","name":"id","required":false,"schema":{"default":"default","type":"string"}}],"requestBody":{"description":"Content type definitions","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentSource_V3","description":"Content type definitions"}}}}}},"/api/events/fx":{"post":{"operationId":"post-FxEventHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}}},"security":[],"parameters":[]}},"/content/v2":{"get":{"operationId":"get-GraphQLV2Handler","responses":{"200":{"description":"Returns query result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GraphQLResponse"}}}}},"description":"Retrieve content respect to graphql query","summary":"Execute graphql query","tags":["▶️ Query ( GraphQL )"],"security":[{"epi-single":[]},{"epi-hmac":[]},{"epi-obo":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"query","name":"query","required":false,"schema":{"type":"string"}},{"in":"query","name":"mutation","required":false,"schema":{"type":"string"}},{"in":"query","name":"operationName","required":false,"schema":{"type":"string"}},{"in":"query","name":"variables","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"post-GraphQLV2Handler","responses":{"200":{"description":"Returns query result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GraphQLResponse"}}}}},"description":"Retrieve content respect to graphql query","summary":"Execute graphql query","tags":["▶️ Query ( GraphQL )"],"security":[{"epi-single":[]},{"epi-hmac":[]},{"epi-obo":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GraphQLRequest"}}}}}},"/api/config/oidc":{"put":{"operationId":"upsert-OidcConfigHandler","responses":{"204":{"description":"No content"}},"description":"Enable OIDC support for the current account","summary":"Upsert OIDC config","tags":["🔒 OIDC"],"security":[{"epi-hmac":[]},{"Basic":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenClaims"}}}}},"delete":{"operationId":"delete-OidcConfigHandler","responses":{"204":{"description":"No content"}},"description":"Delete OIDC config for the current account","summary":"Delete OIDC config","tags":["🔒 OIDC"],"security":[{"epi-hmac":[]},{"Basic":[]}],"parameters":[]}},"/api/pinned/collections":{"get":{"operationId":"list-PinnedCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PinnedCollectionResult"},"type":"array"}}}}},"description":"Get pinned collections","summary":"Get pinned collection(s)","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"query","name":"page","required":false,"schema":{"format":"double","type":"number"}}]},"post":{"operationId":"create-PinnedCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedCollectionResult"}}}}},"description":"Register a pinned collection","summary":"Register a pinned collection","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedCollectionPayload"}}}}}},"/api/pinned/collections/{collectionId}":{"get":{"operationId":"get-PinnedCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedCollectionResult"}}}}},"description":"Get collection by Id","summary":"Get pinned collection by Id","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"Pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}]},"put":{"operationId":"update-PinnedCollectionHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedCollectionResult"}}}}},"description":"Update pinned collection by Id","summary":"Update a pinned collection","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Partial_PinnedCollectionPayload_"}}}}},"delete":{"operationId":"delete-PinnedCollectionHandler","responses":{"204":{"description":"No content"}},"description":"Delete pinned collection by Id","summary":"Delete a pinned collection","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}]}},"/api/pinned/collections/{collectionId}/items":{"get":{"operationId":"list-PinnedItemHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PinnedItemResult"},"type":"array"}}}}},"description":"Get list of pinned items by given pinned collection id","summary":"Get list of pinned items by collection id","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}},{"description":"Limit items","in":"query","name":"limit","required":false,"schema":{"format":"double","type":"number"}},{"description":"From offset number","in":"query","name":"offset","required":false,"schema":{"format":"double","type":"number"}},{"description":"Phrase to be filtered","in":"query","name":"phrase","required":false,"schema":{"type":"string"}},{"description":"The sort field, default direction is ASC. Add a minus/dash symbol for DESC (example \"-phrase\"). Default value created_at DESC.","in":"query","name":"sort","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"create-PinnedItemHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedItemResult"}}}}},"description":"Create a new pinned item, collectionId must be created before creating pinned item","summary":"Create a new pinned item","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedItemPayload"}}}}},"delete":{"operationId":"clear-PinnedItemHandler","responses":{"204":{"description":"No content"}},"description":"Clear pinned items in collection","summary":"Clear pinned items in collection","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}]}},"/api/pinned/collections/{collectionId}/items/{id}":{"get":{"operationId":"get-PinnedItemHandler","responses":{"200":{"description":"PinnedItemResult","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedItemResult"}}}}},"description":"Get single pinned item by id","summary":"Get pinned item by id","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}},{"description":"pinned id (id)","in":"path","name":"id","required":true,"schema":{"type":"string"}}]},"put":{"operationId":"update-PinnedItemHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedItemResult"}}}}},"description":"Update a single pinned item","summary":"Update a pinned item","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}},{"description":"pinned id (id)","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedItemPayload"}}}}},"delete":{"operationId":"delete-PinnedItemHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedItemResult"}}}}},"description":"Remove single pinned item","summary":"Remove pinned item","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"description":"pinned collection id","in":"path","name":"collectionId","required":true,"schema":{"type":"string"}},{"description":"pinned id (id)","in":"path","name":"id","required":true,"schema":{"type":"string"}}]}},"/api/pinned/results":{"post":{"operationId":"match-PinnedItemHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PinnedItemResult"},"type":"array"}}}}},"description":"Get pinned results by matching phrases","summary":"Get pinned results","tags":["🏆 Pinned Results"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PinnedResultMatchParams"}}}}}},"/api/logs/request":{"get":{"operationId":"get-RequestLogHandler","responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RequestLog"},"type":"array"}}}}},"description":"Get _incoming/outgoing_ request logs","summary":"Get request logs","tags":["📜 Logs"],"security":[{"epi-hmac":[]},{"Bearer":[]},{"Basic":[]}],"parameters":[{"in":"query","name":"page","required":false,"schema":{"format":"double","type":"number"}},{"in":"query","name":"requestId","required":false,"schema":{"type":"string"}},{"in":"query","name":"host","required":false,"schema":{"type":"string"}},{"in":"query","name":"path","required":false,"schema":{"type":"string"}},{"in":"query","name":"success","required":false,"schema":{"type":"boolean"}}]}},"/resources/stopwords":{"put":{"operationId":"upsert-StopwordHandler","responses":{"204":{"description":"No content"}},"description":"Stop words are the words in a stop list (or stop list or negative dictionary) which are filtered out (stopped) before or after processing of natural language data (text) because they are insignificant","summary":"Store stop words","tags":["📝 Resources"],"security":[{"epi-hmac":[]},{"Basic":[]},{"Bearer":[]}],"parameters":[{"in":"query","name":"language_routing","required":false,"schema":{"type":"string"}},{"in":"query","name":"source_routing","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StopwordsBody"}}}}},"delete":{"operationId":"delete-StopwordHandler","responses":{"204":{"description":"No content"}},"summary":"Delete stop words","tags":["📝 Resources"],"security":[{"epi-hmac":[]},{"Basic":[]},{"Bearer":[]}],"parameters":[{"in":"query","name":"language_routing","requir

# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/_original/optimizely-platform-optimizely-swagger-openapi.json