Optimizely

Optimizely 🏆 Pinned Results API

The 🏆 Pinned Results API from Optimizely — 5 operation(s) for 🏆 pinned results.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/pinned/collections List pinned collections · Get pinned collection(s) #
Ask an LLM
“Which pinned result collections exist in my search index?”
“Can I page through all pinned collections?”
Tell an agent
List pinned collections.
Show page {page} of pinned collections.
POST /api/pinned/collections Create a pinned collection · Register a pinned collection #
Ask an LLM
“How do I set up a new collection for pinned search results?”
“Can I create a pinned collection that starts inactive?”
Tell an agent
Create pinned collection {title} with key {key}.
Register pinned collection {title}, key {key}, active {isActive}.
GET /api/pinned/collections/{collectionId} Get a pinned collection · Get pinned collection by Id #
Ask an LLM
“How do I look up one pinned collection by its id?”
“Is a particular pinned collection active?”
Tell an agent
Get pinned collection {collectionId}.
Show details of pinned collection {collectionId}.
PUT /api/pinned/collections/{collectionId} Update a pinned collection · Update a pinned collection #
Ask an LLM
“How do I rename a pinned collection or turn it off?”
“Can I change a pinned collection's key?”
Tell an agent
Rename pinned collection {collectionId} to {title}.
Set pinned collection {collectionId} active to {isActive}.
DELETE /api/pinned/collections/{collectionId} Delete a pinned collection · Delete a pinned collection #
Ask an LLM
“How do I delete an entire pinned collection?”
“Can I get rid of a pinned collection I no longer use?”
Tell an agent destructive · confirm first
Delete pinned collection {collectionId}.
Remove the whole pinned collection {collectionId}.
GET /api/pinned/collections/{collectionId}/items List pinned items in a collection · Get list of pinned items by collection id #
Ask an LLM
“Which items are pinned inside a given collection?”
“Can I filter pinned items in a collection by phrase and sort them?”
Tell an agent
List pinned items in collection {collectionId}.
List pinned items in collection {collectionId} matching phrase {phrase}.
POST /api/pinned/collections/{collectionId}/items Pin a document to search phrases · Create a new pinned item #
Ask an LLM
“How do I pin a specific document to the top of results for a search phrase?”
“Can I make a pinned result apply only to one language?”
Tell an agent
Pin document {targetKey} for phrases {phrases} in collection {collectionId}.
Pin document {targetKey} for {phrases} in collection {collectionId}, language {language}, priority {priority}.
DELETE /api/pinned/collections/{collectionId}/items Clear all pinned items in a collection · Clear pinned items in collection #
Ask an LLM
“How do I wipe every pinned item from a collection but keep the collection?”
“Can I empty a pinned collection in one call?”
Tell an agent destructive · confirm first
Clear all pinned items in collection {collectionId}.
Empty pinned collection {collectionId} of its items.
GET /api/pinned/collections/{collectionId}/items/{id} Get a pinned item · Get pinned item by id #
Ask an LLM
“How do I read the phrases and target document of one pinned item?”
“What priority does a specific pinned item have?”
Tell an agent
Get pinned item {id} in collection {collectionId}.
Show pinned item {id} from collection {collectionId}.
PUT /api/pinned/collections/{collectionId}/items/{id} Update a pinned item · Update a pinned item #
Ask an LLM
“How do I change which document a pinned item points to?”
“Can I change the phrases or priority on an existing pinned item?”
Tell an agent
Update pinned item {id} in collection {collectionId} to pin {targetKey} for {phrases}.
Set priority {priority} on pinned item {id} in collection {collectionId}, phrases {phrases}, target {targetKey}.
DELETE /api/pinned/collections/{collectionId}/items/{id} Remove a pinned item · Remove pinned item #
Ask an LLM
“How do I unpin a single document from a collection?”
“Can I remove one pinned item without clearing the rest?”
Tell an agent destructive · confirm first
Remove pinned item {id} from collection {collectionId}.
Unpin item {id} in collection {collectionId}.
POST /api/pinned/results Find pinned results for a phrase · Get pinned results #
Ask an LLM
“Which documents are pinned for a given search phrase?”
“Can I check pinned matches for a phrase across specific collections and languages?”
Tell an agent
Get pinned results for phrase {phrase}.
Find active pinned results for {phrase} in collections {collectionKeys}, languages {languages}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-pinned-results-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-pinned-results-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-pinned-results-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Optimizely Graph 🏆 Pinned Results API
  version: 3.24.0
  description: Optimizely Graph API definition
  license:
    name: ' '
  contact:
    name: Documentation
    url: https://cg.optimizely.com/
servers:
- url: https://prod.cg.optimizely.com
tags:
- name: 🏆 Pinned Results
paths:
  /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'
      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
      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'
components:
  schemas:
    PinnedCollectionPayload:
      properties:
        title:
          type: string
        key:
          type: string
        isActive:
          type: boolean
          default: false
      required:
      - title
      - key
      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
            - 'null'
          type:
          - array
          - 'null'
        onlyActive:
          type: boolean
        limit:
          type: number
          format: double
      required:
      - phrase
      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
          - 'null'
          description: 'Language code (e.g. `en`, `fr`, `de`, etc.)


            - `null` value means the pinned item is applicable to all languages


            - 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)


            - Default value is `1000`


            - 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
    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
    PinnedItemPayload:
      properties:
        phrases:
          type: string
          description: Phrase or keyword to match
        targetKey:
          type: string
          description: Document id to pin
        language:
          type:
          - string
          - 'null'
          description: 'Language code (e.g. `en`, `fr`, `de`, etc.)


            - `null` value means the pinned item is applicable to all languages


            - 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)


            - Default value is `1000`


            - Example: `1`, `10`, `100`, etc.'
          default: 1000
        isActive:
          type: boolean
          default: true
      required:
      - phrases
      - targetKey
      type: object
      additionalProperties: false
  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